Profile
SAIL-Profile.Rd
User profile secret manager for SAIL DB authentication
Details
Profile secret manager for SAIL DB authentication; exported to allow for use in your personal projects and/or to better manage your own secrets
Public fields
keychain
(
character|NA
)
A private reference to the keychain nameconnected
(
character|NA
)
A read-only field describing the name of the keychain
Active bindings
keychain
(
character|NA
)
A private reference to the keychain nameconnected
(
character|NA
)
A read-only field describing the name of the keychainsystem.user
(
character|NA
)
A read-only helper field to derive the client's system username
Methods
Method new()
Initialise a user profile instance
Usage
Profile$new(keychain.name = NA)
Method has.secrets()
Method to check whether a secret exists for the given username and database
Method get.secrets()
Method to collect the secrets associated with the given username and database
Method is.secret()
Compare a known secret to the value stored in the keychain
Arguments
username
(
character|NA
)
Optional username that relates to these secretspassword
(
character|NA
)
The secret you would like to compare to any stored in the keychaindatabase
(
character|NA
)
The name of the database that these secrets relate to; defaults toSAILDB.DEF$DATABASE
if no name is given
Method set.secrets()
Method to set the secrets for the given username and database
Method remove.secrets()
Method to remove secrets associated with either (a) a username and a database; or (b) all secrets associated with a database
Arguments
username
(
character|NA
)
An optional username that relates to these secrets; if none are provided all of the secrets associated with the database will be removeddatabase
(
character|NA
)
The name of the database that these secrets relate to; defaults toSAILDB.DEF$DATABASE
if no name is given