xmltooling/security/BasicX509Credential.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file xmltooling/security/BasicX509Credential.h
  19  *
  20  * Wraps an X.509-based Credential by storing key/cert objects inside.
  21  */
  22
  23 #if !defined(__xmltooling_basicx509cred_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_basicx509cred_h__
  25
  26 #include <xmltooling/security/X509Credential.h>
  27 #include <xmltooling/signature/KeyInfo.h>
  28
  29 #include <algorithm>
  30
  31 namespace xmltooling {
  32
  33     /**
  34      * Wraps an X.509-based Credential by storing key/cert objects inside.
  35      */
  36     class XMLTOOL_API BasicX509Credential : public virtual X509Credential
  37     {
  38     protected:
  39         /**
  40          * Constructor.
  41          *
  42          * @param ownCerts  true iff any certificates subsequently stored should be freed by destructor
  43          */
  44         BasicX509Credential(bool ownCerts) : m_key(NULL), m_ownCerts(ownCerts), m_crl(NULL), m_keyInfo(NULL), m_compactKeyInfo(NULL) {
  45         }
  46
  47         /**
  48          * Constructor.
  49          *
  50          * @param key   key pair or secret key
  51          * @param certs array of X.509 certificates, the first entry being the entity certificate
  52          * @param crl   optional CRL
  53          */
  54         BasicX509Credential(XSECCryptoKey* key, const std::vector<XSECCryptoX509*>& certs, XSECCryptoX509CRL* crl=NULL)
  55                 : m_key(key), m_xseccerts(certs), m_ownCerts(true), m_crl(crl), m_keyInfo(NULL), m_compactKeyInfo(NULL) {
  56         }
  57
  58         /** The private/secret key/keypair. */
  59         XSECCryptoKey* m_key;
  60
  61         /** Key names (derived from credential, KeyInfo, or both). */
  62         std::set<std::string> m_keyNames;
  63
  64         /** The X.509 certificate chain. */
  65         std::vector<XSECCryptoX509*> m_xseccerts;
  66
  67         /** Indicates whether to destroy certificates. */
  68         bool m_ownCerts;
  69
  70         /** The X.509 CRL. */
  71         XSECCryptoX509CRL* m_crl;
  72
  73         /** The KeyInfo object representing the information. */
  74         xmlsignature::KeyInfo* m_keyInfo;
  75
  76         /** The KeyInfo object representing the information in compact form. */
  77         xmlsignature::KeyInfo* m_compactKeyInfo;
  78
  79         /**
  80          * Initializes (or reinitializes) a ds:KeyInfo to represent the Credential.
  81          */
  82         void initKeyInfo();
  83
  84     public:
  85         virtual ~BasicX509Credential();
  86
  87         UsageTypes getUsage() const {
  88             return UNSPECIFIED_CREDENTIAL;
  89         }
  90         const char* getAlgorithm() const;
  91         unsigned int getKeySize() const;
  92
  93         XSECCryptoKey* getPrivateKey() const {
  94             if (m_key) {
  95                 XSECCryptoKey::KeyType type = m_key->getKeyType();
  96                 if (type!=XSECCryptoKey::KEY_RSA_PUBLIC && type!=XSECCryptoKey::KEY_DSA_PUBLIC)
  97                     return m_key;
  98             }
  99             return NULL;
 100         }
 101
 102         XSECCryptoKey* getPublicKey() const {
 103             if (m_key) {
 104                 XSECCryptoKey::KeyType type = m_key->getKeyType();
 105                 if (type!=XSECCryptoKey::KEY_RSA_PRIVATE && type!=XSECCryptoKey::KEY_DSA_PRIVATE)
 106                     return m_key;
 107             }
 108             return NULL;
 109         }
 110
 111         const std::set<std::string>& getKeyNames() const {
 112             return m_keyNames;
 113         }
 114
 115         xmlsignature::KeyInfo* getKeyInfo(bool compact=false) const {
 116             if (compact || !m_keyInfo)
 117                 return m_compactKeyInfo ? m_compactKeyInfo->cloneKeyInfo() : NULL;
 118             return m_keyInfo->cloneKeyInfo();
 119         }
 120
 121         const std::vector<XSECCryptoX509*>& getEntityCertificateChain() const {
 122             return m_xseccerts;
 123         }
 124
 125         XSECCryptoX509CRL* getCRL() const {
 126             return m_crl;
 127         }
 128     };
 129 };
 130
 131 #endif /* __xmltooling_basicx509cred_h__ */