pip_services3_components.auth.MemoryCredentialStore module
pip_services3_components.auth.MemoryCredentialStore
Memory credential store implementation
- copyright
Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.
- license
MIT, see LICENSE for more details.
-
class
pip_services3_components.auth.MemoryCredentialStore.
MemoryCredentialStore
(config: pip_services3_commons.config.ConfigParams.ConfigParams = None) Bases:
pip_services3_components.auth.ICredentialStore.ICredentialStore
,pip_services3_commons.config.IReconfigurable.IReconfigurable
Credential store that keeps credentials in memory.
- ### Configuration parameters ###
[credential key 1]:
… credential parameters for key 1
[credential key 2]:
… credential parameters for key N
…
Example:
config = ConfigParams.from_tuples("key1.user", "jdoe", "key1.pass", "pass123", "key2.user", "bsmith", "key2.pass", "mypass") credentialStore = MemoryCredentialStore() credentialStore.read_credentials(config) credentialStore.lookup("123", "key1")
-
configure
(config: pip_services3_commons.config.ConfigParams.ConfigParams) Configures component by passing configuration parameters.
- Parameters
config – configuration parameters to be set.
-
lookup
(correlation_id: Optional[str], key: str) → pip_services3_components.auth.CredentialParams.CredentialParams Lookups credential parameters by its key.
- Parameters
correlation_id – (optional) transaction id to trace execution through call chain.
key – a key to uniquely identify the credential.
- Returns
found credential parameters or None if nothing was found
-
read_credentials
(config: pip_services3_commons.config.ConfigParams.ConfigParams) Reads credentials from configuration parameters. Each section represents an individual CredentialParams
- Parameters
config – configuration parameters to be read
-
store
(correlation_id: Optional[str], key: str, credential: pip_services3_components.auth.CredentialParams.CredentialParams) Stores credential parameters into the store.
- Parameters
correlation_id – (optional) transaction id to trace execution through call chain.
key – a key to uniquely identify the credential parameters.
credential – a credential parameters to be stored.