feat: connect event + shortcuts for UserAuthRequest fields

Author: Manaf941

src/ServerClient.ts

@@ -129,6 +129,7 @@ export default class ServerClient extends (EventEmitter as new () => TypedEventE
     hasReceivedNewKeys: boolean = false
     hasSentNewKeys: boolean = false
     hasAuthenticated: boolean = false
+    credentials: UserAuthRequest | undefined
 
     localChannelIndex = 0
     channels = new Map<number, Channel>()
@@ -368,6 +369,7 @@ export default class ServerClient extends (EventEmitter as new () => TypedEventE
 
     async handleAuthentication() {
         let allowLogin = false
+        let authRequest: Packet
         authentication: {
             const userAuthFailure = new UserAuthFailure({
                 auth_methods: [
@@ -382,7 +384,7 @@ export default class ServerClient extends (EventEmitter as new () => TypedEventE
                 // and the server should be able to handle them. This current implementation
                 // does not respect that and waits sequencially.
                 this.debug("Waiting for authentication request...")
-                const [authRequest] = (await this.waitEvent("packet")) as [Packet]
+                ;[authRequest] = (await this.waitEvent("packet")) as [Packet]
                 assert(authRequest instanceof UserAuthRequest, "Invalid packet type")
 
                 this.debug(`Received authentication request:`, authRequest)
@@ -496,6 +498,11 @@ export default class ServerClient extends (EventEmitter as new () => TypedEventE
             }
         }
 
+        // redo the assert for type checking, otherwise it should
+        // never throw.
+        assert(authRequest instanceof UserAuthRequest, "Invalid packet type")
+        this.credentials = authRequest
+
         if (allowLogin) {
             this.sendPacket(new UserAuthSuccess({}))
             this.hasAuthenticated = true

src/auth/none.ts

@@ -9,6 +9,9 @@ import UserAuthFailure from "../packets/UserAuthFailure.js"
 export interface NoneAuthMethodData {}
 export default class NoneAuthMethod implements AuthMethod {
     static method_name = SSHAuthenticationMethods.None
+    get method_name() {
+        return NoneAuthMethod.method_name
+    }
 
     data: NoneAuthMethodData
     constructor(data: NoneAuthMethodData) {

src/auth/password.ts

@@ -13,6 +13,9 @@ export interface PasswordAuthMethodData {
 }
 export default class PasswordAuthMethod implements AuthMethod {
     static method_name = SSHAuthenticationMethods.Password
+    get method_name() {
+        return PasswordAuthMethod.method_name
+    }
 
     data: PasswordAuthMethodData
     constructor(data: PasswordAuthMethodData) {

src/auth/publickey.ts

@@ -17,6 +17,9 @@ export interface PublicKeyAuthMethodData {
 }
 export default class PublicKeyAuthMethod implements AuthMethod {
     static method_name = SSHAuthenticationMethods.PublicKey
+    get method_name() {
+        return PublicKeyAuthMethod.method_name
+    }
 
     data: PublicKeyAuthMethodData
     constructor(data: PublicKeyAuthMethodData) {

src/index_server.ts

@@ -20,6 +20,12 @@ server.listen(3022, () => {
 
 server.on("connection", (client) => {
     client.on("error", console.error)
+
+    client.on("connect", () => {
+        console.log(
+            `User ${client.credentials!.username} logged in with ${client.credentials!.method_name}`,
+        )
+    })
 })
 
 const allowedUser = "manaf"

src/packets/UserAuthRequest.ts

@@ -31,6 +31,23 @@ export default class UserAuthRequest implements Packet {
         this.data = data
     }
 
+    get username() {
+        return this.data.username
+    }
+    get publicKey() {
+        return this.data.method instanceof PublicKeyAuthMethod
+            ? this.data.method.data.publicKey
+            : undefined
+    }
+    get password() {
+        return this.data.method instanceof PasswordAuthMethod
+            ? this.data.method.data.password
+            : undefined
+    }
+    get method_name() {
+        return this.data.method.method_name
+    }
+
     serialize(): Buffer {
         const buffers = []
 
@@ -88,6 +105,7 @@ export default class UserAuthRequest implements Packet {
 
 export abstract class AuthMethod {
     static method_name: SSHAuthenticationMethods
+    method_name: SSHAuthenticationMethods
 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     constructor(data: any) {