ExFTP.Auth.PassthroughAuth (ExFTP v1.0.4)

View Source

When authenticator is ExFTP.Auth.PassthroughAuth, this authenticator will require credentials, but accepts any user and password combination who isn't root.

🔒 Security

Don't use PassthroughAuth for production servers.

⚙️ Configuration

Keys

Example

  %{
    # ... ,
    authenticator: ExFTP.Auth.PassthroughAuth,
    authenticator_config: %{}
  }

👀 See Also

📖 Resources

Summary

Functions

authenticated?(authenticator_state)

Assumes the user is still authenticated as long as authenticated: true still exists in the authenticator_state.

login(password, authenticator_state)

Login will respond {:ok, unmodified_auth_state} to anyone but username: "root"

valid_user?(username)

Returns true if username is anything except "root"

Functions

authenticated?(authenticator_state)

@spec authenticated?(authenticator_state :: ExFTP.Authenticator.authenticator_state()) ::
  boolean()

Assumes the user is still authenticated as long as authenticated: true still exists in the authenticator_state.

🏷️ Params

⤵️ Returns

✅ On Success

  `true` or `false`

💻 Examples

iex> alias ExFTP.Auth.PassthroughAuth
iex> PassthroughAuth.authenticated?(%{authenticated: true})
true
iex> PassthroughAuth.authenticated?(%{})
false

login(password, authenticator_state)

@spec login(
  password :: ExFTP.Authenticator.password(),
  authenticator_state :: ExFTP.Authenticator.authenticator_state()
) :: {:ok, ExFTP.Authenticator.authenticator_state()} | {:error, term()}

Login will respond {:ok, unmodified_auth_state} to anyone but username: "root"

🏷️ Params

⤵️ Returns

✅ On Success

  {:ok, authenticator_state}

❌ On Failure

  {:error, bad_login}

💻 Examples

iex> alias ExFTP.Auth.PassthroughAuth
iex> {:ok, _auth_state} = PassthroughAuth.login("password", %{username: "jsmith"})
iex> {:error, _} = PassthroughAuth.login("password", %{})
iex> # "root" is a disallowed user in PassthroughAuth
iex> {:error, _} = PassthroughAuth.login("password", %{username: "root"})

valid_user?(username)

@spec valid_user?(username :: ExFTP.Authenticator.username()) :: boolean()

Returns true if username is anything except "root"

🏷️ Params

⤵️ Returns

✅ On Success

  `true` or `false`

💻 Examples

iex> alias ExFTP.Auth.PassthroughAuth
iex> PassthroughAuth.valid_user?("jsmith")
true
iex> PassthroughAuth.valid_user?("root")
false

⚠️ Reminders

🔒 Security

The client will never be informed that a username is invalid.

The server uses this method to short-circuit bad auth calls.