diff --git a/reference/sodium/book.xml b/reference/sodium/book.xml new file mode 100644 index 000000000..9120a8861 --- /dev/null +++ b/reference/sodium/book.xml @@ -0,0 +1,44 @@ + + + + + + + Sodium + Sodium + + + &reftitle.intro; + + Sodium is a modern, easy-to-use software library for encryption, decryption, signatures, password hashing and more. + Its goal is to provide all of the core operations needed to build higher-level cryptographic tools. + + + + &reference.sodium.setup; + &reference.sodium.constants; + &reference.sodium.reference; + &reference.sodium.sodiumexception; + + + + diff --git a/reference/sodium/configure.xml b/reference/sodium/configure.xml new file mode 100644 index 000000000..74e6544d9 --- /dev/null +++ b/reference/sodium/configure.xml @@ -0,0 +1,38 @@ + + + + +
+ &reftitle.install; + + + Use when compiling PHP. + + + + Windows users should include php_sodium.dll into &php.ini; + + +
+ + + diff --git a/reference/sodium/constants.xml b/reference/sodium/constants.xml new file mode 100644 index 000000000..ddf294acd --- /dev/null +++ b/reference/sodium/constants.xml @@ -0,0 +1,821 @@ + + + + + + &reftitle.constants; + &extension.constants; + + + + + SODIUM_LIBRARY_VERSION + (string) + + + + + + + + + SODIUM_LIBRARY_MAJOR_VERSION + (int) + + + + + + + + + SODIUM_LIBRARY_MINOR_VERSION + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_AES256GCM_NSECBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AUTH_BYTES + (int) + + + + + + + + + SODIUM_CRYPTO_AUTH_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_SEALBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_SECRETKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_PUBLICKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_KEYPAIRBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_MACBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_NONCEBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_BOX_SEEDBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KDF_BYTES_MIN + (int) + + + + + + + + + SODIUM_CRYPTO_KDF_BYTES_MAX + (int) + + + + + + + + + SODIUM_CRYPTO_KDF_CONTEXTBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KDF_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KX_SEEDBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KX_SESSIONKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KX_PUBLICKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KX_SECRETKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_KX_KEYPAIRBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_GENERICHASH_BYTES + (int) + + + + + + + + + SODIUM_CRYPTO_GENERICHASH_BYTES_MIN + (int) + + + + + + + + + SODIUM_CRYPTO_GENERICHASH_BYTES_MAX + (int) + + + + + + + + + SODIUM_CRYPTO_GENERICHASH_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN + (int) + + + + + + + + + SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13 + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13 + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_ALG_DEFAULT + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SALTBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_STRPREFIX + (string) + + + + + + + + + SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_SALTBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_STRPREFIX + (string) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_INTERACTIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_INTERACTIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_SENSITIVE + (int) + + + + + + + + + SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_SENSITIVE + (int) + + + + + + + + + SODIUM_CRYPTO_CORE_RISTRETTO255_BYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_CORE_RISTRETTO255_HASHBYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_CORE_RISTRETTO255_NONREDUCEDSCALARBYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_CORE_RISTRETTO255_SCALARBYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_SCALARMULT_BYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SCALARMULT_SCALARBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SCALARMULT_RISTRETTO255_BYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_SCALARMULT_RISTRETTO255_SCALARBYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_SHORTHASH_BYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SHORTHASH_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SECRETBOX_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SECRETBOX_MACBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SIGN_BYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SIGN_SEEDBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SIGN_SECRETKEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_SIGN_KEYPAIRBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_STREAM_NONCEBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_STREAM_KEYBYTES + (int) + + + + + + + + + SODIUM_CRYPTO_STREAM_XCHACHA20_KEYBYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES + (int) + + + + Available as of PHP 8.1.0. + + + + + + + + diff --git a/reference/sodium/reference.xml b/reference/sodium/reference.xml new file mode 100644 index 000000000..cbf43a9f2 --- /dev/null +++ b/reference/sodium/reference.xml @@ -0,0 +1,31 @@ + + + + + + Sodium &Functions; + + &reference.sodium.entities.functions; + + + + diff --git a/reference/sodium/setup.xml b/reference/sodium/setup.xml new file mode 100644 index 000000000..49a6aad79 --- /dev/null +++ b/reference/sodium/setup.xml @@ -0,0 +1,81 @@ + + + + + + &reftitle.setup; + +
+ &reftitle.required; + + This extension requires libsodium + ≥ 1.0.8. + +
+ +
+ &reftitle.install; + + As of PHP 7.2.0 this extension is bundled with PHP. For older PHP versions + this extension is available via PECL. + + +
+ Linux Systems + + In order to use this extension you must compile PHP with sodium support by + using the configure + option. + +
+ +
+ Windows + + In order to use this extension you have to add + extension=php_sodium.dll to &php.ini;. + +
+ +
+ Installation via PECL + + &pecl.info; + &url.pecl.package;libsodium + +
+ +
+ +
+ &reftitle.runtime; + &no.config; +
+ +
+ &reftitle.resources; + &no.resource; +
+ +
+ + diff --git a/reference/sodium/sodiumexception.xml b/reference/sodium/sodiumexception.xml new file mode 100644 index 000000000..0f9cbe41b --- /dev/null +++ b/reference/sodium/sodiumexception.xml @@ -0,0 +1,80 @@ + + + + + + + The SodiumException class + SodiumException + + + + +
+ &reftitle.intro; + + Exceptions thrown by the sodium functions. + +
+ + +
+ &reftitle.classsynopsis; + + + + + SodiumException + + + + + SodiumException + + + + extends + Exception + + + + &InheritedProperties; + + + + + &InheritedMethods; + + + + + + + + + +
+ +
+ +
+