sodium_crypto_secretstream_xchacha20poly1305_push
Encrypt a chunk of data so that it can safely be decrypted in a streaming API
Description
string sodium_crypto_secretstream_xchacha20poly1305_push(
string &$state,
#[\SensitiveParameter]string $message,
string $additional_data = "",
int $tag = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE
)
Parameters
-
state
-
See sodium_crypto_secretstream_xchacha20poly1305_init_pull
and sodium_crypto_secretstream_xchacha20poly1305_init_push
-
message
-
-
additional_data
-
-
tag
-
Optional. Can be used to assert decryption behavior
(i.e. re-keying or indicating the final chunk in a stream).
-
SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE:
the most common tag, that doesn't add any information about the nature of the message.
-
SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL:
indicates that the message marks the end of the stream, and erases the secret key used to encrypt the previous sequence.
-
SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH:
indicates that the message marks the end of a set of messages, but not the end of the stream.
For example, a huge JSON string sent as multiple chunks can use this tag to indicate to the application that the
string is complete and that it can be decoded. But the stream itself is not closed, and more data may follow.
-
SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY:
"forget" the key used to encrypt this message and the previous ones, and derive a new secret key.
Return Values
Returns the encrypted ciphertext.