xmltooling/security/X509Credential.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/X509Credential.h
  19  *
  20  * Wraps an X.509-based Credential.
  21  */
  22
  23 #if !defined(__xmltooling_x509cred_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_x509cred_h__
  25
  26 #include <xmltooling/security/Credential.h>
  27 #include <xmltooling/security/XSECCryptoX509CRL.h>
  28
  29 #include <vector>
  30 #include <xsec/enc/XSECCryptoX509.hpp>
  31
  32 namespace xmltooling {
  33
  34     /**
  35      * Wraps an X.509-based Credential.
  36      */
  37     class XMLTOOL_API X509Credential : public virtual Credential
  38     {
  39     protected:
  40         X509Credential() {}
  41
  42     public:
  43         virtual ~X509Credential() {}
  44
  45         enum ResolveTypes {
  46             RESOLVE_CERTS = 2,
  47             RESOLVE_CRLS = 4
  48         };
  49
  50         /**
  51          * Gets an immutable collection of certificates in the entity's trust chain. The entity certificate is contained
  52          * within this list. No specific ordering of the certificates is guaranteed.
  53          *
  54          * @return a certificate chain
  55          */
  56         virtual const std::vector<XSECCryptoX509*>& getEntityCertificateChain() const=0;
  57
  58         /**
  59          * Gets a CRL associated with the credential.
  60          *
  61          * @return CRL associated with the credential
  62          */
  63         virtual XSECCryptoX509CRL* getCRL() const=0;
  64     };
  65 };
  66
  67 #endif /* __xmltooling_x509cred_h__ */