Client SDK Version 2.0.0
Ionic Security client SDK for Python users
|
Public Member Functions | |
def | __init__ (self, protectionKeybytes, protectionAuthbytes) |
Constructs the an Apple style key vault from passed in arguments. More... | |
def | GetProtectionKey (self) |
Getter for the AES GCM key to use for protecting the kay vault data. More... | |
def | GetProtectionAuthData (self) |
Getter for the AES GCM Additional Authenticated Data (AAD) to use for protecting the kay vault data. More... | |
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 | GetAccessGroup (self) |
Getter for the Apple key chain access group (iOS only) Can be None. More... | |
def | SetProtectionKey (self, keybytes) |
Setter for the AES GCM key to use for protecting the key vault data. More... | |
def | SetProtectionAuthData (self, authbytes) |
Setter for the AES GCM Additional Authenticated Data (AAD) to use for protecting the key vault data. 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 | SetAccessGroup (self, accessGroup) |
Setter for the Apple key chain access group (iOS only). More... | |
![]() | |
def | __init__ (self) |
Constructs a default key vault. | |
def | SetKey (self, keyVaultKeyRecord, addIfNotFound) |
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) |
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... | |
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. | |
int | ISKEYVAULT_UNKNOWN = 16002 |
Key Vault Error Codes - An unknown and unexpected error occurred. | |
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... | |
Constructor takes protection key and protection auth data as parms. You may pass None to these and set them with the setters later. However, the vault is not functional without at least these two parms. Everything else will work with defaults.
def ionicsdk.keyvault.KeyVaultAppleKeyChain.__init__ | ( | self, | |
protectionKeybytes, | |||
protectionAuthbytes | |||
) |
Constructs the an Apple style key vault from passed in arguments.
protectionKeybytes | (bytes) The AES GCM key to use for protecting the key vault data. |
protectionAuthbytes | (bytes) The AES GCM auth data to use when protecting the key vault data. |
def ionicsdk.keyvault.KeyVaultAppleKeyChain.GetAccessGroup | ( | self | ) |
Getter for the Apple key chain access group (iOS only) Can be None.
def ionicsdk.keyvault.KeyVaultAppleKeyChain.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 Apple key chain Service Name.
def ionicsdk.keyvault.KeyVaultAppleKeyChain.GetProtectionAuthData | ( | self | ) |
Getter for the AES GCM Additional Authenticated Data (AAD) to use for protecting the kay vault data.
def ionicsdk.keyvault.KeyVaultAppleKeyChain.GetProtectionKey | ( | self | ) |
Getter for the AES GCM key to use for protecting the kay vault data.
def ionicsdk.keyvault.KeyVaultAppleKeyChain.GetServiceName | ( | self | ) |
Getter for the Apple key chain Service Name.
def ionicsdk.keyvault.KeyVaultAppleKeyChain.SetAccessGroup | ( | self, | |
accessGroup | |||
) |
Setter for the Apple key chain access group (iOS only).
Defaults to None.
accessGroup | (string) The Apple key chain access group (iOS only) |
def ionicsdk.keyvault.KeyVaultAppleKeyChain.SetAccountName | ( | self, | |
accountName | |||
) |
Setter for the Apple key chain Account Name.
Defaults to "Ionic Security"
accountName | (string) The Apple key chain Account Name |
def ionicsdk.keyvault.KeyVaultAppleKeyChain.SetProtectionAuthData | ( | self, | |
authbytes | |||
) |
Setter for the AES GCM Additional Authenticated Data (AAD) to use for protecting the key vault data.
authbytes | (bytearray) The AES GCM AAD to use for protecting the key vault data |
def ionicsdk.keyvault.KeyVaultAppleKeyChain.SetProtectionKey | ( | self, | |
keybytes | |||
) |
Setter for the AES GCM key to use for protecting the key vault data.
keybytes | (bytearray) The AES GCM key to use for protecting the key vault data |
def ionicsdk.keyvault.KeyVaultAppleKeyChain.SetServiceName | ( | self, | |
serviceName | |||
) |
Setter for the Apple key chain Service Name.
Defaults to "com.ionicsecurity.client.sdk.keyvault.applekeychain"
serviceName | (string) 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-2020 Ionic Security Inc. All rights reserved. -
Generated on Thu Jul 2 2020 12:40:01 for Client SDK Version 2.0.0 by
1.8.18