1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XSECCryptoSymmetricKey.hpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">src</a> / <a class="el" href="dir_000002.html">enc</a></div>
<h1>XSECCryptoSymmetricKey.hpp</h1><a href="XSECCryptoSymmetricKey_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright 2002-2005 The Apache Software Foundation.</span>
00003 <span class="comment"> *</span>
00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
00006 <span class="comment"> * You may obtain a copy of the License at</span>
00007 <span class="comment"> *</span>
00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
00009 <span class="comment"> *</span>
00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
00014 <span class="comment"> * limitations under the License.</span>
00015 <span class="comment"> */</span>
00016
00017 <span class="comment">/*</span>
00018 <span class="comment"> * XSEC</span>
00019 <span class="comment"> *</span>
00020 <span class="comment"> * XSECCryptoSymmetricKey := Bulk encryption algorithms should all be</span>
00021 <span class="comment"> * implemented via this interface</span>
00022 <span class="comment"> *</span>
00023 <span class="comment"> * Author(s): Berin Lautenbach</span>
00024 <span class="comment"> *</span>
00025 <span class="comment"> * $Id: XSECCryptoSymmetricKey.hpp,v 1.10 2005/06/04 11:30:26 blautenb Exp $</span>
00026 <span class="comment"> *</span>
00027 <span class="comment"> */</span>
00028
00029
00030
00031 <span class="preprocessor">#ifndef XSECCRYPTOSYMMETRICKEY_INCLUDE</span>
00032 <span class="preprocessor"></span><span class="preprocessor">#define XSECCRYPTOSYMMETRICKEY_INCLUDE</span>
00033 <span class="preprocessor"></span>
00034 <span class="preprocessor">#include <xsec/framework/XSECDefs.hpp></span>
00035 <span class="preprocessor">#include <xsec/dsig/DSIGConstants.hpp></span>
00036 <span class="preprocessor">#include <xsec/enc/XSECCryptoKey.hpp></span>
00037
<a name="l00052"></a><a class="code" href="classXSECCryptoSymmetricKey.html">00052</a> <span class="keyword">class </span><a class="code" href="XSECDefs_8hpp.html#a9">DSIG_EXPORT</a> <a class="code" href="classXSECCryptoSymmetricKey.html">XSECCryptoSymmetricKey</a> : <span class="keyword">public</span> <a class="code" href="classXSECCryptoKey.html">XSECCryptoKey</a> {
00053
00054 <span class="keyword">public</span> :
00055
<a name="l00063"></a><a class="code" href="classXSECCryptoSymmetricKey.html#w8">00063</a> <span class="keyword">enum</span> SymmetricKeyType {
00064
00065 KEY_NONE,
00066 KEY_3DES_192,
00067 KEY_AES_128,
00068 KEY_AES_192,
00069 KEY_AES_256
00071 };
00072
<a name="l00073"></a><a class="code" href="classXSECCryptoSymmetricKey.html#w9">00073</a> <span class="keyword">enum</span> SymmetricKeyMode {
00074
00075 MODE_NONE,
00076 MODE_ECB,
00077 MODE_CBC
00079 };
00080
00081
00084
<a name="l00089"></a><a class="code" href="classXSECCryptoSymmetricKey.html#z175_0">00089</a> <a class="code" href="classXSECCryptoSymmetricKey.html">XSECCryptoSymmetricKey</a>() {};
00090
<a name="l00098"></a><a class="code" href="classXSECCryptoSymmetricKey.html#z175_1">00098</a> <span class="keyword">virtual</span> ~<a class="code" href="classXSECCryptoSymmetricKey.html">XSECCryptoSymmetricKey</a>() {};
00099
00101
00104
<a name="l00109"></a><a class="code" href="classXSECCryptoSymmetricKey.html#z176_0">00109</a> <span class="keyword">virtual</span> KeyType <a class="code" href="classXSECCryptoKey.html#z158_0">getKeyType</a>() {<span class="keywordflow">return</span> KEY_SYMMETRIC;}
00110
00115 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh * <a class="code" href="classXSECCryptoKey.html#z158_1">getProviderName</a>() = 0;
00116
00125 <span class="keyword">virtual</span> <a class="code" href="classXSECCryptoKey.html">XSECCryptoKey</a> * <a class="code" href="classXSECCryptoKey.html#z158_2">clone</a>() = 0;
00126
00128
00131
00140 <span class="keyword">virtual</span> SymmetricKeyType getSymmetricKeyType(<span class="keywordtype">void</span>) = 0;
00141
00153 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setKey(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * key, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> keyLen) = 0;
00154
00172 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> decryptInit(<span class="keywordtype">bool</span> doPad = <span class="keyword">true</span>,
00173 SymmetricKeyMode mode = MODE_CBC,
00174 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * iv = NULL) = 0;
00175
00196 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> decrypt(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * inBuf,
00197 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * plainBuf,
00198 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inLength,
00199 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxOutLength) = 0;
00200
00216 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> decryptFinish(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * plainBuf,
00217 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxOutLength) = 0;
00218
00235 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> encryptInit(<span class="keywordtype">bool</span> doPad = <span class="keyword">true</span>,
00236 SymmetricKeyMode mode = MODE_CBC,
00237 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * iv = NULL) = 0;
00238
00259 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> encrypt(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * inBuf,
00260 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * cipherBuf,
00261 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inLength,
00262 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxOutLength) = 0;
00263
00285 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> encryptFinish(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * plainBuf,
00286 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxOutLength) = 0;
00287
00289
00290 };
00291
00292
00293 <span class="preprocessor">#endif </span><span class="comment">/* XSECCRYPTOSYMMETRICKEY_INCLUDE */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:37:28 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|