Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation #1

Open
AmalieDue opened this issue Nov 18, 2019 · 1 comment
Open

Missing documentation #1

AmalieDue opened this issue Nov 18, 2019 · 1 comment

Comments

@AmalieDue
Copy link
Collaborator

These symbols lack proper documentation:

crypto_auth_PRIMITIVE
crypto_box_PRIMITIVE
crypto_core_ed25519_from_uniform
crypto_core_ed25519_is_valid_point
crypto_core_ed25519_UNIFORMBYTES
crypto_generichash_PRIMITIVE
crypto_hash
crypto_hash_BYTES
crypto_hash_PRIMITIVE
crypto_hash_sha256
crypto_hash_sha256_BYTES
crypto_hash_sha512
crypto_hash_sha512_BYTES
crypto_kdf_PRIMITIVE
crypto_kx_PRIMITIVE
crypto_onetimeauth_PRIMITIVE
crypto_pwhash_PRIMITIVE
crypto_pwhash_STRPREFIX
crypto_scalarmult_PRIMITIVE
crypto_secretbox_PRIMITIVE
crypto_shorthash_PRIMITIVE
crypto_stream_PRIMITIVE
@christianbundy
Copy link

Wow, thanks for making this list!

I've looked into crypto_xxx_PRIMITIVE and it looks to me like an implementation detail -- libsodium doesn't expose that as a constant, it's just used in the upstream source code. Maybe we should remove it from Sodium-Native?

Btw, how did you come up with this list? Here's a similar list I came up with:

$ for x in $(node -p 'Object.keys(require("sodium-native")).join("\n")'); if [[ -z $(git grep $x) ]]; then echo $x; fi
sodium_free
crypto_stream_chacha20_xor_ic
crypto_stream_chacha20_ietf
crypto_stream_chacha20_ietf_xor
crypto_stream_chacha20_ietf_xor_ic
crypto_stream_chacha20_ietf_xor_init
crypto_stream_chacha20_ietf_xor_update
crypto_stream_chacha20_ietf_xor_final
crypto_stream_xchacha20
crypto_stream_xchacha20_xor
crypto_stream_xchacha20_xor_ic
crypto_stream_xchacha20_xor_init
crypto_stream_xchacha20_xor_update
crypto_stream_xchacha20_xor_final
crypto_stream_salsa20_xor
crypto_stream_salsa20_xor_ic
crypto_stream_salsa20_xor_init
crypto_stream_salsa20_xor_update
crypto_stream_salsa20_xor_final
crypto_aead_chacha20poly1305_ietf_keygen
crypto_aead_chacha20poly1305_ietf_encrypt
crypto_aead_chacha20poly1305_ietf_decrypt
crypto_aead_chacha20poly1305_ietf_encrypt_detached
crypto_aead_chacha20poly1305_ietf_decrypt_detached
crypto_generichash_keygen
crypto_stream_chacha20_ietf_xor_STATEBYTES
crypto_stream_xchacha20_xor_STATEBYTES
crypto_stream_salsa20_xor_STATEBYTES
crypto_stream_chacha20_MESSAGEBYTES_MAX
crypto_stream_chacha20_ietf_KEYBYTES
crypto_stream_chacha20_ietf_NONCEBYTES
crypto_stream_chacha20_ietf_MESSAGEBYTES_MAX
crypto_stream_xchacha20_KEYBYTES
crypto_stream_xchacha20_NONCEBYTES
crypto_stream_xchacha20_MESSAGEBYTES_MAX
crypto_stream_salsa20_KEYBYTES
crypto_stream_salsa20_NONCEBYTES
crypto_stream_salsa20_MESSAGEBYTES_MAX
crypto_pwhash_PASSWD_MIN
crypto_pwhash_PASSWD_MAX
crypto_pwhash_scryptsalsa208sha256_PASSWD_MIN
crypto_pwhash_scryptsalsa208sha256_PASSWD_MAX
crypto_pwhash_scryptsalsa208sha256_STRPREFIX
crypto_aead_chacha20poly1305_ietf_ABYTES
crypto_aead_chacha20poly1305_ietf_KEYBYTES
crypto_aead_chacha20poly1305_ietf_NPUBBYTES
crypto_aead_chacha20poly1305_ietf_NSECBYTES
crypto_aead_chacha20poly1305_ietf_MESSAGEBYTES_MAX

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants