virgil-crypto 2.0.2b0

data/ext/native/src/lib/include/virgil/crypto/foundation/VirgilSymmetricCipher.h

@@ -0,0 +1,305 @@
+/**
+ * Copyright (C) 2015-2016 Virgil Security Inc.
+ *
+ * Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     (1) Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *     (2) Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *     (3) Neither the name of the copyright holder nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef VIRGIL_CRYPTO_SYMMETRIC_SIPHER_H
+#define VIRGIL_CRYPTO_SYMMETRIC_SIPHER_H
+
+#include <memory>
+#include <string>
+
+#include <virgil/crypto/VirgilByteArray.h>
+#include <virgil/crypto/foundation/asn1/VirgilAsn1Compatible.h>
+
+namespace virgil { namespace crypto { namespace foundation {
+
+/**
+ * @brief Provides symmetric ciphers algorithms.
+ * @ingroup Cipher
+ */
+class VirgilSymmetricCipher : public virgil::crypto::foundation::asn1::VirgilAsn1Compatible {
+public:
+    /**
+     * @name Additional types
+     */
+    ///@{
+    /**
+     * @brief Padding modes for the symmetric cipher.
+     */
+    enum class Padding {
+        PKCS7 = 0,   ///< Padding mode: PKCS7 padding (default)
+        OneAndZeros, ///< Padding mode: ISO/IEC 7816-4 padding
+        ZerosAndLen, ///< Padding mode: ANSI X.923 padding
+        Zeros,       ///< Padding mode: zero padding (not reversible!)
+        None         ///< Padding mode: never pad (full blocks only)
+    };
+
+    /**
+     * Enumerates possible Symmetric Cipher algorithms.
+     */
+    enum class Algorithm {
+        AES_256_CBC, ///< Cipher algorithm: AES-256, mode: CBC
+        AES_256_GCM  ///< Cipher algorithm: AES-256, mode: GCM
+    };
+    ///@}
+
+public:
+
+    /**
+     * @brief Create object with undefined algorithm.
+     * @warning SHOULD be used in conjunction with VirgilAsn1Compatible interface,
+     *     i.e. VirgilSymmetricCipher cipher; cipher.fromAsn1(asn1);
+     */
+    VirgilSymmetricCipher();
+
+    /**
+     * @brief Create object with specific algorithm type.
+     */
+    explicit VirgilSymmetricCipher(Algorithm algorithm);
+
+    /**
+     * @brief Create object with given algorithm name.
+     * @note Name format: {ALG}-{LEN}-{MODE}, i.e AES-256-GCM.
+     */
+    explicit VirgilSymmetricCipher(const std::string& name);
+
+    /**
+     * @brief Create object with given algorithm name.
+     * @note Name format: {ALG}-{LEN}-{MODE}, i.e AES-256-GCM.
+     */
+    explicit VirgilSymmetricCipher(const char* name);
+    ///@}
+    /**
+     * @name Info
+     */
+    ///@{
+    /**
+     * @brief Returns the name of the given cipher, as a string.
+     */
+    std::string name() const;
+
+    /**
+     * @brief Returns the block size of the current cipher.
+     * @return block size, in octets.
+     */
+    size_t blockSize() const;
+
+    /**
+     * @brief Returns the size of the cipher's IV in octets.
+     */
+    size_t ivSize() const;
+
+    /**
+     * @brief Returns the key length of the cipher.
+     * @return key length, in bits.
+     */
+    size_t keySize() const;
+
+    /**
+     * @brief Returns the key length of the cipher.
+     * @return key length, in octets.
+     */
+    size_t keyLength() const;
+
+    /**
+     * @brief Returns the authentication tag length of the cipher.
+     * @return tag length, in octets.
+     */
+    size_t authTagLength() const;
+
+    /**
+     * @brief Returns true if cipher is in the encryption mode.
+     */
+    bool isEncryptionMode() const;
+
+    /**
+     * @brief Returns true if cipher is in the decryption mode.
+     */
+    bool isDecryptionMode() const;
+
+    /**
+     * @brief Returns true if cipher is configured to support authenticated encryption and decryption.
+     */
+    bool isAuthMode() const;
+
+    /**
+     * @brief Returns true if cipher support padding.
+     */
+    bool isSupportPadding() const;
+
+    /**
+     * @brief Return cipher IV, or NONCE_COUNTER for CTR-mode ciphers
+     */
+    VirgilByteArray iv() const;
+    ///@}
+
+    /**
+     * @name Configuration
+     */
+    ///@{
+    /**
+     * @brief Configures encryption key.
+     *
+     * Configures cipher to be used in encryption mode with given key.
+     * @warning Only one key CAN be set.
+     */
+    void setEncryptionKey(const virgil::crypto::VirgilByteArray& key);
+
+    /**
+     * @brief Configures decryption key.
+     *
+     * Configures cipher to be used in decryption mode with given key.
+     * @warning Only one key CAN be set.
+     */
+    void setDecryptionKey(const virgil::crypto::VirgilByteArray& key);
+
+    /**
+     * @brief Defines padding mode.
+     *
+     * Default value is PKCS7.
+     * @note This parameter is used only for cipher modes that use padding.
+     * @see isSupportPadding()
+     */
+    void setPadding(VirgilSymmetricCipher::Padding padding);
+
+    /**
+     * @brief Configures the initialization vector.
+     */
+    void setIV(const virgil::crypto::VirgilByteArray& iv);
+
+    /**
+     * @brief Add additional data (for AEAD ciphers).
+     * @note Currently only supported with GCM.
+     * @note Must be called before reset().
+     * @see isAuthMode()
+     */
+    void setAuthData(const virgil::crypto::VirgilByteArray& authData);
+
+    /**
+     * @brief Finish preparation before encryption / decryption.
+     */
+    void reset();
+
+    /**
+     * @brief Clear all configuration settings.
+     * @note This method SHOULD be used if class instance was used for encryption
+     *           and then will be used for decryption, and vice versa.
+     */
+    void clear();
+    ///@}
+    /**
+     * @name Generic Encryption / Decryption
+     */
+    ///@{
+    /**
+     * @brief Generic all-in-one encryption / decryption.
+     *
+     * Encrypts or decrypts given data.
+     * @param input - data to be encrypted / decrypted.
+     * @param iv - initialization vector.
+     * @return Encrypted or decrypted bytes (rely on the current mode).
+     */
+    virgil::crypto::VirgilByteArray crypt(
+            const virgil::crypto::VirgilByteArray& input,
+            const virgil::crypto::VirgilByteArray& iv);
+    ///@}
+    /**
+     * @name Sequence Encryption / Decryption
+     */
+    ///@{
+    /**
+     * @brief Generic cipher update function.
+     *
+     * Encrypts or decrypts given data.
+     * Writes as many block size'd blocks of data as possible to output.
+     * Any data that cannot be written immediately will either be added to the next block,
+     *     or flushed when finish is called.
+     * @return Encrypted or decrypted bytes (rely on the current mode).
+     */
+    virgil::crypto::VirgilByteArray update(const virgil::crypto::VirgilByteArray& input);
+
+    /**
+     * @brief Cipher finalization method.
+     *
+     * If data still needs to be flushed from an incomplete block,
+     *     data contained within it will be padded with the size of the last block,
+     *     and will be returned.
+     * @return Encrypted or decrypted bytes (rely on the current mode).
+     */
+    virgil::crypto::VirgilByteArray finish();
+    ///@}
+    /**
+     * @name VirgilAsn1Compatible implementation
+     */
+    ///@{
+    size_t asn1Write(
+            virgil::crypto::foundation::asn1::VirgilAsn1Writer& asn1Writer,
+            size_t childWrittenBytes = 0) const override;
+
+    void asn1Read(virgil::crypto::foundation::asn1::VirgilAsn1Reader& asn1Reader) override;
+    ///@}
+public:
+    //! @cond Doxygen_Suppress
+    VirgilSymmetricCipher(VirgilSymmetricCipher&& rhs) noexcept;
+
+    VirgilSymmetricCipher& operator=(VirgilSymmetricCipher&& rhs) noexcept;
+
+    virtual ~VirgilSymmetricCipher() noexcept;
+    //! @endcond
+
+private:
+    /**
+     * @brief If internal state is not initialized with specific algorithm exception will be thrown.
+     */
+    void checkState() const;
+
+private:
+    class Impl;
+
+    std::unique_ptr<Impl> impl_;
+};
+
+}}}
+
+namespace std {
+/**
+ * @brief Returns string representation of the Hash algorithm.
+ * @return Symmetric cipher algorithm as string.
+ * @ingroup Cipher
+ */
+string to_string(virgil::crypto::foundation::VirgilSymmetricCipher::Algorithm alg);
+}
+
+#endif /* VIRGIL_CRYPTO_SYMMETRIC_SIPHER_H */

data/ext/native/src/lib/include/virgil/crypto/foundation/VirgilSystemCryptoError.h

@@ -0,0 +1,149 @@
+/**
+ * Copyright (C) 2015-2016 Virgil Security Inc.
+ *
+ * Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     (1) Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *     (2) Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *     (3) Neither the name of the copyright holder nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef VIRGIL_SYSTEM_CRYPTO_ERROR_H
+#define VIRGIL_SYSTEM_CRYPTO_ERROR_H
+
+#include <system_error>
+
+#include <virgil/crypto/VirgilCryptoError.h>
+
+namespace virgil { namespace crypto { namespace foundation {
+
+/**
+ * @brief Error category that handles error codes from the system crypto library.
+ * @ingroup Error
+ */
+class VirgilSystemCryptoErrorCategory : public std::error_category {
+public:
+    /**
+     * @brief Return name of the system crypto category.
+     * @return Name of the system crypto category.
+     */
+    const char* name() const noexcept override;
+
+    /**
+     * @brief Return description for the given error code.
+     * @param ev Error code.
+     * @return Error Description.
+     */
+    std::string message(int ev) const noexcept override;
+};
+
+/**
+ * @brief Return singleton instance of the system crypto error category.
+ * @return Instance of the syste, crypto error categoty.
+ * @ingroup Error
+ */
+const VirgilSystemCryptoErrorCategory& system_crypto_category() noexcept;
+
+/**
+ * @brief Handle value returned by underling system crypto library.
+ *
+ * If given value is an error then VirgilCryptoException will be thrown with appropriate description.
+ * If given value is not an error then it will be returned.
+ *
+ * @param result Value returned by system crypto library.
+ * @return Value if it's not an error.
+ * @throw VirgilCryptoException with given error code and correspond category, if given value represents an error.
+ * @ingroup Error
+ */
+inline int system_crypto_handler_get_result(int result) {
+    if (result >= 0) { return result; }
+    throw VirgilCryptoException(result, system_crypto_category());
+}
+
+/**
+ * @brief Handle value returned by underling system crypto library.
+ *
+ * If given value is an error then VirgilCryptoException will be thrown with appropriate description.
+ * If given value is not an error then do nothing.
+ *
+ * @param result Value returned by system crypto library.
+ * @throw VirgilCryptoException with given error code and correspond category, if given value represents an error.
+ * @ingroup Error
+ */
+inline void system_crypto_handler(int result) {
+    (void) system_crypto_handler_get_result(result);
+}
+
+/**
+ * @brief Handle value returned by underling system crypto library.
+ *
+ * This function is usefull if thrown exception SHOULD be wrapped.
+ * Initial exception can be accessed via std::current_exception(), or std::throw_with_nested().
+ *
+ * If given value is an error then VirgilCryptoException will be thrown with appropriate description.
+ * If given value is not an error then it will be returned.
+ *
+ * @param result Value returned by system crypto library.
+ * @param catch_handler Function that can handle the error in a different way.
+ *
+ * @return Value if it's not an error.
+ * @ingroup Error
+ */
+template<typename CatchHandler>
+inline int system_crypto_handler_get_result(int result, CatchHandler catch_handler) {
+    if (result >= 0) { return result; }
+    try {
+        throw VirgilCryptoException(result, system_crypto_category());
+    } catch (...) {
+        catch_handler(result);
+        return 0;
+    }
+}
+
+/**
+ * @brief Handle value returned by underling system crypto library.
+ *
+ * This function is usefull if thrown exception SHOULD be wrapped or error can be handled in a different way.
+ * Initial exception can be accessed via std::current_exception(), or std::throw_with_nested().
+ *
+ * If given value is an error then VirgilCryptoException will be thrown with appropriate description.
+ * If given value is not an error then do nothing.
+ *
+ * @param result Value returned by system crypto library.
+ * @param catch_handler Function that can handle the error in a different way.
+ * @ingroup Error
+ */
+template<typename CatchHandler>
+inline void system_crypto_handler(int result, CatchHandler catch_handler) {
+    (void) system_crypto_handler_get_result<CatchHandler>(result, catch_handler);
+}
+
+}}}
+
+#endif //VIRGIL_SYSTEM_CRYPTO_ERROR_H