API Reference — secret¶

The secret module provides utilities for cryptographic key generation.

Functions¶

secret_key() -> str¶

Generate a random HMAC secret key. Uses the default size (32 bytes).

from ciphertoken.secret import secret_key

key = secret_key()
print(key)  # base64-encoded 32-byte random string

secret_key_with_size(size: int) -> str¶

Generate a random HMAC secret key with a custom size.

from ciphertoken.secret import secret_key_with_size

key = secret_key_with_size(64)

Parameters:

Raises: ValueError if size is less than 16.

generate_hmac_secret(size: int) -> str¶

Explicitly generate an HMAC secret key. This is equivalent to secret_key_with_size.

from ciphertoken.secret import generate_hmac_secret

secret = generate_hmac_secret(32)

generate_hmac_secret_async(size: int) -> str¶

Asynchronous version of HMAC secret generation.

import asyncio
from ciphertoken.secret import generate_hmac_secret_async

async def main():
    secret = await generate_hmac_secret_async(32)

asyncio.run(main())

generate_rsa_keypair(bits: Optional[int] = 2048) -> Tuple[str, str]¶

Generate an RSA public/private key pair in PKCS#8 PEM format.

from ciphertoken.secret import generate_rsa_keypair

private_key, public_key = generate_rsa_keypair(bits=2048)

Parameters:

Returns: