CryptoSys Home >
API >
Python CryptoSys API Cross Reference
A list of all the classes and functions in Python for CryptoSys API with a cross reference to the corresponding API core function in the main manual. Check the link to the API core function for more detailed information on the underlying behaviour. All methods are static methods. See also the full crsysapi Python documentation.
| Class | Method | API Function | Description |
|---|---|---|---|
| Aead -- Authenticated encryption with Additional Data (AEAD) functions. | |||
| encrypt_with_tag | AEAD_EncryptWithTag | Encrypt data using specified AEAD algorithm in one-off operation. The authentication tag is appended to the output. | |
| decrypt_with_tag | AEAD_DecryptWithTag | Decrypt data using specified AEAD algorithm in one-off operation. The authentication tag is expected appended to the output. | |
| Blowfish -- Blowfish cipher algorithm (Schneier, 1993). | |||
| encrypt_block | BLF_BytesMode | Encrypt a block of data. Must be an exact multiple of 8 bytes. | |
| decrypt_block | BLF_BytesMode | Decrypt a block of data. Must be an exact multiple of 8 bytes. | |
| Cipher -- Generic block cipher functions. | |||
| blockbytes | n/a | Return the block size in bytes for a given cipher algorithm. | |
| keybytes | n/a | Return the key size in bytes for a given cipher algorithm. | |
| encrypt | CIPHER_EncryptBytes | Encrypt data. | |
| decrypt | CIPHER_DecryptBytes | Decrypt data. | |
| encrypt_hex | CIPHER_EncryptHex | Encrypt data hex-encoded data using hex-encoded parameters. | |
| decrypt_hex | CIPHER_DecryptHex | Decrypt hex-encoded data using hex-encoded parameters. | |
| encrypt_block | CIPHER_EncryptBytes | Encrypt a block of data. Must be an exact multiple of block length. | |
| decrypt_block | CIPHER_DecryptBytes | Decrypt a block of data. Must be an exact multiple of block length. | |
| file_encrypt | CIPHER_FileEncrypt | Encrypt a file. | |
| file_decrypt | CIPHER_FileDecrypt | Decrypt a file. | |
| key_wrap | CIPHER_KeyWrap | Wrap (encrypt) key material with a key-encryption key. | |
| key_unwrap | CIPHER_KeyUnwrap | Unwrap (decrypt) key material with a key-encryption key. | |
| pad | PAD_BytesBlock | Pad byte array to correct length for ECB and CBC encryption. | |
| pad_hex | PAD_HexBlock | Pad hex-encoded string to correct length for ECB and CBC encryption. | |
| unpad | PAD_UnpadBytes | Remove padding from an encryption block. | |
| unpad_hex | PAD_UnpadHex | Remove the padding from a hex-encoded encryption block. | |
| CipherStream -- Stream cipher functions. | |||
| bytes | CIPHER_StreamBytes | Encipher data in array of bytes using specified stream cipher. | |
| file | CIPHER_StreamFile | Encipher data in a file using specified stream cipher. | |
| Cnv -- Character conversion routines. | |||
| tohex | CNV_HexStrFromBytes | Encode binary data as a hexadecimal string. | |
| fromhex | CNV_BytesFromHexStr | Decode a hexadecimal-encoded string into a byte array. | |
| tobase64 | CNV_B64StrFromBytes | Encode binary data as a base64 string. | |
| frombase64 | CNV_BytesFromB64Str | Decode a base64-encoded string into a byte array. | |
| shortpathname | CNV_ShortPathName | Retrieve the Windows short path form of the specified path. | |
| Compr -- Compression utilities. | |||
| compress | COMPR_Compress | Compress data using compression algorithm. | |
| uncompress | COMPR_Uncompress | Uncompress data using compression algorithm. | |
| Crc -- CRC-32 computations. | |||
| bytes | CRC_Bytes | Computes the CRC-32 checksum of an array of bytes. | |
| file | CRC_File | Computes the CRC-32 checksum of a file. | |
| Gen -- General info about the core DLL and errors returned by it. | |||
| version | API_Version | Return the release version of the core CryptoSys API DLL as an integer value. | |
| compile_time | API_CompileTime | Return date and time the core native DLL was last compiled. | |
| module_name | API_ModuleName | Return full path name of the current process's DLL module. | |
| module_info | API_ModuleInfo | Get additional information about the core DLL module. | |
| core_platform | API_Platform | Return the platform the core DLL was compiled for ('Win32' or 'X64'). | |
| licence_type | API_LicenceType | Return licence type: "D"=Developer "T"=Trial. | |
| error_lookup | API_ErrorLookup | Return a description of an error code. | |
| error_code | API_ErrorCode | Return the error code of the *first* error that occurred when calling the last function. | |
| Hash -- Message digest hash functions. | |||
| length | HASH_Length | Return length of message digest output in bytes. | |
| data | HASH_Bytes | Compute message digest as a byte array from bytes data. | |
| file | HASH_File | Compute message digest as a byte array from data in a file. | |
| hex_from_data | HASH_HexFromBytes | Compute message digest in hexadecimal format from bytes data. | |
| hex_from_string | n/a | Compute message digest in hexadecimal format from a string. | |
| hex_from_file | HASH_HexFromFile | Compute message digest in hexadecimal format from data in a file. | |
| hex_from_hex | HASH_HexFromHex | Compute message digest in hexadecimal format from data in a hexadecimal-encoded string. | |
| hex_from_bits | HASH_HexFromBits | Compute message digest in hexadecimal format from bit-oriented data. | |
| Mac -- Message authentication code (MAC) functions. | |||
| data | MAC_Bytes | Compute a message authentication code (MAC) as a byte array from bytes data. | |
| hex_from_data | MAC_HexFromBytes | Compute a message authentication code (MAC) in hexadecimal format from bytes data. | |
| hex_from_string | n/a | Compute a message authentication code (MAC) in hexadecimal format from string data. | |
| hex_from_hex | MAC_HexFromHex | Compute a message authentication code (MAC) in hex format from data in hex-encoded strings. | |
| Pbe -- Password-based encryption. | |||
| kdf2 | PBE_Kdf2 | Derive a key of any length from a password using the PBKDF2 algorithm. | |
| scrypt | PBE_Scrypt | Derive a key of any length from a password using the SCRYPT algorithm from RFC7914. | |
| Prf -- Pseudorandom function (PRF) Functions. | |||
| bytes | PRF_Bytes | Generate output bytes using a pseudorandom function (PRF). | |
| Rng -- Random Number Generator to NIST SP800-90A. | |||
| bytestring | RNG_KeyBytes | Generate an array of n random bytes. | |
| number | RNG_Number | Generate a random integer in a given range. | |
| octet | RNG_Number | Generate a single random octet (byte). | |
| initialize | RNG_Initialize | Initialize the RNG generator using a seed file. | |
| initialize_ex | RNG_Initialize | Query and initialize the RNG generator using Intel(R) DRNG, if available. | |
| update_seedfile | RNG_UpdateSeedFile | Update the RNG seed file with more entropy. | |
| make_seedfile | RNG_MakeSeedFile | Create a new seed file suitable for use with Rng.initialize(). | |
| bytes_with_prompt | RNG_BytesWithPrompt | Generate an array of n random bytes with a prompt for user to enter random keystrokes. | |
| test_drbgvs | RNG_TestDRBGVS | Test the random number generator for conformance to NIST SP 800-90A using the relevant test specified in the Deterministic Random Bit Generator Validation System (DRBGVS). | |
| Wipe -- Wipe data securely. | |||
| file | WIPE_File | Securely wipe and delete a file. | |
| data | WIPE_Data | Zeroize data in memory. | |
| Xof -- Extendable-output function (XOF). | |||
| bytes | XOF_Bytes | Generate bytes using an extendable-output function (XOF). | |
For more information or to comment on this page, please send us a message.
This page last updated 15 August 2025
