diff options
Diffstat (limited to 'src/main/kotlin/Authenticator.kt')
| -rw-r--r-- | src/main/kotlin/Authenticator.kt | 18 |
1 files changed, 0 insertions, 18 deletions
diff --git a/src/main/kotlin/Authenticator.kt b/src/main/kotlin/Authenticator.kt deleted file mode 100644 index 932004f..0000000 --- a/src/main/kotlin/Authenticator.kt +++ /dev/null @@ -1,18 +0,0 @@ -/** - * The Authenticator interface provides methods for authenticating a user over an established protocol connection. - */ -interface Authenticator { - /** - * Authenticate a user identified by the given [username] and whose authenticity is confirmed by the given - * [password]. The authentication protocol can read and write data within the underlying connection using [readFun] - * and [writeFun]. - * - * @param username The name the user goes by. - * @param password The confirmation of the user's authenticity. - * @param readFun A function to read incoming data from the underlying connection. - * @param writeFun A function to write outgoing data into the underlying connection. - * @throws except.FailedAuthenticationException if the authentication could not be performed. A human-readable - * reason for the failure can be provided if necessary. - */ - fun authenticate(username: String, password: String, readFun: () -> List<UByte>, writeFun: (b: List<UByte>) -> Unit) -}
\ No newline at end of file |