Quick Start Guide

After successfully installing the libsodium PHP extension, you can immediately begin using it to develop secure web applications.

Which Tool to Use, for Which Purpose

Deciding which libsodium feature to use for a given purpose is relatively straightforward, provided you keep these guidelines in mind:

• Prioritize the basic features (e.g. crypto_box and crypto_secretbox) over advanced features (e.g. crypto_stream_xor).
• If a more appropriate feature exists (e.g. crypto_pwhash_* instead of crypto_generichash), don't use a less appropriate one.
• Avoid deploying or publishing your own cryptographic constructions (e.g. generally, you should use crypto_secretbox instead of crypto_stream_xor then crypto_auth).

Libsodium Functions

This is a comprehensive list of all the functions available in the libsodium PHP extension.

• \Sodium\bin2hex()
• \Sodium\compare()
• \Sodium\crypto_aead_chacha20poly1305_decrypt()
• \Sodium\crypto_aead_chacha20poly1305_encrypt()
• \Sodium\crypto_aead_aes256gcm_decrypt()
• \Sodium\crypto_aead_aes256gcm_encrypt()
• \Sodium\crypto_aead_aes256gcm_is_available()
• \Sodium\crypto_auth()
• \Sodium\crypto_auth_verify()
• \Sodium\crypto_box()
• \Sodium\crypto_box_keypair()
• \Sodium\crypto_box_keypair_from_secretkey_and_publickey()
• \Sodium\crypto_box_open()
• \Sodium\crypto_box_publickey()
• \Sodium\crypto_box_publickey_from_secretkey()
• \Sodium\crypto_box_seal()
• \Sodium\crypto_box_seal_open()
• \Sodium\crypto_box_seed_keypair
• \Sodium\crypto_box_secretkey()
• \Sodium\crypto_kx()
• \Sodium\crypto_generichash()
• \Sodium\crypto_generichash_init()
• \Sodium\crypto_generichash_update()
• \Sodium\crypto_generichash_final()
• \Sodium\crypto_pwhash_scryptsalsa208sha256()
• \Sodium\crypto_pwhash_scryptsalsa208sha256_str()
• \Sodium\crypto_pwhash_scryptsalsa208sha256_str_verify()
• \Sodium\crypto_scalarmult()
• \Sodium\crypto_scalarmult_base()
• \Sodium\crypto_secretbox()
• \Sodium\crypto_secretbox_open()
• \Sodium\crypto_shorthash()
• \Sodium\crypto_sign()
• \Sodium\crypto_sign_detached()
• \Sodium\crypto_sign_ed25519_sk_to_curve25519()
• \Sodium\crypto_sign_ed25519_pk_to_curve25519()
• \Sodium\crypto_sign_keypair()
• \Sodium\crypto_sign_keypair_from_secretkey_and_publickey()
• \Sodium\crypto_sign_open()
• \Sodium\crypto_sign_publickey()
• \Sodium\crypto_sign_secretkey()
• \Sodium\crypto_sign_seed_keypair
• \Sodium\crypto_sign_verify_detached()
• \Sodium\crypto_stream()
• \Sodium\crypto_stream_xor()
• \Sodium\randombytes_buf()
• \Sodium\randombytes_random16()
• \Sodium\randombytes_uniform()
• \Sodium\hex2bin()
• \Sodium\increment()
• \Sodium\library_version_major()
• \Sodium\library_version_minor()
• \Sodium\memcmp()
• \Sodium\memzero()
• \Sodium\version_string()

Libsodium Constants