Index

Modules: nimword, nimword/argon2, nimword/pbkdf2_sha256, nimword/pbkdf2_sha512, nimword/private/base64_utils, nimword/private/pbkdf2_utils, nimword/private/types.

API symbols

decode:

• base64_utils: proc decode(s: string): seq[byte]

encodeHash:

• argon2: proc encodeHash(hash: Hash; salt: seq[byte]; iterations: int; algorithm: PasswordHashingAlgorithm; memoryLimitKibiBytes: int): string
• pbkdf2_sha256: proc encodeHash(hash: Hash; salt: seq[byte]; iterations: SomeInteger): string
• pbkdf2_sha512: proc encodeHash(hash: Hash; salt: seq[byte]; iterations: SomeInteger): string
• pbkdf2_utils: proc encodeHash(hash: Hash; salt: seq[byte]; iterations: SomeInteger; algorithm: Pbkdf2Algorithm): string

Hash:

• types: type Hash

hashEncodePassword:

• nimword: proc hashEncodePassword(password: Password; iterations: int; algorithm: NimwordHashingAlgorithm = nhaDefault): string
• argon2: proc hashEncodePassword(password: Password; iterations: int = crypto_pwhash_opslimit_moderate().int; algorithm: PasswordHashingAlgorithm = phaDefault; memoryLimitKibiBytes: int = int(crypto_pwhash_memlimit_moderate()) / 1024.int): string
• pbkdf2_sha256: proc hashEncodePassword(password: Password; iterations: int): string
• pbkdf2_sha512: proc hashEncodePassword(password: Password; iterations: int): string

hashPassword:

• argon2: proc hashPassword(password: Password; salt: seq[byte]; iterations: int = crypto_pwhash_opslimit_moderate().int; hashLength: int = 32; algorithm: PasswordHashingAlgorithm = phaDefault; memoryLimitKibiBytes: int = int(crypto_pwhash_memlimit_moderate()) / 1024.int): Hash
• pbkdf2_sha256: proc hashPassword(password: Password; salt: seq[byte]; iterations: int): Hash
• pbkdf2_sha512: proc hashPassword(password: Password; salt: seq[byte]; iterations: int): Hash

hashPbkdf2:

• pbkdf2_utils: proc hashPbkdf2(password: Password; salt: seq[byte]; iterations: int; digestFunction: EVP_MD): Hash

isValidPassword:

• nimword: proc isValidPassword(password: Password; encodedHash: string): bool
• argon2: proc isValidPassword(password: Password; encodedHash: string): bool
• pbkdf2_sha256: proc isValidPassword(password: Password; encodedHash: string): bool
• pbkdf2_sha512: proc isValidPassword(password: Password; encodedHash: string): bool

nhaArgon2i:

• nimword: NimwordHashingAlgorithm.nhaArgon2i

nhaArgon2id:

• nimword: NimwordHashingAlgorithm.nhaArgon2id

nhaDefault:

• nimword: NimwordHashingAlgorithm.nhaDefault

nhaPbkdf2Sha256:

• nimword: NimwordHashingAlgorithm.nhaPbkdf2Sha256

nhaPbkdf2Sha512:

• nimword: NimwordHashingAlgorithm.nhaPbkdf2Sha512

NimwordHashingAlgorithm:

• nimword: enum NimwordHashingAlgorithm

Password:

• types: type Password

Pbkdf2Algorithm:

• pbkdf2_utils: enum Pbkdf2Algorithm

Pbkdf2Error:

• pbkdf2_utils: object Pbkdf2Error

pbkdf2_sha256:

• pbkdf2_utils: Pbkdf2Algorithm.pbkdf2_sha256

pbkdf2_sha512:

• pbkdf2_utils: Pbkdf2Algorithm.pbkdf2_sha512

toBytes:

• base64_utils: proc toBytes(s: string): seq[byte]

toPassword:

• types: converter toPassword(str: string): Password