diff --git a/README.md b/README.md index 92bafcd..6d611bc 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Android Native Development Kit is also supported; see [libsaltpack-jni](https:// Documentation ------------- -The classes documentation can be found here: [https://gherynos.github.io/libsaltpack/annotated.html](https://gherynos.github.io/libsaltpack/annotated.html). +The classes documentation can be found here: [https://libsaltpack.nharyes.net/annotated.html](https://libsaltpack.nharyes.net/annotated.html). Examples -------- diff --git a/docs/_armored_input_stream_8h_source.html b/docs/_armored_input_stream_8h_source.html index af68907..d1427cf 100644 --- a/docs/_armored_input_stream_8h_source.html +++ b/docs/_armored_input_stream_8h_source.html @@ -1,14 +1,16 @@ - +
- - + ++ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
▼Nsaltpack | The saltpack library namespace | ||||||||||||||||||||||||||
CArmoredInputStream | Input Stream to parse BaseX armored content |
▼Nsaltpack | The saltpack library namespace |
CArmoredInputStream | Input Stream to parse BaseX armored content |
CArmoredOutputStream | Output Stream to generate BaseX armored content |
CMessageReader | The class used to decrypt or verify a message |
CMessageReader | The class used to decrypt or verify a message |
CMessageWriter | The class used to encrypt or sign a message |
CSaltpackException | Saltpack exception |
CSaltpackException | Saltpack exception |
CUtils | Utilities class |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
|
-ArmoredOutputStream (saltpack) | -MessageWriter (saltpack) | -
|
-|||
|
-
|
-|||||
ArmoredInputStream (saltpack) | -Utils (saltpack) | -|||||
MessageReader (saltpack) | -SaltpackException (saltpack) | -|||||
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
This is the complete list of members for saltpack::ArmoredInputStream, including all inherited members.
ArmoredInputStream(std::istream &in, const std::string &app) | saltpack::ArmoredInputStream | |
ArmoredInputStream(std::istream &in) | saltpack::ArmoredInputStream | explicit |
ArmoredInputStream(std::istream &in) | saltpack::ArmoredInputStream | explicit |
underflow() override | saltpack::ArmoredInputStream | |
~ArmoredInputStream() override | saltpack::ArmoredInputStream | |
~ArmoredInputStream() override | saltpack::ArmoredInputStream |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
Input Stream to parse BaseX armored content. - More...
+ More...#include <ArmoredInputStream.h>
+Public Member Functions | ArmoredInputStream (std::istream &in, const std::string &app) | | | ArmoredInputStream (std::istream &in) | | | ~ArmoredInputStream () override | | int | underflow () override | | ArmoredInputStream (std::istream &in, const std::string &app) | ArmoredInputStream (std::istream &in) | ~ArmoredInputStream () override | int | underflow () override |
Input Stream to parse BaseX armored content.
The alphabet used is BASE62.
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
This is the complete list of members for saltpack::ArmoredOutputStream, including all inherited members.
ArmoredOutputStream(std::ostream &out, const std::string &app, int mode, int lettersInWords, int wordsInPhrase) | saltpack::ArmoredOutputStream | |
ArmoredOutputStream(std::ostream &out, const std::string &app, int mode) | saltpack::ArmoredOutputStream | |
ArmoredOutputStream(std::ostream &out, const std::string &app, int mode) | saltpack::ArmoredOutputStream | |
ArmoredOutputStream(std::ostream &out, int mode, int lettersInWords, int wordsInPhrase) | saltpack::ArmoredOutputStream | |
ArmoredOutputStream(std::ostream &out, int mode) | saltpack::ArmoredOutputStream | |
ArmoredOutputStream(std::ostream &out, int mode) | saltpack::ArmoredOutputStream | |
finalise() | saltpack::ArmoredOutputStream | |
overflow(int __c) override | saltpack::ArmoredOutputStream | |
overflow(int c) override | saltpack::ArmoredOutputStream | |
~ArmoredOutputStream() override | saltpack::ArmoredOutputStream |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
Output Stream to generate BaseX armored content. - More...
+ More...#include <ArmoredOutputStream.h>
+Public Member Functions | ArmoredOutputStream (std::ostream &out, const std::string &app, int mode, int lettersInWords, int wordsInPhrase) | | | ArmoredOutputStream (std::ostream &out, const std::string &app, int mode) | | | ArmoredOutputStream (std::ostream &out, int mode, int lettersInWords, int wordsInPhrase) | | | ArmoredOutputStream (std::ostream &out, int mode) | | | ~ArmoredOutputStream () override | | int | overflow (int __c) override | | void | finalise () | int | overflow (int c) override | | | ArmoredOutputStream (std::ostream &out, const std::string &app, int mode, int lettersInWords, int wordsInPhrase) | ArmoredOutputStream (std::ostream &out, const std::string &app, int mode) | ArmoredOutputStream (std::ostream &out, int mode, int lettersInWords, int wordsInPhrase) | ArmoredOutputStream (std::ostream &out, int mode) | ~ArmoredOutputStream () override | void | finalise () |
Output Stream to generate BaseX armored content.
The alphabet used is BASE62.
__c | the next character to output. |
c | the next character to output. |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
This is the complete list of members for saltpack::MessageReader, including all inherited members.
getBlock() | saltpack::MessageReader | |
getRecipients() | saltpack::MessageReader | |
getRecipients() | saltpack::MessageReader | |
getSender() | saltpack::MessageReader | |
hasMoreBlocks() | saltpack::MessageReader | |
hasMoreBlocks() | saltpack::MessageReader | |
isIntentionallyAnonymous() | saltpack::MessageReader | |
MessageReader(std::istream &is, const BYTE_ARRAY &recipientSecretkey) | saltpack::MessageReader | |
MessageReader(std::istream &is, const BYTE_ARRAY &recipientSecretkey) | saltpack::MessageReader | |
MessageReader(std::istream &is) | saltpack::MessageReader | explicit |
MessageReader(std::istream &is, std::istream &messageStream) | saltpack::MessageReader | |
MessageReader(std::istream &is, std::istream &messageStream) | saltpack::MessageReader | |
MessageReader(std::istream &is, const BYTE_ARRAY &recipientSecretkey, const std::pair< BYTE_ARRAY, BYTE_ARRAY > &symmetricKey) | saltpack::MessageReader | |
~MessageReader() override | saltpack::MessageReader | |
~MessageReader() override | saltpack::MessageReader |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
The class used to decrypt or verify a message. - More...
+ More...#include <MessageReader.h>
+Public Member Functions | MessageReader (std::istream &is, const BYTE_ARRAY &recipientSecretkey) | | | MessageReader (std::istream &is) | | | MessageReader (std::istream &is, std::istream &messageStream) | | | MessageReader (std::istream &is, const BYTE_ARRAY &recipientSecretkey, const std::pair< BYTE_ARRAY, BYTE_ARRAY > &symmetricKey) | | | ~MessageReader () override | | BYTE_ARRAY | getBlock () | | bool | hasMoreBlocks () | | std::list< BYTE_ARRAY > | getRecipients () | | BYTE_ARRAY | getSender () | std::list< BYTE_ARRAY > | getRecipients () | | | bool | isIntentionallyAnonymous () | | MessageReader (std::istream &is, const BYTE_ARRAY &recipientSecretkey) | MessageReader (std::istream &is) | MessageReader (std::istream &is, std::istream &messageStream) | MessageReader (std::istream &is, const BYTE_ARRAY &recipientSecretkey, const std::pair< BYTE_ARRAY, BYTE_ARRAY > &symmetricKey) | ~MessageReader () override | BYTE_ARRAY | getBlock () | bool | hasMoreBlocks () | BYTE_ARRAY | getSender () | bool | isIntentionallyAnonymous () |
The class used to decrypt or verify a message.
Use it in conjunction with ArmoredInputStream to process armored BaseX input.
std::list<BYTE_ARRAY> saltpack::MessageReader::getRecipients | +std::list< BYTE_ARRAY > saltpack::MessageReader::getRecipients | ( | -) | +) |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
This is the complete list of members for saltpack::MessageWriter, including all inherited members.
addBlock(BYTE_ARRAY data, bool final) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const std::list< BYTE_ARRAY > &recipients) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const BYTE_ARRAY &senderSecretkey, bool detatchedSignature) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const BYTE_ARRAY &senderSecretkey, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY >> &symmetricKeys) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY >> &symmetricKeys) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const BYTE_ARRAY &senderSecretkey, bool detatchedSignature) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const BYTE_ARRAY &senderSecretkey, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY > > &symmetricKeys) | saltpack::MessageWriter | |
MessageWriter(std::ostream &os, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY > > &symmetricKeys) | saltpack::MessageWriter | |
~MessageWriter() override | saltpack::MessageWriter |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
The class used to encrypt or sign a message. - More...
+ More...#include <MessageWriter.h>
+Public Member Functions | MessageWriter (std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | | | MessageWriter (std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients) | | | MessageWriter (std::ostream &os, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | | | MessageWriter (std::ostream &os, const std::list< BYTE_ARRAY > &recipients) | | | MessageWriter (std::ostream &os, const BYTE_ARRAY &senderSecretkey, bool detatchedSignature) | | | MessageWriter (std::ostream &os, const BYTE_ARRAY &senderSecretkey, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY >> &symmetricKeys) | | | MessageWriter (std::ostream &os, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY >> &symmetricKeys) | | | ~MessageWriter () override | | MessageWriter (std::ostream &os, const BYTE_ARRAY &senderSecretkey, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY > > &symmetricKeys) | | | MessageWriter (std::ostream &os, const std::list< BYTE_ARRAY > &recipientsPublickeys, const std::list< std::pair< BYTE_ARRAY, BYTE_ARRAY > > &symmetricKeys) | | | void | addBlock (BYTE_ARRAY data, bool final) | | MessageWriter (std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | MessageWriter (std::ostream &os, BYTE_ARRAY senderSecretkey, const std::list< BYTE_ARRAY > &recipients) | MessageWriter (std::ostream &os, const std::list< BYTE_ARRAY > &recipients, bool visibleRecipients) | MessageWriter (std::ostream &os, const std::list< BYTE_ARRAY > &recipients) | MessageWriter (std::ostream &os, const BYTE_ARRAY &senderSecretkey, bool detatchedSignature) | ~MessageWriter () override | void | addBlock (BYTE_ARRAY data, bool final) |
The class used to encrypt or sign a message.
Use it in conjunction with ArmoredOutputStream to produce armored BaseX output.
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
This is the complete list of members for saltpack::SaltpackException, including all inherited members.
SaltpackException(const std::string &msg) (defined in saltpack::SaltpackException) | saltpack::SaltpackException | inlineexplicit |
what() const noexcept override (defined in saltpack::SaltpackException) | saltpack::SaltpackException | inline |
what() const noexcept override (defined in saltpack::SaltpackException) | saltpack::SaltpackException | inline |
~SaltpackException() noexcept override=default (defined in saltpack::SaltpackException) | saltpack::SaltpackException |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+Public Member Functions |
const char * | what () const noexcept override | | | + | SaltpackException (const std::string &msg) | + |
Saltpack exception.
@@ -101,9 +110,7 @@+ |
libsaltpack
|
@@ -29,21 +31,22 @@
This is the complete list of members for saltpack::Utils, including all inherited members.
baseXblockSize(const std::string &alphabet, int size) | saltpack::Utils | static |
baseXdecode(std::string data, const std::string &alphabet) | saltpack::Utils | static |
baseXdecode(std::string data, const std::string &alphabet) | saltpack::Utils | static |
baseXencode(const BYTE_ARRAY &data, std::string alphabet) | saltpack::Utils | static |
baseXencode(BYTE_ARRAY data, size_t size, std::string alphabet) | saltpack::Utils | static |
baseXencode(BYTE_ARRAY data, size_t size, std::string alphabet) | saltpack::Utils | static |
binToHex(BYTE_ARRAY bin) | saltpack::Utils | static |
deriveKeyFromPassword(unsigned long long int keySize, const std::string &password, BYTE_ARRAY salt, unsigned long long int opsLimit, size_t memLimit) | saltpack::Utils | static |
deriveKeyFromPassword(unsigned long long int keySize, const std::string &password, BYTE_ARRAY salt, unsigned long long int opsLimit, size_t memLimit) | saltpack::Utils | static |
derivePublickey(BYTE_ARRAY secretkey) | saltpack::Utils | static |
generateKeypair(BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | saltpack::Utils | static |
generateKeypair(BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | saltpack::Utils | static |
generateRandomBytes(size_t size) | saltpack::Utils | static |
generateSignKeypair(BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | saltpack::Utils | static |
generateSignKeypair(BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | saltpack::Utils | static |
hexToBin(const std::string &hex) | saltpack::Utils | static |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
Utilities class. - More...
+ More...#include <Utils.h>
+Static Public Member Functionsstatic void | generateKeypair (BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | | static void | generateSignKeypair (BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | | static BYTE_ARRAY | derivePublickey (BYTE_ARRAY secretkey) | | static int | baseXblockSize (const std::string &alphabet, int size) | | static std::string | baseXencode (const BYTE_ARRAY &data, std::string alphabet) | | static std::string | baseXencode (BYTE_ARRAY data, size_t size, std::string alphabet) | | static BYTE_ARRAY | baseXdecode (std::string data, const std::string &alphabet) | | static BYTE_ARRAY | hexToBin (const std::string &hex) | | static std::string | binToHex (BYTE_ARRAY bin) | | static BYTE_ARRAY | generateRandomBytes (size_t size) | | static BYTE_ARRAY | deriveKeyFromPassword (unsigned long long int keySize, const std::string &password, BYTE_ARRAY salt, unsigned long long int opsLimit, size_t memLimit) | | static void | generateKeypair (BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | static void | generateSignKeypair (BYTE_ARRAY &publickey, BYTE_ARRAY &secretkey) | static BYTE_ARRAY | derivePublickey (BYTE_ARRAY secretkey) | static int | baseXblockSize (const std::string &alphabet, int size) | static std::string | baseXencode (const BYTE_ARRAY &data, std::string alphabet) | static std::string | baseXencode (BYTE_ARRAY data, size_t size, std::string alphabet) | static BYTE_ARRAY | baseXdecode (std::string data, const std::string &alphabet) | static BYTE_ARRAY | hexToBin (const std::string &hex) | static std::string | binToHex (BYTE_ARRAY bin) | static BYTE_ARRAY | generateRandomBytes (size_t size) | static BYTE_ARRAY | deriveKeyFromPassword (unsigned long long int keySize, const std::string &password, BYTE_ARRAY salt, unsigned long long int opsLimit, size_t memLimit) |
Utilities class.
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+Directories | saltpack | |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+Files | |
ArmoredInputStream.h | |
ArmoredOutputStream.h | |
MessageReader.h | |
MessageWriter.h | |
modes.h | |
SaltpackException.h | |
types.h | |
Utils.h | |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
▼ include | |||||||||||||||||||||||||||
▼ saltpack |
▼ include | |
▼ saltpack | |
ArmoredInputStream.h | |
ArmoredOutputStream.h | |
ArmoredOutputStream.h | |
MessageReader.h | |
MessageWriter.h | |
MessageWriter.h | |
modes.h | |
SaltpackException.h | |
SaltpackException.h | |
types.h | |
Utils.h | |
Utils.h |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
▼CBase | |||||||||||||||||||||||||||
Csaltpack::MessageReader | The class used to decrypt or verify a message |
▼CBase | |
Csaltpack::MessageReader | The class used to decrypt or verify a message |
Csaltpack::MessageWriter | The class used to encrypt or sign a message |
▼Cexception | |
▼Cstd::exception | |
Csaltpack::SaltpackException | Saltpack exception |
▼Cistream | |
▼Cstd::istream | |
Csaltpack::ArmoredInputStream | Input Stream to parse BaseX armored content |
▼Costream | |
▼Cstd::ostream | |
Csaltpack::ArmoredOutputStream | Output Stream to generate BaseX armored content |
▼Cstreambuf | |
▼Cstd::streambuf | |
Csaltpack::ArmoredInputStream | Input Stream to parse BaseX armored content |
Csaltpack::ArmoredOutputStream | Output Stream to generate BaseX armored content |
Csaltpack::ArmoredOutputStream | Output Stream to generate BaseX armored content |
Csaltpack::Utils | Utilities class |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
A C++ implementation of saltpack.
@@ -74,7 +83,7 @@Copyright 2016-2020 Luca Zanconato (<luca.zanconato@naes.co>) +Copyright 2016-2024 Luca Zanconato (<github.com/gherynos>) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. @@ -88,12 +97,11 @@Copyright and license
See the License for the specific language governing permissions and limitations under the License.
+ |
libsaltpack
|
@@ -29,22 +31,28 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
Nsaltpack | The saltpack library namespace |
▼Nsaltpack | The saltpack library namespace |
CArmoredInputStream | Input Stream to parse BaseX armored content |
CArmoredOutputStream | Output Stream to generate BaseX armored content |
CMessageReader | The class used to decrypt or verify a message |
CMessageWriter | The class used to encrypt or sign a message |
CSaltpackException | Saltpack exception |
CUtils | Utilities class |
+ |
libsaltpack
|
@@ -29,21 +31,22 @@
The saltpack library namespace. -More...
+More...
+Classesclass | ArmoredInputStream | | Utilities class. More... | | |
+Typedefstypedef unsigned char | BYTE | | typedef std::vector< BYTE > | BYTE_ARRAY | | typedef unsigned char | BYTE | typedef std::vector< BYTE > | BYTE_ARRAY |
+Variablesconst int | MODE_ENCRYPTION = 0 | | const int | MODE_ATTACHED_SIGNATURE = 1 | | const int | MODE_DETACHED_SIGNATURE = 2 | | const int | MODE_SIGNCRYPTION = 3 | | const int | MODE_ENCRYPTION = 0 | const int | MODE_ATTACHED_SIGNATURE = 1 | const int | MODE_DETACHED_SIGNATURE = 2 | const int | MODE_SIGNCRYPTION = 3 |
The saltpack library namespace.
typedef unsigned char saltpack::BYTE | +typedef unsigned char saltpack::BYTE |
typedef std::vector<BYTE> saltpack::BYTE_ARRAY | +typedef std::vector<BYTE> saltpack::BYTE_ARRAY |
+ |
libsaltpack
|
@@ -29,22 +31,28 @@