Back to product page

LoginPubkey method


Called when user wants to authenticate to the server with public key.

Type

None

Syntax

  • Basic
object.LoginPubkey Owner, User, Login, PublicKey, Action  
The LoginPubkey(object,Owner,User,Login,PublicKey,Action) syntax has these parts:
objectAn expression evaluating to an object of type IwodSSHDNotify.
OwnerA wodSSHDcom object. Instance of wodSSHServer that called this notification method.
UserA SSHUser object. Reference to user who send his login information.
LoginA String value. Holds login info entered by the user.
PublicKeyA String value. Holds public key information provided by the user.
ActionA SSHActions enumeration, as described in settings. Return variable you should set to Allow or Deny, depending if you will allow or deny access for the user.

Remarks

The settings for Action are:

Constant Value Description
Deny0 Deny execution of the action.
Allow 1 Allow to execute action.


This method is called only if you implemented IwodSSHNotify interface in your application, and wodSSHD.Notification property has received reference to instance of your implementation.

LoginPubkey notification method is called when the client connects and tries to authenticate with the server. Since wodSSHServer does not have or keep any kind of database about users, you should test login and publickey to determine if you will allow client to connect or not. Typically, you will check this information against some database or file, and set Action variable to Allow - if access is allowed, or Deny - if access is NOT allowed. Make sure you also read about LoginPassword notification method that is called when user provides password instead of public key.

When client provides public key, wodSSHServer will check if signature that client provided matches his public key (which he provided in this connection). This may be security leak - he provides public key, he provides signature. Well - at this point LoginPubkey notification method is called so you can check if his public key matches one you have in your database (or some locally stored file). If public key is known - let user in.

Platforms

Windows