3a0626106fc19d65e03f40670dc41e1ad4304d34
[shibboleth/cpp-xmltooling.git] / xmltooling / security / XSECCryptoX509CRL.h
1 /*\r
2  * Copyright 2006 The Apache Software Foundation.\r
3  *\r
4  * Licensed under the Apache License, Version 2.0 (the "License");\r
5  * you may not use this file except in compliance with the License.\r
6  * You may obtain a copy of the License at\r
7  *\r
8  *     http://www.apache.org/licenses/LICENSE-2.0\r
9  *\r
10  * Unless required by applicable law or agreed to in writing, software\r
11  * distributed under the License is distributed on an "AS IS" BASIS,\r
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
13  * See the License for the specific language governing permissions and\r
14  * limitations under the License.\r
15  */\r
16 \r
17 /**\r
18  * @file xmltooling/security/XSECCryptoX509CRL.h\r
19  * \r
20  * Wrapper for X.509 CRL objects, similar to existing XSEC wrappers.\r
21  */\r
22 \r
23 #if !defined(__xmltooling_x509crl_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
24 #define __xmltooling_x509crl_h__\r
25 \r
26 #include <xsec/framework/XSECDefs.hpp>\r
27 #include <xsec/utils/XSECSafeBuffer.hpp>\r
28 \r
29 namespace xmltooling {\r
30     /**\r
31      * Interface class for X.509 CRLs\r
32      * The library uses classes derived from this to process X.509 CRLs.\r
33      */\r
34     class XMLTOOL_API XSECCryptoX509CRL {\r
35         MAKE_NONCOPYABLE(XSECCryptoX509CRL);\r
36     protected:\r
37         XSECCryptoX509CRL() {}\r
38     public:\r
39         virtual ~XSECCryptoX509CRL() {}\r
40     \r
41         /**\r
42          * Returns a string that identifies the crypto owner of this library.\r
43          * \r
44          * @return  the crypto provider name\r
45          */\r
46         virtual const XMLCh* getProviderName() const=0;\r
47     \r
48         /**\r
49          * Load a CRL into the object.\r
50          * Takes a base64 DER-encoded CRL and loads it.\r
51          *\r
52          * @param buf buffer containing the Base64 encoded CRL\r
53          * @param len number of bytes of data in the CRL buffer\r
54          */\r
55     \r
56         virtual void loadX509CRLBase64Bin(const char* buf, unsigned int len)=0;\r
57     \r
58         /**\r
59          * Load a PEM encoded CRL into the object.\r
60          *\r
61          * Takes a PEM encoded CRL and loads it.\r
62          *\r
63          * @param buf buffer containing the PEM encoded CRL\r
64          * @param len number of bytes of data in the CRL buffer (0 if the string is null terminated)\r
65          */\r
66         void loadX509CRLPEM(const char* buf, unsigned int len=0);\r
67     \r
68         /**\r
69          * Get a Base64 DER encoded copy of the CRL\r
70          *\r
71          * @return A safeBuffer containing the DER encoded certificate\r
72          */\r
73         virtual safeBuffer& getDEREncodingSB(void)=0;\r
74     };\r
75 };\r
76 \r
77 #endif /* __xmltooling_x509crl_h__ */\r
78 \r
79 \r