One-time password

KDone supports OTP (One-time password).

Configure one or more senders

An OTP system needs a system capable to send access codes to users. To create one, simply create a class that implements UserSender interface. This interface requires just a method that takes as argument the user and the OTP code. In its implementation should be added the sending logic.

class SMSSender(val smsProviderKey: String): UserSender<User> {
    override suspend fun send(user: User, message: String) {
        SMSProvider.send(message, user.number, smsProviderKey)
    }
}

Add OTP to KDone configuration

With at least a sender it’s possible to activate OTP simply doing

val senderSMS = SMSSender("SMSSenderKey")
val senderEmail = EmailSender()

otp(senderSMS, senderEmail)

Endpoint

After this configuration, OTP endpoints will be opened.

• users/otp/access, POST which takes as input user’s parameters (JSON or Multipart Form Data). This endpoint will create the user if not already exists and send the OTP access code through the senders specified in OTP configuration.
• users/otp/access/registered, POST which sends the OTP through senders and requires a JSON body with username value. If username does not exist returns an error.
• users/otp/login, POST which lets users login using the username and OTP code. They should be sent in a JSON inside request’s body.

  {
    "username":"info@email.com",
    "password":"ykbVjS"
  }
  

Code generation

OTP configuration accept a function in order to generate a OTP code.

otp(otpSender,
      codeGenerator = { randomString(6) }
)

If a codeGenerator function is not specified, KDone will generate 5 characters random string as OTP code.

E-mail sender

KDone has a build-in Email sender to send OTP codes through e-mail. It takes as arguments a SMTP Client, sender info of the sent e-mail, the object of the message and closure to compose and send the e-mail content using generated OTP code.

val otpSender = EmailSender<User>(smtpClient, "Info" to "info@company.com", "One Time Password") {
                    code ->
                """
                    Your requested access code is
                    $code
                """.trimIndent()
            }

otp(otpSender)