| def virtru_tdf3_python.Client.__init__ |
( |
|
owner, |
|
|
|
organizationName, |
|
|
|
clientId, |
|
|
|
clientSecret |
|
) |
| |
| def virtru_tdf3_python.Client.__init__ |
( |
|
owner, |
|
|
|
appId |
|
) |
| |
| def virtru_tdf3_python.Client.__init__ |
( |
|
owner, |
|
|
|
apiKey, |
|
|
|
secret |
|
) |
| |
| def virtru_tdf3_python.Client.__init__ |
( |
|
const, |
|
|
|
CredentialsOidc, |
|
|
|
credentials |
|
) |
| |
| def virtru_tdf3_python.Client.__init__ |
( |
|
const, |
|
|
|
CredentialsAppId, |
|
|
|
credentials |
|
) |
| |
| def virtru_tdf3_python.Client.__init__ |
( |
|
const, |
|
|
|
CredentialsHmac, |
|
|
|
credentials |
|
) |
| |
| def virtru_tdf3_python.Client.decrypt_file |
( |
|
in_file_path, |
|
|
|
out_file_path |
|
) |
| |
Decrypt file
Args:
in_file_path(string): The file on which the decryption is performed
out_file_path(string): The file path of the TDF after successful decryption
| def virtru_tdf3_python.Client.decrypt_rca_to_file |
( |
|
rca_link_url, |
|
|
|
out_file_path |
|
) |
| |
Decrypt file
Args:
rca_link_url(string): The url to the remote tdf
out_file_path(string): The file path of the TDF after successful decryption
| def virtru_tdf3_python.Client.decrypt_rca_to_string |
( |
|
rca_link_url | ) |
|
Decrypt tdf data
Args:
rca_link_url(string): The url to the remote tdf
Returns:
The plain data.
| def virtru_tdf3_python.Client.decrypt_string |
( |
|
tdf_data | ) |
|
Decrypt tdf data
Args:
tdf_data(string): The tdf data to be decrypted
Returns:
The plain data.
| def virtru_tdf3_python.Client.enable_console_logging |
( |
|
log_level | ) |
|
Enable the logger to write logs to the console
Note: The default is LogLevel::Warn
Args:
log_level(LogLevel): The log level
| def virtru_tdf3_python.Client.encrypt_file |
( |
|
encrypt_file_params | ) |
|
Encrypt the file
Args:
encrypt_file_param(EncryptFileParams) - Object holding all the information for encrypt
Returns:
Policy uuid of the TDF
| def virtru_tdf3_python.Client.encrypt_file_to_rca |
( |
|
encrypt_file_params | ) |
|
Encrypt the file and store it remote
Args:
encrypt_file_param(EncryptFileParams) - Object holding all the information for encrypt
Returns:
Tuple of policy uuid and the RCA link
| def virtru_tdf3_python.Client.encrypt_string |
( |
|
const, |
|
|
|
EncryptStringParams, |
|
|
|
params, |
|
|
|
auto, |
|
|
|
returnVal = client.encryptString(params); return py::make_tuple(returnVal.first, py::bytes(returnVal.second), |
|
|
|
encrypt_string_params |
|
) |
| |
Encrypt the string
Args:
encrypt_string_params(EncryptStringParams) - Object holding all the information for encrypt
Returns:
Tuple of policy uuid and the tdf data
| def virtru_tdf3_python.Client.encrypt_string_to_rca |
( |
|
encrypt_string_params | ) |
|
Encrypt the string and store it remote
Args:
encrypt_string_params(EncryptStringParams) - Object holding all the information for encrypt
Returns:
Tuple of policy uuid and the RCA link
| def virtru_tdf3_python.Client.fetch_policy_for_uuid |
( |
|
policy_uuid | ) |
|
Return the policy associated with the given policy uuid.
Args:
policy_uuid(string): The policy uuid of the TDF
Returns:
The Policy object associated with the TDF.
| def virtru_tdf3_python.Client.revoke_file |
( |
|
tdf_file | ) |
|
Revoke access for all the users (except owner) for the TDF file
Args:
tdf_file(string) - The TDF file
| def virtru_tdf3_python.Client.revoke_files |
( |
|
tdf_files_list | ) |
|
Revoke access for all the users (except owner) for the TDF files
Args:
tdf_files_list(list) - List of TDFs
| def virtru_tdf3_python.Client.revoke_policies |
( |
|
policy_uuids_list | ) |
|
Revoke access for all the users (except owner) of the TDF files using the policy uuids
Args:
policy_uuids_list(list) - List of policy uuids
| def virtru_tdf3_python.Client.revoke_policy |
( |
|
policy_uuid | ) |
|
Revoke access for all the users (except owner) of the TDF file using the policy uuid
Args:
policy_uuid(string) - The policy uuid of the TDF
| def virtru_tdf3_python.Client.set_acm_url |
( |
|
url | ) |
|
Set the ACM url that will be used for TDF3 operations
Args:
acmUrl(string): the ACM url
| def virtru_tdf3_python.Client.set_cert_authority |
( |
|
cert_authority | ) |
|
Set the cert authority which will be used in SSL handshake for all the network I/O
Note: This is the optional interface. if the consumer of the SDK didn't provide one, the SDK
will use the default ones packaged in library
Args:
cert_authority(string): A string which holds the cert authority which will be used in SSL handshake
for all the network I/O
| def virtru_tdf3_python.Client.set_eas_url |
( |
|
url | ) |
|
DEPRECATED
Set the EAS url that will be used for TDF3 operations
Args:
url(string): the EAS (Entity Attribute Server) url
| def virtru_tdf3_python.Client.set_encrypted_storage_rul |
( |
|
url | ) |
|
Set the encrypted storage url that will be used for storing remote TDF
Args:
url(string): The encrypted storage url
| def virtru_tdf3_python.Client.set_kas_url |
( |
|
url | ) |
|
Set the KAS url that will be used for TDF operations
Args:
url(string): The KAS (Key Access Server) url
| def virtru_tdf3_python.Client.set_key_access_type |
( |
|
key_type | ) |
|
Sets the key access type
Note: Default is 'Remote'
Args:
key_type(KeyAccessType): The key access type.
| def virtru_tdf3_python.Client.set_offline |
( |
|
state | ) |
|
Set the offline mode.
Note: All the TDFs will be encrypted in online mode that means the sysmetric
key stored on the server.
Args:
state(bool): If true, all the TDFs will be encrypted in offline mode that means the sysmetric
key stored part of the TDF instead on the server.
| def virtru_tdf3_python.Client.set_oidc_provider_url |
( |
|
oidcUrl | ) |
|
Set the endpoint for the OIDC identity provider that the client will authenticate with.
Args:
oidcURL(string): The OIDC IdP (identity provider) url, in the form 'https://myIDP.net'
| def virtru_tdf3_python.Client.set_protocol |
( |
|
protocol | ) |
|
Set the protocol to be used for encryption and decryption.
Set the protocol to be used for encryption and decryption.
Note: Default protocol is HTML.
Args:
protocol(Protocol): Type of the protocol
| def virtru_tdf3_python.Client.set_rca_service_url |
( |
|
url | ) |
|
Set the rca service url that will be used for storing remote TDF
Args:
url(string): The RCA service url
| def virtru_tdf3_python.Client.set_securereader_url |
( |
|
url | ) |
|
Set the secure reader url which will be used in html protocol TDFs, which can be used to view and decrypt the TDF files
Args:
url(string): The secure reader url
| def virtru_tdf3_python.Client.update_policy_for_file |
( |
|
policy, |
|
|
|
tdf_file |
|
) |
| |
Update the policy for the given TDF file
Args:
policy(Policy): The policy settings to be applied on the TDF
tdf_file(string): The TDF file path
| def virtru_tdf3_python.Client.update_policy_for_files |
( |
|
policy, |
|
|
|
tdf_files_list |
|
) |
| |
Update the policy for the given TDF files
Args:
policy(Policy): The policy settings to be applied on the TDFs
tdf_files_list(list) - List of TDF files
| def virtru_tdf3_python.Client.update_policy_for_uuid |
( |
|
policy, |
|
|
|
policy_uuid |
|
) |
| |
Update the policy for the given policy uuid
Args:
policy(Policy): The policy settings to be applied on the TDF
policy_uuid(string): The policy uuid of the TDF
| def virtru_tdf3_python.Client.update_policy_for_uuids |
( |
|
policy, |
|
|
|
policy_uuid_list |
|
) |
| |
Update the policy for the given policy uuids
Args:
policy(Policy): The policy settings to be applied on the TDF
policy_uuid_list(list) - The vector of policy uuids for the TDFs
The documentation for this class was generated from the following file:
1.8.5