Logo Search packages:      
Sourcecode: poco version File versions  Download package

Crypto.h
//
// Crypto.h
//
// $Id: //poco/1.4/Crypto/include/Poco/Crypto/Crypto.h#3 $
//
// Library: Crypto
// Package: CryptoCore
// Module:  Crypto
//
// Basic definitions for the Poco Crypto library.
// This file must be the first file included by every other Crypto
// header file.
//
// Copyright (c) 2008, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef Crypto_Crypto_INCLUDED
#define Crypto_Crypto_INCLUDED


#if defined(__APPLE__)
// OS X 10.7 deprecates some OpenSSL functions
#pragma GCC diagnostic ignored "-Wdeprecated-declarations" 
#endif


#include "Poco/Foundation.h"


enum RSAPaddingMode
      /// The padding mode used for RSA public key encryption.
{
      RSA_PADDING_PKCS1,
            /// PKCS #1 v1.5 padding. This currently is the most widely used mode. 
            
      RSA_PADDING_PKCS1_OAEP,
            /// EME-OAEP as defined in PKCS #1 v2.0 with SHA-1, MGF1 and an empty 
            /// encoding parameter. This mode is recommended for all new applications.
            
      RSA_PADDING_SSLV23,
            /// PKCS #1 v1.5 padding with an SSL-specific modification that denotes 
            /// that the server is SSL3 capable. 
            
      RSA_PADDING_NONE
            /// Raw RSA encryption. This mode should only be used to implement cryptographically 
            /// sound padding modes in the application code. Encrypting user data directly with RSA 
            /// is insecure. 
};


//
// The following block is the standard way of creating macros which make exporting
// from a DLL simpler. All files within this DLL are compiled with the Crypto_EXPORTS
// symbol defined on the command line. this symbol should not be defined on any project
// that uses this DLL. This way any other project whose source files include this file see
// Crypto_API functions as being imported from a DLL, wheras this DLL sees symbols
// defined with this macro as being exported.
//
#if defined(_WIN32) && defined(POCO_DLL)
      #if defined(Crypto_EXPORTS)
            #define Crypto_API __declspec(dllexport)
      #else
            #define Crypto_API __declspec(dllimport)
      #endif
#endif


#if !defined(Crypto_API)
      #define Crypto_API
#endif


//
// Automatically link Crypto library.
//
#if defined(_MSC_VER)
      #if !defined(POCO_NO_AUTOMATIC_LIBS) && !defined(Crypto_EXPORTS)
            #pragma comment(lib, "PocoCrypto" POCO_LIB_SUFFIX)
      #endif
#endif


namespace Poco {
namespace Crypto {


void Crypto_API initializeCrypto();
      /// Initialize the Crypto library, as well as the underlying OpenSSL
      /// libraries, by calling OpenSSLInitializer::initialize().
      ///
      /// Should be called before using any class from the Crypto library.
      /// The Crypto library will be initialized automatically, through  
      /// OpenSSLInitializer instances held by various Crypto classes
      /// (Cipher, CipherKey, RSAKey, X509Certificate).
      /// However, it is recommended to call initializeCrypto()
      /// in any case at application startup.
      ///
      /// Can be called multiple times; however, for every call to
      /// initializeCrypto(), a matching call to uninitializeCrypto()
      /// must be performed.
      

void Crypto_API uninitializeCrypto();
      /// Uninitializes the Crypto library by calling 
      /// OpenSSLInitializer::uninitialize().


} } // namespace Poco::Crypto


#endif // Crypto_Crypto_INCLUDED

Generated by  Doxygen 1.6.0   Back to index