Agent SDK
|
KeyVault service object for Mac, which uses an encrypted file using the Mac key chain to store keys. More...
Public Member Functions | |
def | GetServiceName (self) |
Getter for the Apple key chain Service Name. More... | |
def | GetAccountName (self) |
Getter for the Apple key chain Account Name. More... | |
def | GetFilePath (self) |
Getter for the filename and path used to stored the keys. More... | |
def | SetServiceName (self, serviceName) |
Setter for the Apple key chain Service Name. More... | |
def | SetAccountName (self, accountName) |
Setter for the Apple key chain Account Name. More... | |
def | SetFilePath (self, filePath) |
Setter for the filename and path used to stored the keys. More... | |
![]() | |
def | SetKey (self, keyVaultKeyRecord, addIfNotFound) |
Add or update a key into the key vault. More... | |
def | GetKey (self, keyid) |
Get a single key from the key vault. More... | |
def | GetKeys (self, keyids) |
Get multiple keys from the key vault. More... | |
def | GetAllKeyIds (self) |
Get the list of all key IDs in the key vault. More... | |
def | GetAllKeys (self) |
Get the list of all key objects in the key vault. More... | |
def | GetKeyCount (self) |
Get the number of keys in the key vault. More... | |
def | HasKey (self, keyid) |
Determine if a key exists in the key vault. More... | |
def | RemoveKey (self, keyid) |
Remove a single key from the key vault. More... | |
def | RemoveKeys (self, keyids) |
Remove one or more keys from the key vault. More... | |
def | ClearAllKeys (self) |
Remove all keys from the key vault. More... | |
def | ExpireKeys (self) |
Remove all keys which have expired. More... | |
def | Sync (self) |
Perform synchronization to permanent storage. More... | |
def | HasChanges (self) |
Determine if there are any changes to the key vault in memory that necessitate a sync(). More... | |
def | CleanVaultStore (self) |
Deletes any long term storage used by the particular key vault. More... | |
Static Public Member Functions | |
def | GetDefaultServiceName () |
Getter for the default Apple key chain Service Name. More... | |
def | GetDefaultAccountName () |
Getter for the default Apple key chain Account Name. More... | |
def | GetDefaultFilePath () |
Getter for the default filename and path used to stored the keys. More... | |
Additional Inherited Members | |
![]() | |
int | ISKEYVAULT_OK = 0 |
Key Vault Error Codes - Success code. | |
int | ISKEYVAULT_ERROR_BASE = 16000 |
Key Vault Error Codes - error code range base. | |
int | ISKEYVAULT_ERROR = 16001 |
Key Vault Error Codes - A general error occurred, but its specific problem is not represented with its own code. More... | |
int | ISKEYVAULT_UNKNOWN = 16002 |
Key Vault Error Codes - An unknown and unexpected error occurred. More... | |
int | ISKEYVAULT_NOMEMORY = 16003 |
Key Vault Error Codes - A memory allocation failed. More... | |
int | ISKEYVAULT_MISSINGVALUE = 16004 |
Key Vault Error Codes - An expected and required value was not found. More... | |
int | ISKEYVAULT_INVALIDVALUE = 16005 |
Key Vault Error Codes - A value was found that is invalid. More... | |
int | ISKEYVAULT_KEY_NOT_FOUND = 16006 |
Key Vault Error Codes - A key was not found. More... | |
int | ISKEYVAULT_KEY_UPDATE_IGNORED = 16007 |
Key Vault Error Codes - A key update request was ignored. More... | |
int | ISKEYVAULT_OPENFILE = 16008 |
Key Vault Error Codes - A file failed to open. More... | |
int | ISKEYVAULT_EOF = 16009 |
Key Vault Error Codes - The end of a file was found before it was expected. More... | |
int | ISKEYVAULT_NOHEADER = 16010 |
Key Vault Error Codes - A file header could not be found where it was expected. More... | |
int | ISKEYVAULT_PARSEFAILED = 16011 |
Key Vault Error Codes - The parsing of some serialized data failed. More... | |
int | ISKEYVAULT_HEADER_MISMATCH = 16012 |
Key Vault Error Codes - A key vault file header has values which were not expected. More... | |
int | ISKEYVAULT_LOAD_NOT_NEEDED = 16013 |
Key Vault Error Codes - A key vault load operation was skipped because it was not needed. More... | |
int | ISKEYVAULT_CREATE_PATH = 16014 |
Key Vault Error Codes - A key vault save operation could not create the required file path. More... | |
int | ISKEYVAULT_INVALID_KEY = 16015 |
Key Vault Error Codes - A key is invalid in some way (key ID, key bytes, etc). More... | |
int | ISKEYVAULT_RESOURCE_NOT_FOUND = 16016 |
Key Vault Error Codes - A resource was not found. More... | |
int | ISKEYVAULT_FILE_VERSION = 16017 |
Key Vault Error Codes - A key vault file load operation failed due to unsupported file version. More... | |
KeyVault service object for Mac, which uses an encrypted file using the Mac key chain to store keys.
ServiceName - The keychain service name to use for storing the key vault protection key. Defaults to "com.ionicsecurity.client.sdk.keyvault.applekeychain"
AccountName - The keychain account name to use for storing the key vault protection key. Defaults to "Ionic Security"
FilePath - The file path and file name of the file to use to store the encrypted keys.
Constructor takes a file name (with path). Key vault is stored encrypted in this file. You may use None for this argument, in which case, the key vault uses a default name, which is "<UserHome>/Library/Application Support/IonicSecurity/KeyVaults/KeyVaultMac.dat"
def ionicsdk.keyvault.KeyVaultMac.GetAccountName | ( | self | ) |
Getter for the Apple key chain Account Name.
|
static |
Getter for the default Apple key chain Account Name.
|
static |
Getter for the default filename and path used to stored the keys.
|
static |
Getter for the default Apple key chain Service Name.
def ionicsdk.keyvault.KeyVaultMac.GetFilePath | ( | self | ) |
Getter for the filename and path used to stored the keys.
def ionicsdk.keyvault.KeyVaultMac.GetServiceName | ( | self | ) |
Getter for the Apple key chain Service Name.
def ionicsdk.keyvault.KeyVaultMac.SetAccountName | ( | self, | |
accountName | |||
) |
Setter for the Apple key chain Account Name.
def ionicsdk.keyvault.KeyVaultMac.SetFilePath | ( | self, | |
filePath | |||
) |
Setter for the filename and path used to stored the keys.
def ionicsdk.keyvault.KeyVaultMac.SetServiceName | ( | self, | |
serviceName | |||
) |
Setter for the Apple key chain Service Name.
You acknowledge your access, review and use of the documentation on this page is subject to the Ionic Security Inc. Documentation Use Rights.
© 2016-2018 Ionic Security Inc. All rights reserved.
Generated on Mon Jun 24 2019 10:20:16 for Agent SDK by
1.8.12