rishi/scryer-prolog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: Improve descriptions to make clear what encoding(octet) means.

Browse Source 
In particular, octet does *not* mean that the input is a list of
Prolog bytes in the sense of "integers between 0..255", but that the
character codes are used directly as byte values.
This commit is contained in:
Markus Triska
2024-03-16 20:24:44 +01:00
parent 6f7f979c05
commit 4ebdd97ad3
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/lib/crypto.pl
View File

@@ -217,7 +217,8 @@ crypto_random_byte(B) :- '$crypto_random_byte'(B).
% %
% - `encoding(+Encoding)` % - `encoding(+Encoding)`
% The default encoding is `utf8`. The alternative is `octet`, to % The default encoding is `utf8`. The alternative is `octet`, to
% treat the input as a list of raw bytes. % use the character code of each character in Data as a byte
% value.
% %
% - `hmac(+Key)` % - `hmac(+Key)`
% Compute a hash-based message authentication code (HMAC) using % Compute a hash-based message authentication code (HMAC) using
@@ -334,7 +335,8 @@ hash_algorithm(blake2b512).
% default is all zeroes. % default is all zeroes.
% - `encoding(+Encoding)` % - `encoding(+Encoding)`
% The default encoding is `utf8`. The alternative is `octet`, % The default encoding is `utf8`. The alternative is `octet`,
% to treat the input as a list of raw bytes. % to use the character code of each character in Data as a byte
% value.
% %
% The `info/1` option can be used to generate multiple keys from a % The `info/1` option can be used to generate multiple keys from a
% single master key, using for example values such as "key" and % single master key, using for example values such as "key" and
@@ -540,8 +542,9 @@ bytes_base64(Bytes, Base64) :-
% Options: % Options:
% %
% - `encoding(+Encoding)` % - `encoding(+Encoding)`
% Encoding to use for PlainText. Default is utf8. The alternative % Encoding to use for PlainText. The default is `utf8`. The
% is octet to treat PlainText as raw bytes. % alternative is `octet`, to use the character code of each
% character in PlainText as a byte value.
% %
% - `tag(-List)` % - `tag(-List)`
% For authenticated encryption schemes, List is unified with a % For authenticated encryption schemes, List is unified with a
@@ -627,8 +630,9 @@ algorithm_key_iv('chacha20-poly1305', Key, IV) :-
% Options is a list of: % Options is a list of:
% %
% - `encoding(+Encoding)` % - `encoding(+Encoding)`
% Encoding to use for PlainText. The default is utf8. The % Encoding to use for PlainText. The default is `utf8`. The
% alternative is octet, which is used if the data are raw bytes. % alternative is `octet`, to obtain a list of characters where each
% character code corresponds to a decrypted octet of CipherText.
% %
% - `tag(+Tag)` % - `tag(+Tag)`
% For authenticated encryption schemes, the tag must be specified as % For authenticated encryption schemes, the tag must be specified as
@@ -911,7 +915,8 @@ ed25519_sign(KeyPair, Data0, Signature, Options) :-
% %
% - `encoding(+Encoding)` % - `encoding(+Encoding)`
% The default encoding of Data is `utf8`. The alternative is `octet`, % The default encoding of Data is `utf8`. The alternative is `octet`,
% which treats Data as a list of raw bytes. % to use the character code of each character in Data as a byte
% value.
ed25519_verify(Key, Data0, Signature0, Options) :- ed25519_verify(Key, Data0, Signature0, Options) :-
must_be_octet_chars(Key, ed25519_verify/4), must_be_octet_chars(Key, ed25519_verify/4),