justinwongcn/moonpgp/s2k

README
U
AeadMode
U
CipherAlgo
U
CompressedAlgo
U
DecryptResult
U
DecryptionBuilder
U
EncryptionBuilder
U
HashId
U
KeyGenBuilder
U
KeyRing
U
Pgp
U
PrivateKey
U
PublicKey
U
SecretSubkeyCert
U
SessionKey
U
SubkeyCert
U
UserIdBinding
U
VerifyStatus
V
DEFAULT_MAX_DECOMPRESSED_BYTES
V
decrypt_and_verify
V
decrypt_binary_with_password
V
decrypt_binary_with_private_key
V
decrypt_to_session_key
V
decrypt_with_password
V
decrypt_with_private_key
V
encrypt_to_recipients
V
encrypt_to_session_key
V
encrypt_with_password
V
encrypt_with_password_argon2
V
encrypt_with_password_v6
V
generate_ed25519_key
V
generate_ed25519_v6_key
V
generate_key
V
generate_session_key
V
pgp
V
recover_session_key_with_key
V
recover_session_key_with_password
V
sign_and_encrypt
V
sign_cleartext
V
sign_cleartext_with
V
sign_detached
V
sign_inline
V
verify_cleartext
V
verify_detached
V
verify_inline
V
verify_key_signature

justinwongcn/moonpgp/s2k does not have a README file

S2k

pub(all) enum S2k {
  Simple(@justinwongcn/moonpgp/primitives.HashId
HashId)
  Salted(@justinwongcn/moonpgp/primitives.HashId
HashId, Bytes)
  Iterated(@justinwongcn/moonpgp/primitives.HashId
HashId, Bytes, Int)
  Argon2(Bytes, Int, Int, Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

String-to-Key derivations (RFC 9580 §3.7). PGP-wire material, never a replaceable third-party concern.

S2k::derive_key

source

fn S2k::derive_key(self : S2k, passphrase : BytesView, key_len : Int) -> Bytes raise

Derive a key of key_len bytes from passphrase under this specifier, capped at the implementation's 2 GiB Argon2 ceiling (@primitives.ARGON2_MAX_MEMORY_KIB). Use derive_key_capped when parsing untrusted specifiers and a tighter policy is wanted.

S2k::derive_key_capped

source

fn S2k::derive_key_capped(self : S2k, passphrase : BytesView, key_len : Int, max_memory_kib : Int) -> Bytes raise

Derive a key of key_len bytes from passphrase under this specifier, enforcing max_memory_kib as an upper bound on the Argon2 memory cost. A 20-octet specifier can ask for 2^31 KiB, so callers that parse untrusted packets should pass a policy limit rather than rely on the 2 GiB implementation ceiling that derive_key uses.

S2k::encode

source

fn S2k::encode(self : S2k) -> Bytes raise

Encode this specifier to its wire form.

S2k::equal

source

fn S2k::equal(S2k, S2k) -> Bool

S2k::is_argon2

source

fn S2k::is_argon2(self : S2k) -> Bool

True for the Argon2 (type 4) specifier. RFC 9580 §3.7.2.1 permits it in a Secret Key packet only with S2K usage octet 253 (AEAD).

S2k::not_equal

source

fn S2k::not_equal(x : S2k, y : S2k) -> Bool

S2k::to_repr

source

fn S2k::to_repr(S2k) -> @moonbitlang/core/debug.Repr
Repr

ARGON2_SALT_SIZE

source

let ARGON2_SALT_SIZE : Int

Salt length in octets for Argon2 S2K (RFC 9580 §3.7.1.4).

SALT_SIZE

source

let SALT_SIZE : Int

Salt length in octets for salted/iterated S2K.

decode_count

source

fn decode_count(count_byte : Int) -> Int

Decode an encoded count byte into the actual octet count (RFC 9580 §3.7.1.3).

encode_count

source

fn encode_count(target : Int) -> Int

Pick the count byte that yields the smallest count >= target (as GnuPG does). When no byte can reach the target, the largest count (255) is returned: falling back to 0 would silently select the minimum work factor instead of the maximum.

parse

source

fn parse(view : BytesView) -> (S2k, Int) raise

Parse an S2K specifier from the front of view. Returns the specifier and the number of bytes consumed.

Source Files

s2k.mbt

Site source Report issue Packages Build queue Skills Statistics

#S2k

#S2k::derive_key

#S2k::derive_key_capped

#S2k::encode

#S2k::equal

#S2k::is_argon2

#S2k::not_equal

#S2k::to_repr

#ARGON2_SALT_SIZE

#SALT_SIZE

#decode_count

#encode_count

#parse

Source Files

S2k

S2k::derive_key

S2k::derive_key_capped

S2k::encode

S2k::equal

S2k::is_argon2

S2k::not_equal

S2k::to_repr

ARGON2_SALT_SIZE

SALT_SIZE

decode_count

encode_count

parse