Logo Search packages:      
Sourcecode: poco version File versions

X509Certificate.h

//
// X509Certificate.h
//
// $Id: //poco/1.4/Crypto/include/Poco/Crypto/X509Certificate.h#2 $
//
// Library: Crypto
// Package: Certificate
// Module:  X509Certificate
//
// Definition of the X509Certificate class.
//
// Copyright (c) 2006-2009, 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_X509Certificate_INCLUDED
#define Crypto_X509Certificate_INCLUDED


#include "Poco/Crypto/Crypto.h"
#include "Poco/Crypto/OpenSSLInitializer.h"
#include "Poco/DateTime.h"
#include "Poco/SharedPtr.h"
#include <set>
#include <istream>
#include <openssl/ssl.h>


namespace Poco {
namespace Crypto {


00056 class Crypto_API X509Certificate
      /// This class represents a X509 Certificate.
{
public:
00060       enum NID
            /// Name identifier for extracting information from
            /// a certificate subject's or issuer's distinguished name.
      {
            NID_COMMON_NAME = 13,
            NID_COUNTRY = 14,
            NID_LOCALITY_NAME = 15,
            NID_STATE_OR_PROVINCE = 16,
            NID_ORGANIZATION_NAME = 17,
            NID_ORGANIZATION_UNIT_NAME = 18     
      };
      
      explicit X509Certificate(std::istream& istr);
            /// Creates the X509Certificate object by reading
            /// a certificate in PEM format from a stream.

      explicit X509Certificate(const std::string& path);
            /// Creates the X509Certificate object by reading
            /// a certificate in PEM format from a file.

      explicit X509Certificate(X509* pCert);
            /// Creates the X509Certificate from an existing
            /// OpenSSL certificate. Ownership is taken of 
            /// the certificate.

      X509Certificate(X509* pCert, bool shared);
            /// Creates the X509Certificate from an existing
            /// OpenSSL certificate. Ownership is taken of 
            /// the certificate. If shared is true, the 
            /// certificate's reference count is incremented.

      X509Certificate(const X509Certificate& cert);
            /// Creates the certificate by copying another one.

      X509Certificate& operator = (const X509Certificate& cert);
            /// Assigns a certificate.
 
      void swap(X509Certificate& cert);
            /// Exchanges the certificate with another one.

      ~X509Certificate();
            /// Destroys the X509Certificate.

      const std::string& issuerName() const;
            /// Returns the certificate issuer's distinguished name. 
            
      std::string issuerName(NID nid) const;
            /// Extracts the information specified by the given
            /// NID (name identifier) from the certificate issuer's
            /// distinguished name.
            
      const std::string& subjectName() const;
            /// Returns the certificate subject's distinguished name.

      std::string subjectName(NID nid) const;
            /// Extracts the information specified by the given
            /// NID (name identifier) from the certificate subject's
            /// distinguished name.
            
      std::string commonName() const;
            /// Returns the common name stored in the certificate
            /// subject's distinguished name.
            
      void extractNames(std::string& commonName, std::set<std::string>& domainNames) const;
            /// Extracts the common name and the alias domain names from the
            /// certificate.
            
      Poco::DateTime validFrom() const;
            /// Returns the date and time the certificate is valid from.
            
      Poco::DateTime expiresOn() const;
            /// Returns the date and time the certificate expires.
            
      void save(std::ostream& stream) const;
            /// Writes the certificate to the given stream.
            /// The certificate is written in PEM format.

      void save(const std::string& path) const;
            /// Writes the certificate to the file given by path.
            /// The certificate is written in PEM format.
            
      bool issuedBy(const X509Certificate& issuerCertificate) const;
            /// Checks whether the certificate has been issued by
            /// the issuer given by issuerCertificate. This can be
            /// used to validate a certificate chain.
            ///
            /// Verifies if the certificate has been signed with the
            /// issuer's private key, using the public key from the issuer
            /// certificate.
            ///
            /// Returns true if verification against the issuer certificate
            /// was successfull, false otherwise.

      const X509* certificate() const;
            /// Returns the underlying OpenSSL certificate.

protected:
      void load(std::istream& stream);
            /// Loads the certificate from the given stream. The
            /// certificate must be in PEM format.
            
      void load(const std::string& path);
            /// Loads the certificate from the given file. The
            /// certificate must be in PEM format.

      void init();
            /// Extracts issuer and subject name from the certificate.
      
private:
      enum
      {
            NAME_BUFFER_SIZE = 256
      };
      
      std::string _issuerName;
      std::string _subjectName;
      X509*       _pCert;
      OpenSSLInitializer _openSSLInitializer;
};


//
// inlines
//
00184 inline const std::string& X509Certificate::issuerName() const
{
      return _issuerName;
}


00190 inline const std::string& X509Certificate::subjectName() const
{
      return _subjectName;
}


00196 inline const X509* X509Certificate::certificate() const
{
      return _pCert;
}


} } // namespace Poco::Crypto


#endif // Crypto_X509Certificate_INCLUDED

Generated by  Doxygen 1.6.0   Back to index