Crypto Storage and LoginWithNewDevice and LoginWithPreviouslyAddedDevice APIs

This MR includes the crypto storage and implementation of two manually written APIs LoginWithNewDevice and LoginWithPreviouslyAddedDevice.

Please check the storage spec at cpp/src/vereign/kvstore/README.md.

Brief description of the packages:

vereign::bytes

Contains two components bytes::View and bytes::Buffer.

The bytes::View is used for read only access of memory of bytes. It is typically used in functions/methods as input.

The bytes::Buffer is dynamically expandable buffer for write access to memory of bytes. It is typically used in functions/methods as output.

bytes::View and bytes::Buffer are used consistently in all functions/methods that work with input/output of bytes. For example they are used in all storage and crypto related APIs.

NOTE: Do you think that we should add extra security, by creating a modification of the bytes::Buffer, a bytes::CryptoBuffer where all the memory upon release or reallocation is zeroed so that no sensitive information stays in the memory once it is not used.

vereign::encoding

• vereign::encoding::binary encoding/decoding integer (in little endian) and bytes. It is used for encoding the encrypted values in the crypto storage.

• vereign::encoding::base64 base64 encoding/decoding.

• vereign::encoding::hex hexadecimal encoding/decoding.

vereign::fs

Some cross-platform filesystem related utilities like joining paths, creating temporary directory etc.

vereign::crypto

A thin layer on top of OpenSSL, currently used by the crypto storage.

Most of the implementation of the crypto storage is with these routines. Only small part of generating the master key is different under windows where the vereign::ncrypt is used.

• vereign::rand - crypto random generation of bytes.
• vereign::crypto::aes - AES encryption/decryption.
• vereign::crypto::rsa - RSA key generation, encryption/decryption, export/import in PEM format.
• vereign::crypto::digest - currently only sha1 hashing.

vereign::ncrypt

A thin layer on top of Windows native crypto API. Used in the crypto storage for master key generation under Windows.

• vereign::ncrypt::rsa - RSA persistent key generation, encryption/decryption.

vereign::sqlite

sqlite client. It is used by the key/value abstraction in the vereign::kvstore.

vereign::kvstore

• vereign::kvstore::Storage - a key value abstraction interface.
• vereign::kvstore::SqliteStorage - implementation of the Storage interface by using vereign::sqlite client.
• vereign::kvstore::CryptoStorage - the crypto storage that uses a key/value backend that implements the Storage interface. It is design with the so called pimpl idiom and has two different implementations for linux and windows - vereign/kvstore/detail/linux_crypto_storage.hh and vereign/kvstore/detail/linux_crypto_storage.hh.

vereign::identity

• vereign::identity::provider - the local identity manager that uses the crypto storage to create the device keys. It is used by the vereign::service layer, currently it is used by the vereign::service::IdentityService.

vereign::service::IdentityService

Implements two new manually written APIs LoginWithNewDevice and LoginWithPreviouslyAddedDevice.

vereign::grpc::IdentityAPI

The grpc layer provided to the integrators that uses the vereign::service::IdentityService.

cpp/include/vereign/vereign.h

-#ifndef VEREIGN_VEREIGN_H_
-#define VEREIGN_VEREIGN_H_
+#ifndef __VEREIGN_VEREIGN_H
+#define __VEREIGN_VEREIGN_H
 
 #ifdef _WIN32
   #ifdef WIN_EXPORT
@@ -84,8 +84,12 @@ typedef struct vereign_service vereign_service;
  * **NOTE: On failure the `err` object must be freed with vereign_error_free method.**
  *
  * @param listen_address gRPC listen address, for example "localhost:".
- * @param vereignHost Vereign restapi host.
- * @param vereignPort Vereign restapi port - https, 443...
+ * @param vereign_host Vereign restapi host.
+ * @param vereign_port Vereign restapi port - https, 443...
+ * @param storage_path Full path to directory where the storage files will stay.
+ *    If the `storage_path` is `nullptr`, a default will be used. Under linux this default is
+ *    `$HOME/vereign`, and under windows it is `C:\Users\<user>\AppData\Local\vereign`.
+ *
  * @param err On failure err is initialized with the reason of the failure,
  *    otherwise err is set to nullptr.
  * @returns vereign_service object if the gRPC is up and running, otherwise returns nullptr.
@@ -94,8 +98,7 @@ PUBLIC_API vereign_service* vereign_service_start(
   const char* listen_address,
   const char* vereign_host,
   const char* vereign_port,
-  // FIXME: public_key must come from a storage internally.
-  const char* public_key,
+  const char* storage_path,
   vereign_error** err
 );
 
@@ -122,4 +125,4 @@ PUBLIC_API void vereign_service_shutdown(vereign_service* service);
 };
 #endif
 
-#endif // VEREIGN_VEREIGN_H_
+#endif // __VEREIGN_VEREIGN_H