Namespace LrPasswords
This namespace provides a mechanism to store passwords in a secure fashion, using services provided by each operating system. The password API allows a plug-in author to associate an encrypted string with a key string. Lightroom scopes the key strings by plug-in ID so that a plug-in cannot access the passwords stored by another plug-in.
Access the functions directly from the imported namespace.
Summary
LrPasswords.retrieve( keystring, salt, pluginId )
Retrieves a plain-text password from the encrypted password storage.
LrPasswords.store( keystring, myPassword, salt, pluginId )
Stores an encrypted password.
Functions
- LrPasswords.retrieve( keystring, salt, pluginId )
-
Retrieves a plain-text password from the encrypted password storage.
First supported in version 3.0 of the Lightroom SDK.
Parameters
- 1. keystring
- (string) A key string associated with an encrypted string.
- 2. salt
- (string) A salt used as one of the inputs to an encrypted password derivation, or nil. If nil, the default salt is the value of the plug-in ID.
- 3. pluginId
- (string) The toolkit ID of the plug-in, or nil for the currently running plug-in.
Return value
(string) The plain-text password corresponding to the key. - LrPasswords.store( keystring, myPassword, salt, pluginId )
-
Stores an encrypted password.
First supported in version 3.0 of the Lightroom SDK.
Parameters
- 1. keystring
- (string) A key string associated with an encrypted password.
- 2. myPassword
- (string) The plain-text password to be encrypted.
- 3. salt
- (string) A salt used as one of the inputs to an encrypted password derivation, or nil. If nil, the default salt is the value of the plug-in ID.
- 4. pluginId
- (string) The toolkit ID of the plug-in, or nil for the currently running plug-in.
