crypto

April 7, 2026 · View on GitHub

{#cryptomodule}

crypto

Cryptographic operations; hashing, HMAC, RSA, X509 certificates.

Name	Description
`crypto`	Cryptographic primitives, key helpers, and certificate utilities backed by OpenSSL.

crypto

Cryptographic primitives, key helpers, and certificate utilities backed by OpenSSL.

Classes

Name	Description
`Cipher`	Provides symmetric algorithms for encryption and decryption. The algorithms that are available depend on the particular version of OpenSSL that is installed.
`Hash`	Incremental cryptographic hash engine wrapping OpenSSL EVP digest functions.
`X509Certificate`	RAII wrapper for an OpenSSL X509 certificate with PEM loading and inspection.

Typedefs

Return	Name	Description
`std::unique_ptr< EVP_CIPHER_CTX, decltype(&EVP_CIPHER_CTX_free)>`	`EvpCipherCtxPtr`	Owning OpenSSL cipher context handle with automatic `EVP_CIPHER_CTX_free`.
`std::vector< unsigned char >`	`ByteVec`	Generic storage container for storing cryptographic binary data.
`std::unique_ptr< EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>`	`EvpMdCtxPtr`	Owning OpenSSL digest context handle with automatic `EVP_MD_CTX_free`.
`::RSA`	`RSAKey`	Alias for the OpenSSL RSA key type, brought into the icy::crypto namespace.
`std::unique_ptr< X509, decltype(&X509_free)>`	`X509Ptr`	RAII pointer alias for OpenSSL `X509*` values.

{#evpcipherctxptr}

EvpCipherCtxPtr

std::unique_ptr< EVP_CIPHER_CTX, decltype(&EVP_CIPHER_CTX_free)> EvpCipherCtxPtr()

Owning OpenSSL cipher context handle with automatic EVP_CIPHER_CTX_free.

{#bytevec}

ByteVec

std::vector< unsigned char > ByteVec()

Generic storage container for storing cryptographic binary data.

{#evpmdctxptr}

EvpMdCtxPtr

std::unique_ptr< EVP_MD_CTX, decltype(&EVP_MD_CTX_free)> EvpMdCtxPtr()

Owning OpenSSL digest context handle with automatic EVP_MD_CTX_free.

{#rsakey}

RSAKey

::RSA RSAKey()

Alias for the OpenSSL RSA key type, brought into the icy::crypto namespace.

Currently a transparent alias for the OpenSSL RSA struct. Use OpenSSL RSA_* functions directly to create, populate, and free RSAKey objects. This alias exists as a stable forward-declaration point; a higher-level RAII wrapper may replace it in a future version.

{#x509ptr}

X509Ptr

std::unique_ptr< X509, decltype(&X509_free)> X509Ptr()

RAII pointer alias for OpenSSL X509* values.

Functions

Return	Name	Description
`std::string`	`encryptString`	Encrypts a string using the specified cipher, key, and IV in a single call.
`std::string`	`decryptString`	Decrypts a string using the specified cipher, key, and IV in a single call.
`void`	`initializeEngine`	Initialize the Crypto library, as well as the underlying OpenSSL libraries.
`void`	`uninitializeEngine`	Uninitializes the Crypto library.
`std::string`	`hash` `inline`	Computes a hex-encoded digest of a string in a single call.
`std::string`	`hash` `inline`	Computes a hex-encoded digest of a raw buffer in a single call.
`std::string`	`checksum` `inline`	Computes the hex-encoded checksum of a file using the given algorithm.
`std::string`	`computeHMAC`	Computes an HMAC-SHA1 message authentication code.

{#encryptstring}

encryptString

template<typename K, typename I> std::string encryptString(const std::string & algorithm, const std::string & data, const K & key, const I & iv, Cipher::Encoding encoding)

Encrypts a string using the specified cipher, key, and IV in a single call.

Constructs a Cipher, optionally applies key and iv (skipped when empty), then delegates to Cipher::encryptString().

Return	Name	Description
	`Cipher`	Constructs a Cipher with a randomly generated key and IV.
	`Cipher`	Constructs a Cipher with an explicit key and initialization vector.
	`Cipher`	Constructs a Cipher and derives a key and IV from a passphrase.
	`~Cipher`	Destroys the Cipher and resets the OpenSSL context.
`void`	`initEncryptor`	Initializes the cipher context for encryption.
`void`	`initDecryptor`	Initializes the cipher context for decryption.
`ssize_t`	`update`	Processes a block of data through the cipher (encrypt or decrypt).
`ssize_t`	`update` `inline`	Processes a block of data through the cipher using generic buffer types.
`ssize_t`	`final`	Finalizes the cipher operation and flushes any remaining buffered data.
`ssize_t`	`final` `inline`	Finalizes the cipher operation using a generic output buffer type.
`ssize_t`	`encrypt`	Encrypts a buffer and writes the result with optional transport encoding.
`ssize_t`	`encrypt` `inline`	Encrypts data using generic input/output buffer types.
`std::string`	`encryptString` `virtual`	Encrypts a string and returns the result with optional transport encoding.
`std::string`	`decryptString` `virtual`	Decrypts a string that was previously encrypted with optional encoding.
`void`	`encryptStream` `virtual`	Encrypts all data from `source` and writes the result to `sink`.
`void`	`decryptStream` `virtual`	Decrypts all data from `source` and writes the result to `sink`.
`void`	`setKey` `inline`	Sets the encryption key.
`void`	`setIV` `inline`	Sets the initialization vector (IV).
`int`	`setPadding`	Enables or disables PKCS block padding.
`const ByteVec &`	`getKey` `const`	Returns the raw encryption key bytes.
`const ByteVec &`	`getIV` `const`	Returns the raw initialization vector bytes.
`const std::string &`	`name` `const`	Returns the OpenSSL cipher name this object was constructed with.
`int`	`blockSize` `const`	Returns the cipher block size in bytes.
`int`	`keySize` `const`	Returns the required key length in bytes for this cipher.
`int`	`ivSize` `const`	Returns the required initialization vector length in bytes.
`const EVP_CIPHER *`	`cipher`	Returns the underlying OpenSSL EVP_CIPHER object.

Return	Name	Description
`bool`	`_initialized`
`bool`	`_encrypt`
`const EVP_CIPHER *`	`_cipher`
`EvpCipherCtxPtr`	`_ctx`
`std::string`	`_name`
`ByteVec`	`_key`
`ByteVec`	`_iv`

Return	Name	Description
	`Cipher`	Deleted constructor.
	`Cipher`	Deleted constructor.
	`Cipher`	Deleted constructor.
`void`	`generateKey`	Derives and sets the key and IV from a passphrase using EVP_BytesToKey.
`void`	`setRandomKey`	Fills the key buffer with cryptographically random bytes.
`void`	`setRandomIV`	Fills the IV buffer with cryptographically random bytes.
`void`	`init`	Initializes or resets the OpenSSL cipher context for the given direction.

Value	Description
`Binary`	Plain binary output.
`Base64`	Base64-encoded output.
`BinHex`	BinHex-encoded output.
`Base64_NoLF`	Base64-encoded output, no linefeeds.
`BinHex_NoLF`	BinHex-encoded output, no linefeeds.

Return	Name	Description
	`Hash`	Constructs a Hash engine for the given algorithm.
	`~Hash`	Destroys the Hash engine and releases OpenSSL resources.
`void`	`update`	Feeds a single character into the digest computation.
`void`	`update`	Feeds a string view into the digest computation.
`void`	`update`	Feeds a raw memory buffer into the digest computation.
`const ByteVec &`	`digest`	Finalizes the digest computation and returns the raw binary result.
`std::string`	`digestStr`	Finalizes the digest computation and returns the result as a raw binary string (not hex-encoded). Use icy::hex::encode() on digest() if you need a printable representation.
`void`	`reset`	Resets the digest context and clears the cached result, allowing the engine to be reused for a new computation with the same algorithm.
`const std::string &`	`algorithm` `const`	Returns the algorithm name this engine was constructed with.

Return	Name	Description
`EvpMdCtxPtr`	`_ctx`
`const EVP_MD *`	`_md`
`crypto::ByteVec`	`_digest`
`std::string`	`_algorithm`

Return	Name	Description
	`X509Certificate` `explicit`	Constructs an X509Certificate by parsing a PEM-encoded certificate from memory.
	`X509Certificate` `explicit`	Constructs an X509Certificate by reading a PEM-encoded certificate from a file.
	`X509Certificate` `explicit`	Constructs an X509Certificate taking ownership of an existing OpenSSL X509 object.
	`X509Certificate`	Constructs an X509Certificate from an existing OpenSSL X509 object, optionally sharing ownership via reference count increment.
	`X509Certificate`	Copy-constructs an X509Certificate by duplicating the underlying X509 object.
	`X509Certificate`	Move-constructs an X509Certificate, transferring ownership from `cert`.
`X509Certificate &`	`operator=`	Copy-assigns a certificate, duplicating the underlying X509 object.
`X509Certificate &`	`operator=`	Move-assigns a certificate, transferring ownership from `cert`.
`void`	`swap`	Swaps this certificate with `cert`.
	`~X509Certificate`	Destroys the X509Certificate and releases the underlying OpenSSL X509 object.
`const std::string &`	`issuerName` `const`	Returns the full distinguished name of the certificate issuer.
`std::string`	`issuerName` `const`	Extracts a single field from the certificate issuer's distinguished name.
`const std::string &`	`subjectName` `const`	Returns the full distinguished name of the certificate subject.
`std::string`	`subjectName` `const`	Extracts a single field from the certificate subject's distinguished name.
`std::string`	`commonName` `const`	Returns the common name (CN) from the certificate subject.
`void`	`extractNames` `const`	Extracts the common name and the set of Subject Alternative Name (SAN) DNS entries from the certificate.
`DateTime`	`validFrom` `const`	Returns the date and time from which the certificate is valid.
`DateTime`	`expiresOn` `const`	Returns the date and time at which the certificate expires.
`void`	`save` `const`	Writes the certificate in PEM format to an output stream.
`void`	`save` `const`	Writes the certificate in PEM format to a file.
`bool`	`issuedBy` `const`	Verifies whether this certificate was signed by the given issuer.
`const X509 *`	`certificate` `const`	Returns a const pointer to the underlying OpenSSL X509 object.
`X509 *`	`certificate`	Returns a mutable pointer to the underlying OpenSSL X509 object.

Return	Name	Description
`void`	`load`	Parses a PEM-encoded certificate from a memory buffer and stores it.
`void`	`load`	Reads a PEM-encoded certificate from a file and stores it.
`void`	`init`	Populates _issuerName and _subjectName from the loaded certificate.

Value	Description
`NID_COMMON_NAME`	Common name (CN field).
`NID_COUNTRY`	Country code (C field).
`NID_LOCALITY_NAME`	Locality / city (L field).
`NID_STATE_OR_PROVINCE`	State or province (ST field).
`NID_ORGANIZATION_NAME`	Organization name (O field).
`NID_ORGANIZATION_UNIT_NAME`	Organizational unit (OU field).

Return	Name	Description
`std::string`	`_issuerName`
`std::string`	`_subjectName`
`X509Ptr`	`_certificate`