API Documentation

Contents:

• Cryptainer
  • Cryptainer object processing
    • encrypt_payload_into_cryptainer()
    • decrypt_payload_from_cryptainer()
    • extract_metadata_from_cryptainer()
    • get_cryptoconf_summary()
    • CryptainerEncryptionPipeline
    • encrypt_payload_and_stream_cryptainer_to_filesystem()
  • Validation utilities
    • check_cryptainer_sanity()
    • check_cryptoconf_sanity()
  • Filesystem operations
    • dump_cryptainer_to_filesystem()
    • load_cryptainer_from_filesystem()
    • delete_cryptainer_from_filesystem()
    • get_cryptainer_size_on_filesystem()
  • Cryptainer storage system
    • ReadonlyCryptainerStorage
    • CryptainerStorage
  • Trustee operations
    • get_trustee_proxy()
    • gather_trustee_dependencies()
    • request_decryption_authorizations()
• Trustee
  • API for trustee services
    • TrusteeApi
    • ReadonlyTrusteeApi
• Authenticator
  • initialize_authenticator()
  • is_authenticator_initialized()
• Authentication device
  • list_available_authdevices()
• Key generation
  • Public API
    • SUPPORTED_ASYMMETRIC_KEY_ALGOS
    • generate_keypair()
    • load_asymmetric_key_from_pem_bytestring()
    • SUPPORTED_SYMMETRIC_KEY_ALGOS
    • generate_symkey()
  • Private API
    • RSA
    • DSA
    • ECC
• Key storage
  • Keystore
    • load_keystore_metadata()
    • InMemoryKeystore
    • FilesystemKeystore
  • Keystore pools
    • InMemoryKeystorePool
    • FilesystemKeystorePool
• Signature
  • SUPPORTED_SIGNATURE_ALGOS
  • sign_message()
  • verify_message_signature()
• Encryption
  • Public API
    • SUPPORTED_CIPHER_ALGOS
    • AUTHENTICATED_CIPHER_ALGOS
    • STREAMABLE_CIPHER_ALGOS
    • encrypt_bytestring()
    • decrypt_bytestring()
    • PayloadEncryptionPipeline
  • Private API
    • AES with CBC mode
    • AES with EAX mode
    • ChaCha20_Poly1305
    • RSA - PKCS#1 OAEP
• Shared secret
  • split_secret_into_shards()
  • recombine_secret_from_shards()
• Sensor
  • Aggregation of records into binary archives
    • TarfileRecordAggregator
  • Base classes for poller/pusher sensors
    • JsonDataAggregator
    • PeriodicValuePoller
  • Simultaneous management of multiple sensors
    • SensorManager
• Json-rpc client
  • JsonRpcProxy
  • status_slugs_response_error_handler()
• Utilities
  • Task handling
    • TaskRunnerStateMachineBase()
    • PeriodicTaskHandler()
  • Hashing
    • SUPPORTED_HASH_ALGOS
    • hash_message()
  • Serialization
    • dump_to_json_str()
    • load_from_json_str()
    • dump_to_json_bytes()
    • load_from_json_bytes()
    • dump_to_json_file()
    • load_from_json_file()
  • Miscellaneous
    • generate_uuid0()
    • split_as_chunks()
    • recombine_chunks()
• Exceptions
  • FunctionalError
  • ExistenceError
  • KeyDoesNotExist
  • KeyAlreadyExists
  • KeystoreDoesNotExist
  • KeystoreAlreadyExists
  • KeystoreMetadataDoesNotExist
  • AuthenticationError
  • AuthorizationError
  • OperationNotSupported
  • CryptographyError
  • EncryptionError
  • DecryptionError
  • DecryptionIntegrityError
  • SignatureCreationError
  • SignatureVerificationError
  • KeyLoadingError
  • ValidationError
  • SchemaValidationError
• Error handling
  • StatusSlugMapper
    • StatusSlugMapper.gather_exception_subclasses()
    • StatusSlugMapper.get_closest_exception_class_for_status_slugs()
    • StatusSlugMapper.slugify_exception_class()
  • gather_exception_subclasses()
  • slugify_exception_class()
  • construct_status_slug_mapper()
  • get_closest_exception_class_for_status_slugs()
• Scaffolding for tests
  • check_keystore_basic_get_set_api()
  • check_keystore_free_keys_api()
  • check_keystore_free_keys_concurrency()
  • check_sensor_state_machine()