Properties [?]

• messageIsError :  bool

  readonly

  If the last message should be shown as an error.

• responseVisible :  bool

  readonly

  If the user’s response should be visible. Only valid when responseRequired is true.

• active :  bool

  If the pam context is actively performing an authentication.

  Setting this value behaves exactly the same as calling start() and abort().

• message :  string

  readonly

  The last message sent by pam.

• config :  string

  The pam configuration to use. Defaults to “login”.

  The configuration should name a file inside configDirectory.

  This property may not be set while active is true.

• configDirectory :  string

  The pam configuration directory to use. Defaults to “/etc/pam.d”.

  The configuration directory is resolved relative to the current file if not an absolute path.

  On FreeBSD this property is ignored as the pam configuration directory cannot be changed.

  This property may not be set while active is true.

• responseRequired :  bool

  readonly

  If pam currently wants a response.

  Responses can be returned with the respond() function.

• user :  string

  The user to authenticate as. If unset the current user will be used.

  This property may not be set while active is true.

Functions [?]

• abort() :  void

  Abort a running authentication session.

• respond(response) :  void

  response: string

  Respond to pam.

  May not be called unless responseRequired is true.

• start() :  bool

  Start an authentication session. Returns if the session was started successfully.

Signals [?]

• pamMessage()  

  Emitted whenever pam sends a new message, after the change signals for message, messageIsError, and responseRequired.

• error(error)  

  error: PamError

  Emitted if pam fails to perform authentication normally.

  A completed(PamResult.Error) will be emitted after this event.

• completed(result)  

  result: PamResult

  Emitted whenever authentication completes.