Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 29c369053a983cc5d8c880dc6e0a2237 > files > 172

libdtn-devel-2.6.0-2mdv2009.1.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>DTN Reference Implementation: Ciphersuite.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>Ciphersuite.h</h1><a href="Ciphersuite_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *    Copyright 2006 SPARTA Inc</span>
<a name="l00003"></a>00003 <span class="comment"> * </span>
<a name="l00004"></a>00004 <span class="comment"> *    Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment"> *    you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment"> *    You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> *        http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> * </span>
<a name="l00010"></a>00010 <span class="comment"> *    Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> *    distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> *    See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> *    limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _CIPHERSUITE_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _CIPHERSUITE_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#ifdef BSP_ENABLED</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="BlockProcessor_8h.html">bundling/BlockProcessor.h</a>"</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 <span class="keyword">namespace </span>dtn {
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="keyword">class </span>BP_Local_CS;
<a name="l00027"></a>00027 
<a name="l00033"></a>00033 <span class="keyword">class </span>Ciphersuite {
<a name="l00034"></a>00034 <span class="keyword">public</span>:
<a name="l00037"></a>00037     <span class="keyword">typedef</span> oasys::ScratchBuffer&lt;u_char*, 16&gt; LocalBuffer;
<a name="l00038"></a>00038 
<a name="l00040"></a>00040     <span class="keyword">typedef</span> <a class="code" href="classdtn_1_1BlockInfo.html#3d0bc8cd207912ac5406fde3fc2c8d1c" title="List owner indicator (not transmitted).">BlockInfo::list_owner_t</a> list_owner_t;
<a name="l00041"></a>00041     <span class="keyword">typedef</span> <a class="code" href="classdtn_1_1BundleProtocol.html#37b000d94172c06970bb8af32889f917" title="Bundle Status Report &amp;quot;Reason Code&amp;quot; flags.">BundleProtocol::status_report_reason_t</a> status_report_reason_t;
<a name="l00043"></a>00043     
<a name="l00048"></a>00048     <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00049"></a>00049         CS_BLOCK_HAS_SOURCE      = 0x10,
<a name="l00050"></a>00050         CS_BLOCK_HAS_DEST        = 0x08,
<a name="l00051"></a>00051         CS_BLOCK_HAS_PARAMS      = 0x04,
<a name="l00052"></a>00052         CS_BLOCK_HAS_CORRELATOR  = 0x02,
<a name="l00053"></a>00053         CS_BLOCK_HAS_RESULT      = 0x01
<a name="l00054"></a>00054     } ciphersuite_flags_t;
<a name="l00055"></a>00055     
<a name="l00060"></a>00060     <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00061"></a>00061         CS_BLOCK_RESERVED0                      = 0x01,
<a name="l00062"></a>00062         CS_BLOCK_PROCESSED                      = 0x02,
<a name="l00063"></a>00063         CS_BLOCK_DID_NOT_FAIL                   = 0x04,
<a name="l00064"></a>00064         CS_BLOCK_FAILED_VALIDATION              = 0x08,
<a name="l00065"></a>00065         CS_BLOCK_PASSED_VALIDATION              = 0x10,
<a name="l00066"></a>00066         CS_BLOCK_COMPLETED_DO_NOT_FORWARD       = 0x20,
<a name="l00067"></a>00067         CS_BLOCK_PROCESSING_FAILED_DO_NOT_SEND  = 0x40
<a name="l00068"></a>00068     } proc_flags_t;
<a name="l00069"></a>00069     
<a name="l00074"></a>00074     <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00075"></a>00075         CS_reserved0                        =  0,
<a name="l00076"></a>00076         CS_IV_field                         =  1,
<a name="l00077"></a>00077         CS_key_ID_field                     =  2,
<a name="l00078"></a>00078         CS_encoded_key_field                =  3,
<a name="l00079"></a>00079         CS_fragment_offset_and_length_field =  4,
<a name="l00080"></a>00080         CS_signature_field                  =  5,
<a name="l00081"></a>00081         CS_reserved6                        =  6,
<a name="l00082"></a>00082         CS_C_block_salt                     =  7,
<a name="l00083"></a>00083         CS_C_block_ICV_field                =  8,
<a name="l00084"></a>00084         CS_reserved9                        =  9,
<a name="l00085"></a>00085         CS_encap_block_field                = 10,
<a name="l00086"></a>00086         CS_reserved11                       = 11
<a name="l00087"></a>00087     } ciphersuite_fields_t;
<a name="l00088"></a>00088     
<a name="l00090"></a>00090     Ciphersuite();
<a name="l00091"></a>00091 
<a name="l00095"></a>00095     <span class="keyword">virtual</span> ~Ciphersuite();
<a name="l00096"></a>00096     
<a name="l00097"></a>00097     <span class="keyword">static</span> <span class="keywordtype">void</span> register_ciphersuite(Ciphersuite* cs);
<a name="l00098"></a>00098 
<a name="l00099"></a>00099     <span class="keyword">static</span> Ciphersuite* find_suite(u_int16_t num);
<a name="l00100"></a>00100 
<a name="l00101"></a>00101     <span class="keyword">static</span> <span class="keywordtype">void</span> init_default_ciphersuites(<span class="keywordtype">void</span>);
<a name="l00102"></a>00102     
<a name="l00103"></a>00103     <span class="keyword">virtual</span> u_int16_t cs_num();
<a name="l00104"></a>00104 
<a name="l00105"></a>00105     <span class="keyword">virtual</span> <span class="keywordtype">size_t</span>    result_len()  { <span class="keywordflow">return</span> 0; }
<a name="l00106"></a>00106     
<a name="l00107"></a>00107     <span class="keyword">static</span> <span class="keywordtype">void</span> parse(BlockInfo* block);
<a name="l00108"></a>00108     
<a name="l00125"></a>00125     <span class="keyword">virtual</span> <span class="keywordtype">int</span> consume(Bundle* bundle, BlockInfo* block,
<a name="l00126"></a>00126                         u_char* <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>, <span class="keywordtype">size_t</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>) = 0;
<a name="l00127"></a>00127 
<a name="l00128"></a>00128     <span class="keyword">virtual</span> <span class="keywordtype">int</span> reload_post_process(Bundle*       bundle,
<a name="l00129"></a>00129                                     BlockInfoVec* block_list,
<a name="l00130"></a>00130                                     BlockInfo*    block);
<a name="l00131"></a>00131 
<a name="l00138"></a>00138     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> validate(<span class="keyword">const</span> Bundle*           bundle,
<a name="l00139"></a>00139                           BlockInfoVec*           block_list,
<a name="l00140"></a>00140                           BlockInfo*              block,
<a name="l00141"></a>00141                           status_report_reason_t* reception_reason,
<a name="l00142"></a>00142                           status_report_reason_t* deletion_reason) = 0;
<a name="l00143"></a>00143 
<a name="l00152"></a>00152     <span class="keyword">virtual</span> <span class="keywordtype">int</span> prepare(<span class="keyword">const</span> Bundle*    bundle,
<a name="l00153"></a>00153                         BlockInfoVec*    xmit_blocks,
<a name="l00154"></a>00154                         <span class="keyword">const</span> BlockInfo* source,
<a name="l00155"></a>00155                         <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp;   link,
<a name="l00156"></a>00156                         list_owner_t     list) = 0;
<a name="l00157"></a>00157     
<a name="l00166"></a>00166     <span class="keyword">virtual</span> <span class="keywordtype">int</span> generate(<span class="keyword">const</span> Bundle*  bundle,
<a name="l00167"></a>00167                          BlockInfoVec*  xmit_blocks,
<a name="l00168"></a>00168                          BlockInfo*     block,
<a name="l00169"></a>00169                          <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp; link,
<a name="l00170"></a>00170                          <span class="keywordtype">bool</span>           last) = 0;
<a name="l00171"></a>00171     
<a name="l00184"></a>00184     <span class="keyword">virtual</span> <span class="keywordtype">int</span> finalize(<span class="keyword">const</span> Bundle*  bundle, 
<a name="l00185"></a>00185                          BlockInfoVec*  xmit_blocks, 
<a name="l00186"></a>00186                          BlockInfo*     block, 
<a name="l00187"></a>00187                          <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>&amp; link) = 0;
<a name="l00188"></a>00188 
<a name="l00193"></a>00193     <span class="keyword">static</span> <span class="keywordtype">bool</span> check_validation(<span class="keyword">const</span> Bundle*        bundle, 
<a name="l00194"></a>00194                                  <span class="keyword">const</span> BlockInfoVec*  block_list, 
<a name="l00195"></a>00195                                  u_int16_t            num);
<a name="l00196"></a>00196                                  
<a name="l00201"></a>00201     <span class="keyword">static</span> u_int64_t create_correlator(<span class="keyword">const</span> Bundle*        bundle, 
<a name="l00202"></a>00202                                        <span class="keyword">const</span> BlockInfoVec*  block_list);
<a name="l00203"></a>00203 
<a name="l00208"></a>00208     <span class="keyword">static</span> <span class="keywordtype">bool</span> source_is_local_node(<span class="keyword">const</span> Bundle*    bundle,
<a name="l00209"></a>00209                                      <span class="keyword">const</span> BlockInfo* block);
<a name="l00210"></a>00210 
<a name="l00211"></a>00211     <span class="keyword">static</span> <span class="keywordtype">bool</span> destination_is_local_node(<span class="keyword">const</span> Bundle*    bundle,
<a name="l00212"></a>00212                                           <span class="keyword">const</span> BlockInfo* block);
<a name="l00213"></a>00213     
<a name="l00214"></a>00214     
<a name="l00215"></a>00215     <span class="keyword">virtual</span> <span class="keywordtype">void</span> init_locals(BlockInfo* block);
<a name="l00216"></a>00216     
<a name="l00217"></a>00217 <span class="keyword">protected</span>:
<a name="l00218"></a>00218     
<a name="l00223"></a>00223     <span class="keywordtype">void</span> generate_preamble(BlockInfoVec*  xmit_blocks, 
<a name="l00224"></a>00224                            BlockInfo* block,
<a name="l00225"></a>00225                            u_int8_t type,
<a name="l00226"></a>00226                            u_int64_t flags,
<a name="l00227"></a>00227                            u_int64_t data_length);
<a name="l00228"></a>00228 
<a name="l00229"></a>00229 
<a name="l00230"></a>00230 <span class="keyword">private</span>:
<a name="l00231"></a>00231 
<a name="l00236"></a>00236     <span class="keyword">static</span> Ciphersuite* ciphersuites_[1024];
<a name="l00237"></a>00237     
<a name="l00238"></a>00238     <span class="keyword">static</span> <span class="keywordtype">bool</span> inited;
<a name="l00239"></a>00239 };
<a name="l00240"></a>00240 
<a name="l00241"></a>00241 <span class="keyword">class </span>BP_Local_CS : <span class="keyword">public</span> BP_Local {
<a name="l00242"></a>00242 <span class="keyword">public</span>:
<a name="l00244"></a>00244     <span class="keyword">typedef</span> Ciphersuite::LocalBuffer LocalBuffer;
<a name="l00245"></a>00245     
<a name="l00249"></a>00249     BP_Local_CS();
<a name="l00250"></a>00250     
<a name="l00254"></a>00254     BP_Local_CS(<span class="keyword">const</span> BP_Local_CS&amp;);
<a name="l00255"></a>00255     
<a name="l00259"></a>00259     <span class="keyword">virtual</span> ~BP_Local_CS();
<a name="l00260"></a>00260     
<a name="l00262"></a>00262     <span class="comment">// need to think about which ones map to the locals and which</span>
<a name="l00263"></a>00263     <span class="comment">// are derived</span>
<a name="l00264"></a>00264       
<a name="l00265"></a>00265     u_int16_t           cs_flags()<span class="keyword">               const </span>{ <span class="keywordflow">return</span> cs_flags_; }
<a name="l00266"></a>00266     u_int16_t           owner_cs_num()<span class="keyword">           const </span>{ <span class="keywordflow">return</span> owner_cs_num_; }
<a name="l00267"></a>00267     u_int32_t           security_result_offset()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> security_result_offset_; }
<a name="l00268"></a>00268     u_int64_t           correlator()<span class="keyword">             const </span>{ <span class="keywordflow">return</span> correlator_; }
<a name="l00269"></a>00269     u_int16_t           correlator_sequence()<span class="keyword">    const </span>{ <span class="keywordflow">return</span> correlator_sequence_; }
<a name="l00270"></a>00270     <span class="keyword">const</span> LocalBuffer&amp;  key()<span class="keyword">                    const </span>{ <span class="keywordflow">return</span> key_; }
<a name="l00271"></a>00271     <span class="keyword">const</span> LocalBuffer&amp;  salt()<span class="keyword">                   const </span>{ <span class="keywordflow">return</span> salt_; }
<a name="l00272"></a>00272     <span class="keyword">const</span> LocalBuffer&amp;  iv()<span class="keyword">                     const </span>{ <span class="keywordflow">return</span> iv_; }
<a name="l00273"></a>00273     <span class="keyword">const</span> LocalBuffer&amp;  security_params()<span class="keyword">        const </span>{ <span class="keywordflow">return</span> security_params_; }
<a name="l00274"></a>00274     std::string         security_src()<span class="keyword">           const </span>{ <span class="keywordflow">return</span> security_src_; }
<a name="l00275"></a>00275     std::string         security_dest()<span class="keyword">          const </span>{ <span class="keywordflow">return</span> security_dest_; }
<a name="l00276"></a>00276     <span class="keyword">const</span> LocalBuffer&amp;  security_result()<span class="keyword">        const </span>{ <span class="keywordflow">return</span> security_result_; }
<a name="l00277"></a>00277     <a class="code" href="classdtn_1_1BlockInfo.html#3d0bc8cd207912ac5406fde3fc2c8d1c" title="List owner indicator (not transmitted).">BlockInfo::list_owner_t</a> list_owner()<span class="keyword">         const </span>{ <span class="keywordflow">return</span> list_owner_; }
<a name="l00278"></a>00278     u_int16_t           proc_flags()<span class="keyword">             const </span>{ <span class="keywordflow">return</span> proc_flags_; }
<a name="l00279"></a>00279     <span class="keywordtype">bool</span>                proc_flag(u_int16_t f)<span class="keyword">   const </span>{ <span class="keywordflow">return</span> (proc_flags_ &amp; f) != 0; }
<a name="l00281"></a>00281 
<a name="l00282"></a>00282 
<a name="l00284"></a>00284     <span class="keywordtype">void</span>         set_cs_flags(u_int16_t f)            { cs_flags_ = f; }
<a name="l00285"></a>00285     <span class="keywordtype">void</span>         set_owner_cs_num(u_int16_t n)        { owner_cs_num_ = n; }
<a name="l00286"></a>00286     <span class="keywordtype">void</span>         set_security_result_offset(u_int64_t o){ security_result_offset_ = o; }
<a name="l00287"></a>00287     <span class="keywordtype">void</span>         set_key(u_char* k, <span class="keywordtype">size_t</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00288"></a>00288     <span class="keywordtype">void</span>         set_salt(u_char* s, <span class="keywordtype">size_t</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00289"></a>00289     <span class="keywordtype">void</span>         set_iv(u_char* iv, <span class="keywordtype">size_t</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00290"></a>00290     <span class="keywordtype">void</span>         set_correlator(u_int64_t c)          { correlator_ = c; }
<a name="l00291"></a>00291     <span class="keywordtype">void</span>         set_correlator_sequence(u_int16_t c) { correlator_sequence_ = c; }
<a name="l00292"></a>00292     LocalBuffer* writable_security_params()           { <span class="keywordflow">return</span> &amp;security_params_; }    
<a name="l00293"></a>00293     <span class="keywordtype">void</span>         set_security_src(std::string s)      { security_src_ = s; }
<a name="l00294"></a>00294     <span class="keywordtype">void</span>         set_security_dest(std::string d)     { security_dest_ = d; }
<a name="l00295"></a>00295     LocalBuffer* writable_security_result()           { <span class="keywordflow">return</span> &amp;security_result_; }  
<a name="l00296"></a>00296     <span class="keywordtype">void</span>         set_list_owner(<a class="code" href="classdtn_1_1BlockInfo.html#3d0bc8cd207912ac5406fde3fc2c8d1c" title="List owner indicator (not transmitted).">BlockInfo::list_owner_t</a> o) { list_owner_ = o; }
<a name="l00297"></a>00297     <span class="keywordtype">void</span>         set_proc_flags(u_int16_t f)          { proc_flags_ = f; }
<a name="l00298"></a>00298     <span class="keywordtype">void</span>         set_proc_flag(u_int16_t f)           { proc_flags_ |= f; }
<a name="l00300"></a>00300 
<a name="l00301"></a>00301     
<a name="l00302"></a>00302 <span class="keyword">protected</span>:
<a name="l00303"></a>00303     
<a name="l00304"></a>00304     u_int16_t               cs_flags_;
<a name="l00305"></a>00305     u_int16_t               correlator_sequence_;
<a name="l00306"></a>00306     u_int32_t               security_result_offset_;
<a name="l00307"></a>00307     u_int64_t               correlator_;
<a name="l00308"></a>00308     LocalBuffer             key_;    
<a name="l00309"></a>00309     LocalBuffer             iv_;    
<a name="l00310"></a>00310     LocalBuffer             salt_;    
<a name="l00311"></a>00311     LocalBuffer             security_params_;    
<a name="l00312"></a>00312     std::string             security_src_;
<a name="l00313"></a>00313     std::string             security_dest_;
<a name="l00314"></a>00314     LocalBuffer             security_result_;    
<a name="l00315"></a>00315     <a class="code" href="classdtn_1_1BlockInfo.html#3d0bc8cd207912ac5406fde3fc2c8d1c" title="List owner indicator (not transmitted).">BlockInfo::list_owner_t</a> list_owner_;
<a name="l00316"></a>00316     u_int16_t               owner_cs_num_; 
<a name="l00317"></a>00317     u_int16_t               proc_flags_;  
<a name="l00318"></a>00318 
<a name="l00319"></a>00319 };  <span class="comment">/* BP_Local_CS */</span>
<a name="l00320"></a>00320 
<a name="l00321"></a>00321 } <span class="comment">// namespace dtn</span>
<a name="l00322"></a>00322 
<a name="l00323"></a>00323 <span class="preprocessor">#define CS_FAIL_IF(x)                                              \</span>
<a name="l00324"></a>00324 <span class="preprocessor">    do { if ( (x) ) {                                              \</span>
<a name="l00325"></a>00325 <span class="preprocessor">        log_err_p(log, "TEST FAILED (%s) at %s:%d\n",              \</span>
<a name="l00326"></a>00326 <span class="preprocessor">                (#x), __FILE__, __LINE__);                         \</span>
<a name="l00327"></a>00327 <span class="preprocessor">        goto fail;                                                 \</span>
<a name="l00328"></a>00328 <span class="preprocessor">    } } while(0);</span>
<a name="l00329"></a>00329 <span class="preprocessor"></span>
<a name="l00330"></a>00330 <span class="preprocessor">#define CS_FAIL_IF_NULL(x)                                         \</span>
<a name="l00331"></a>00331 <span class="preprocessor">    do { if ( (x) == NULL) {                                       \</span>
<a name="l00332"></a>00332 <span class="preprocessor">        log_err_p(log, "TEST FAILED (%s == NULL) at %s:%d\n",      \</span>
<a name="l00333"></a>00333 <span class="preprocessor">                (#x), __FILE__, __LINE__);                         \</span>
<a name="l00334"></a>00334 <span class="preprocessor">        goto fail;                                                 \</span>
<a name="l00335"></a>00335 <span class="preprocessor">    } } while(0);</span>
<a name="l00336"></a>00336 <span class="preprocessor"></span>
<a name="l00337"></a>00337 <span class="preprocessor">#endif </span><span class="comment">/* BSP_ENABLED */</span>
<a name="l00338"></a>00338 
<a name="l00339"></a>00339 <span class="preprocessor">#endif </span><span class="comment">/* _CIPHERSUITE_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:26:53 2009 for DTN Reference Implementation by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>