diff options
| author | Sven Gothel <[email protected]> | 2022-08-08 17:25:25 +0200 |
|---|---|---|
| committer | Sven Gothel <[email protected]> | 2022-08-08 17:25:25 +0200 |
| commit | a33b0fc3931e5e7f28e30aa7571513780698631c (patch) | |
| tree | a6fadcdb0a7498f60a9967835af1bab02a88a0a1 | |
| parent | 984b904ee7024e4d38515e3026288131e470580b (diff) | |
API doc: Cipherpack Data Stream: Fix quoting and encrypted_data length description
| -rw-r--r-- | include/cipherpack/cipherpack.hpp | 14 | ||||
| -rw-r--r-- | java/org/cipherpack/Cipherpack.java | 14 |
2 files changed, 14 insertions, 14 deletions
diff --git a/include/cipherpack/cipherpack.hpp b/include/cipherpack/cipherpack.hpp index e340215..155e9a7 100644 --- a/include/cipherpack/cipherpack.hpp +++ b/include/cipherpack/cipherpack.hpp @@ -107,12 +107,12 @@ namespace cipherpack { * ASN1_Type::OctetString subject // optional subject of message, user application specific. * ASN1_Type::OctetString plaintext_version // version of this plaintext message, user application specific. * ASN1_Type::OctetString plaintext_version_parent // version of this plaintext message's preceding message, user application specific. - * ASN1_Type::OctetString pk_type // public-key type. Default "RSA". - * ASN1_Type::OctetString pk_fingerprt_hash_algo // public-key fingerprint hash. Default "SHA-256". - * ASN1_Type::OctetString pk_enc_padding_algo // public-key encryption padding. Default "OAEP". - * ASN1_Type::OctetString pk_enc_hash_algo // public-key encryption hash. Default "SHA-256". - * ASN1_Type::OctetString pk_sign_algo // public-key signature algorithm. Default "EMSA1(SHA-256)". - * ASN1_Type::ObjectId sym_enc_mac_oid // symmetric-key encryption+MAC algorithm. Default "ChaCha20Poly1305". + * ASN1_Type::OctetString pk_type // public-key type. Default `RSA`. + * ASN1_Type::OctetString pk_fingerprt_hash_algo // public-key fingerprint hash. Default `SHA-256`. + * ASN1_Type::OctetString pk_enc_padding_algo // public-key encryption padding. Default `OAEP`. + * ASN1_Type::OctetString pk_enc_hash_algo // public-key encryption hash. Default `SHA-256`. + * ASN1_Type::OctetString pk_sign_algo // public-key signature algorithm. Default `EMSA1(SHA-256)`. + * ASN1_Type::ObjectId sym_enc_mac_oid // symmetric-key encryption+MAC algorithm. Default `ChaCha20Poly1305`. * ASN1_Type::OctetString fingerprt_sender // fingerprint of public sender key used for header signature * ASN1_Type::Integer receiver_count, // number of receiver triples { fingerprint, encrypted-symmetric-keys, encrypted-nonce } * } @@ -129,7 +129,7 @@ namespace cipherpack { * DER Header 2 { * ASN1_Type::OctetString sign_sender // sender's signature over whole header, matching fingerprt_sender * }, - * uint8_t encrypted_data[content_size] // the encrypted message, content_size bytes + * uint8_t encrypted_data[ciphertext_size] // the encrypted message, `ciphertext_size` bytes resulting to `plaintext_size` plaintext message * ``` * * @see encryptThenSign() diff --git a/java/org/cipherpack/Cipherpack.java b/java/org/cipherpack/Cipherpack.java index 704f442..3661887 100644 --- a/java/org/cipherpack/Cipherpack.java +++ b/java/org/cipherpack/Cipherpack.java @@ -95,12 +95,12 @@ import org.jau.util.BasicTypes; * ASN1_Type::OctetString subject // optional subject of message, user application specific. * ASN1_Type::OctetString plaintext_version // version of this plaintext message, user application specific. * ASN1_Type::OctetString plaintext_version_parent // version of this plaintext message's preceding message, user application specific. - * ASN1_Type::OctetString pk_type // public-key type. Default "RSA". - * ASN1_Type::OctetString pk_fingerprt_hash_algo // public-key fingerprint hash. Default "SHA-256". - * ASN1_Type::OctetString pk_enc_padding_algo // public-key encryption padding. Default "OAEP". - * ASN1_Type::OctetString pk_enc_hash_algo // public-key encryption hash. Default "SHA-256". - * ASN1_Type::OctetString pk_sign_algo // public-key signature algorithm. Default "EMSA1(SHA-256)". - * ASN1_Type::ObjectId sym_enc_mac_oid // symmetric-key encryption+MAC algorithm. Default "ChaCha20Poly1305". + * ASN1_Type::OctetString pk_type // public-key type. Default `RSA`. + * ASN1_Type::OctetString pk_fingerprt_hash_algo // public-key fingerprint hash. Default `SHA-256`. + * ASN1_Type::OctetString pk_enc_padding_algo // public-key encryption padding. Default `OAEP`. + * ASN1_Type::OctetString pk_enc_hash_algo // public-key encryption hash. Default `SHA-256`. + * ASN1_Type::OctetString pk_sign_algo // public-key signature algorithm. Default `EMSA1(SHA-256)`. + * ASN1_Type::ObjectId sym_enc_mac_oid // symmetric-key encryption+MAC algorithm. Default `ChaCha20Poly1305`. * ASN1_Type::OctetString fingerprt_sender // fingerprint of public sender key used for header signature * ASN1_Type::Integer receiver_count, // number of receiver triples { fingerprint, encrypted-symmetric-keys, encrypted-nonce } * } @@ -117,7 +117,7 @@ import org.jau.util.BasicTypes; * DER Header 2 { * ASN1_Type::OctetString sign_sender // sender's signature over whole header, matching fingerprt_sender * }, - * uint8_t encrypted_data[content_size] // the encrypted message, content_size bytes + * uint8_t encrypted_data[ciphertext_size] // the encrypted message, `ciphertext_size` bytes resulting to `plaintext_size` plaintext message * ``` * * @see encryptThenSign() |