<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>libnet: libnet-asn1.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>libnet-asn1.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * $Id: libnet-asn1.h,v 1.3 2004/01/17 07:51:19 mike Exp $</span> <a name="l00003"></a>00003 <span class="comment"> *</span> <a name="l00004"></a>00004 <span class="comment"> * libnet-asn1.h - Network routine library ASN.1 header file</span> <a name="l00005"></a>00005 <span class="comment"> *</span> <a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 1998 - 2004 Mike D. Schiffman <mike@infonexus.com></span> <a name="l00007"></a>00007 <span class="comment"> * All rights reserved.</span> <a name="l00008"></a>00008 <span class="comment"> *</span> <a name="l00009"></a>00009 <span class="comment"> * Definitions for Abstract Syntax Notation One, ASN.1</span> <a name="l00010"></a>00010 <span class="comment"> * As defined in ISO/IS 8824 and ISO/IS 8825</span> <a name="l00011"></a>00011 <span class="comment"> *</span> <a name="l00012"></a>00012 <span class="comment"> * Copyright 1988, 1989 by Carnegie Mellon University</span> <a name="l00013"></a>00013 <span class="comment"> * All rights reserved.</span> <a name="l00014"></a>00014 <span class="comment"> *</span> <a name="l00015"></a>00015 <span class="comment"> * Permission to use, copy, modify, and distribute this software and its</span> <a name="l00016"></a>00016 <span class="comment"> * documentation for any purpose and without fee is hereby granted,</span> <a name="l00017"></a>00017 <span class="comment"> * provided that the above copyright notice appear in all copies and that</span> <a name="l00018"></a>00018 <span class="comment"> * both that copyright notice and this permission notice appear in</span> <a name="l00019"></a>00019 <span class="comment"> * supporting documentation, and that the name of CMU not be</span> <a name="l00020"></a>00020 <span class="comment"> * used in advertising or publicity pertaining to distribution of the</span> <a name="l00021"></a>00021 <span class="comment"> * software without specific, written prior permission.</span> <a name="l00022"></a>00022 <span class="comment"> *</span> <a name="l00023"></a>00023 <span class="comment"> * CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING</span> <a name="l00024"></a>00024 <span class="comment"> * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL</span> <a name="l00025"></a>00025 <span class="comment"> * CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR</span> <a name="l00026"></a>00026 <span class="comment"> * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,</span> <a name="l00027"></a>00027 <span class="comment"> * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,</span> <a name="l00028"></a>00028 <span class="comment"> * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS</span> <a name="l00029"></a>00029 <span class="comment"> * SOFTWARE.</span> <a name="l00030"></a>00030 <span class="comment"> *</span> <a name="l00031"></a>00031 <span class="comment"> * Copyright (c) 1998 - 2001 Mike D. Schiffman <mike@infonexus.com></span> <a name="l00032"></a>00032 <span class="comment"> * All rights reserved.</span> <a name="l00033"></a>00033 <span class="comment"> *</span> <a name="l00034"></a>00034 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> <a name="l00035"></a>00035 <span class="comment"> * modification, are permitted provided that the following conditions</span> <a name="l00036"></a>00036 <span class="comment"> * are met:</span> <a name="l00037"></a>00037 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span> <a name="l00038"></a>00038 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span> <a name="l00039"></a>00039 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span> <a name="l00040"></a>00040 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span> <a name="l00041"></a>00041 <span class="comment"> * documentation and/or other materials provided with the distribution.</span> <a name="l00042"></a>00042 <span class="comment"> *</span> <a name="l00043"></a>00043 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND</span> <a name="l00044"></a>00044 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span> <a name="l00045"></a>00045 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span> <a name="l00046"></a>00046 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE</span> <a name="l00047"></a>00047 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span> <a name="l00048"></a>00048 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span> <a name="l00049"></a>00049 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span> <a name="l00050"></a>00050 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span> <a name="l00051"></a>00051 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span> <a name="l00052"></a>00052 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span> <a name="l00053"></a>00053 <span class="comment"> * SUCH DAMAGE.</span> <a name="l00054"></a>00054 <span class="comment"> */</span> <a name="l00055"></a>00055 <a name="l00056"></a>00056 <span class="preprocessor">#ifndef __LIBNET_ASN1_H</span> <a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor">#define __LIBNET_ASN1_H</span> <a name="l00058"></a>00058 <span class="preprocessor"></span> <a name="l00059"></a>00059 <span class="preprocessor">#ifndef EIGHTBIT_SUBIDS</span> <a name="l00060"></a>00060 <span class="preprocessor"></span><span class="keyword">typedef</span> u_int32_t oid; <a name="l00061"></a>00061 <span class="preprocessor">#define MAX_SUBID 0xFFFFFFFF</span> <a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#else</span> <a name="l00063"></a>00063 <span class="preprocessor"></span><span class="keyword">typedef</span> u_int8_t oid; <a name="l00064"></a>00064 <span class="preprocessor">#define MAX_SUBID 0xFF</span> <a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00066"></a>00066 <span class="preprocessor"></span> <a name="l00067"></a>00067 <span class="preprocessor">#define MAX_OID_LEN 64 </span><span class="comment">/* max subid's in an oid */</span> <a name="l00068"></a>00068 <a name="l00069"></a>00069 <span class="preprocessor">#define ASN_BOOLEAN (0x01)</span> <a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#define ASN_INTEGER (0x02)</span> <a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#define ASN_BIT_STR (0x03)</span> <a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define ASN_OCTET_STR (0x04)</span> <a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#define ASN_NULL (0x05)</span> <a name="l00074"></a>00074 <span class="preprocessor"></span><span class="preprocessor">#define ASN_OBJECT_ID (0x06)</span> <a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor">#define ASN_SEQUENCE (0x10)</span> <a name="l00076"></a>00076 <span class="preprocessor"></span><span class="preprocessor">#define ASN_SET (0x11)</span> <a name="l00077"></a>00077 <span class="preprocessor"></span> <a name="l00078"></a>00078 <span class="preprocessor">#define ASN_UNIVERSAL (0x00)</span> <a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#define ASN_APPLICATION (0x40)</span> <a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor">#define ASN_CONTEXT (0x80)</span> <a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor">#define ASN_PRIVATE (0xC0)</span> <a name="l00082"></a>00082 <span class="preprocessor"></span> <a name="l00083"></a>00083 <span class="preprocessor">#define ASN_PRIMITIVE (0x00)</span> <a name="l00084"></a>00084 <span class="preprocessor"></span><span class="preprocessor">#define ASN_CONSTRUCTOR (0x20)</span> <a name="l00085"></a>00085 <span class="preprocessor"></span> <a name="l00086"></a>00086 <span class="preprocessor">#define ASN_LONG_LEN (0x80)</span> <a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor">#define ASN_EXTENSION_ID (0x1F)</span> <a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#define ASN_BIT8 (0x80)</span> <a name="l00089"></a>00089 <span class="preprocessor"></span> <a name="l00090"></a>00090 <span class="preprocessor">#define IS_CONSTRUCTOR(byte) ((byte) & ASN_CONSTRUCTOR)</span> <a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#define IS_EXTENSION_ID(byte) (((byte) & ASN_EXTENSION_ID) = ASN_EXTENSION_ID)</span> <a name="l00092"></a>00092 <span class="preprocessor"></span> <a name="l00093"></a>00093 <span class="comment">/*</span> <a name="l00094"></a>00094 <span class="comment"> * All of the build_asn1_* (build_asn1_length being an exception) functions</span> <a name="l00095"></a>00095 <span class="comment"> * take the same first 3 arguments:</span> <a name="l00096"></a>00096 <span class="comment"> *</span> <a name="l00097"></a>00097 <span class="comment"> * u_int8_t *data: This is a pointer to the start of the data object to be</span> <a name="l00098"></a>00098 <span class="comment"> * manipulated.</span> <a name="l00099"></a>00099 <span class="comment"> * int *datalen: This is a pointer to the number of valid bytes following</span> <a name="l00100"></a>00100 <span class="comment"> * "data". This should be not be exceeded in any function.</span> <a name="l00101"></a>00101 <span class="comment"> * Upon exiting a function, this value will reflect the</span> <a name="l00102"></a>00102 <span class="comment"> * changed "data" and then refer to the new number of valid</span> <a name="l00103"></a>00103 <span class="comment"> * bytes until the end of "data".</span> <a name="l00104"></a>00104 <span class="comment"> * u_int8_t type: The ASN.1 object type.</span> <a name="l00105"></a>00105 <span class="comment"> */</span> <a name="l00106"></a>00106 <a name="l00107"></a>00107 <a name="l00108"></a>00108 <span class="comment">/*</span> <a name="l00109"></a>00109 <span class="comment"> * Builds an ASN object containing an integer.</span> <a name="l00110"></a>00110 <span class="comment"> *</span> <a name="l00111"></a>00111 <span class="comment"> * Returns NULL upon error or a pointer to the first byte past the end of</span> <a name="l00112"></a>00112 <span class="comment"> * this object (the start of the next object).</span> <a name="l00113"></a>00113 <span class="comment"> */</span> <a name="l00114"></a>00114 <a name="l00115"></a>00115 u_int8_t * <a name="l00116"></a>00116 libnet_build_asn1_int( <a name="l00117"></a>00117 u_int8_t *, <span class="comment">/* Pointer to the output buffer */</span> <a name="l00118"></a>00118 <span class="keywordtype">int</span> *, <span class="comment">/* Number of valid bytes left in the buffer */</span> <a name="l00119"></a>00119 u_int8_t, <span class="comment">/* ASN object type */</span> <a name="l00120"></a>00120 int32_t *, <span class="comment">/* Pointer to a int32_t integer */</span> <a name="l00121"></a>00121 <span class="keywordtype">int</span> <span class="comment">/* Size of a int32_t integer */</span> <a name="l00122"></a>00122 ); <a name="l00123"></a>00123 <a name="l00124"></a>00124 <a name="l00125"></a>00125 <span class="comment">/*</span> <a name="l00126"></a>00126 <span class="comment"> * Builds an ASN object containing an unsigned integer.</span> <a name="l00127"></a>00127 <span class="comment"> *</span> <a name="l00128"></a>00128 <span class="comment"> * Returns NULL upon error or a pointer to the first byte past the end of</span> <a name="l00129"></a>00129 <span class="comment"> * this object (the start of the next object).</span> <a name="l00130"></a>00130 <span class="comment"> */</span> <a name="l00131"></a>00131 <a name="l00132"></a>00132 u_int8_t * <a name="l00133"></a>00133 libnet_build_asn1_uint( <a name="l00134"></a>00134 u_int8_t *, <span class="comment">/* Pointer to the output buffer */</span> <a name="l00135"></a>00135 <span class="keywordtype">int</span> *, <span class="comment">/* Number of valid bytes left in the buffer */</span> <a name="l00136"></a>00136 u_int8_t, <span class="comment">/* ASN object type */</span> <a name="l00137"></a>00137 u_int32_t *, <span class="comment">/* Pointer to an unsigned int32_t integer */</span> <a name="l00138"></a>00138 <span class="keywordtype">int</span> <span class="comment">/* Size of a int32_t integer */</span> <a name="l00139"></a>00139 ); <a name="l00140"></a>00140 <a name="l00141"></a>00141 <a name="l00142"></a>00142 <span class="comment">/*</span> <a name="l00143"></a>00143 <span class="comment"> * Builds an ASN object containing an octect string.</span> <a name="l00144"></a>00144 <span class="comment"> *</span> <a name="l00145"></a>00145 <span class="comment"> * Returns NULL upon error or a pointer to the first byte past the end of</span> <a name="l00146"></a>00146 <span class="comment"> * this object (the start of the next object).</span> <a name="l00147"></a>00147 <span class="comment"> */</span> <a name="l00148"></a>00148 <a name="l00149"></a>00149 u_int8_t * <a name="l00150"></a>00150 libnet_build_asn1_string( <a name="l00151"></a>00151 u_int8_t *, <span class="comment">/* Pointer to the output buffer */</span> <a name="l00152"></a>00152 <span class="keywordtype">int</span> *, <span class="comment">/* Number of valid bytes left in the buffer */</span> <a name="l00153"></a>00153 u_int8_t, <span class="comment">/* ASN object type */</span> <a name="l00154"></a>00154 u_int8_t *, <span class="comment">/* Pointer to a string to be built into an object */</span> <a name="l00155"></a>00155 <span class="keywordtype">int</span> <span class="comment">/* Size of the string */</span> <a name="l00156"></a>00156 ); <a name="l00157"></a>00157 <a name="l00158"></a>00158 <a name="l00159"></a>00159 <span class="comment">/*</span> <a name="l00160"></a>00160 <span class="comment"> * Builds an ASN header for an object with the ID and length specified. This</span> <a name="l00161"></a>00161 <span class="comment"> * only works on data types < 30, i.e. no extension octets. The maximum</span> <a name="l00162"></a>00162 <span class="comment"> * length is 0xFFFF;</span> <a name="l00163"></a>00163 <span class="comment"> *</span> <a name="l00164"></a>00164 <span class="comment"> * Returns a pointer to the first byte of the contents of this object or</span> <a name="l00165"></a>00165 <span class="comment"> * NULL upon error</span> <a name="l00166"></a>00166 <span class="comment"> */</span> <a name="l00167"></a>00167 <a name="l00168"></a>00168 u_int8_t * <a name="l00169"></a>00169 libnet_build_asn1_header( <a name="l00170"></a>00170 u_int8_t *, <span class="comment">/* Pointer to the start of the object */</span> <a name="l00171"></a>00171 <span class="keywordtype">int</span> *, <span class="comment">/* Number of valid bytes left in buffer */</span> <a name="l00172"></a>00172 u_int8_t, <span class="comment">/* ASN object type */</span> <a name="l00173"></a>00173 <span class="keywordtype">int</span> <span class="comment">/* ASN object length */</span> <a name="l00174"></a>00174 ); <a name="l00175"></a>00175 <a name="l00176"></a>00176 <a name="l00177"></a>00177 u_int8_t * <a name="l00178"></a>00178 libnet_build_asn1_length( <a name="l00179"></a>00179 u_int8_t *, <span class="comment">/* Pointer to start of object */</span> <a name="l00180"></a>00180 <span class="keywordtype">int</span> *, <span class="comment">/* Number of valid bytes in buffer */</span> <a name="l00181"></a>00181 <span class="keywordtype">int</span> <span class="comment">/* Length of object */</span> <a name="l00182"></a>00182 ); <a name="l00183"></a>00183 <a name="l00184"></a>00184 <a name="l00185"></a>00185 <span class="comment">/*</span> <a name="l00186"></a>00186 <span class="comment"> * Builds an ASN header for a sequence with the ID and length specified.</span> <a name="l00187"></a>00187 <span class="comment"> *</span> <a name="l00188"></a>00188 <span class="comment"> * This only works on data types < 30, i.e. no extension octets.</span> <a name="l00189"></a>00189 <span class="comment"> * The maximum length is 0xFFFF;</span> <a name="l00190"></a>00190 <span class="comment"> *</span> <a name="l00191"></a>00191 <span class="comment"> * Returns a pointer to the first byte of the contents of this object.</span> <a name="l00192"></a>00192 <span class="comment"> * Returns NULL on any error.</span> <a name="l00193"></a>00193 <span class="comment"> */</span> <a name="l00194"></a>00194 <a name="l00195"></a>00195 u_int8_t * <a name="l00196"></a>00196 libnet_build_asn1_sequence( <a name="l00197"></a>00197 u_int8_t *, <a name="l00198"></a>00198 <span class="keywordtype">int</span> *, <a name="l00199"></a>00199 u_int8_t, <a name="l00200"></a>00200 <span class="keywordtype">int</span> <a name="l00201"></a>00201 ); <a name="l00202"></a>00202 <a name="l00203"></a>00203 <a name="l00204"></a>00204 <span class="comment">/*</span> <a name="l00205"></a>00205 <span class="comment"> * Builds an ASN object identifier object containing the input string.</span> <a name="l00206"></a>00206 <span class="comment"> *</span> <a name="l00207"></a>00207 <span class="comment"> * Returns NULL upon error or a pointer to the first byte past the end of</span> <a name="l00208"></a>00208 <span class="comment"> * this object (the start of the next object).</span> <a name="l00209"></a>00209 <span class="comment"> */</span> <a name="l00210"></a>00210 <a name="l00211"></a>00211 u_int8_t * <a name="l00212"></a>00212 libnet_build_asn1_objid( <a name="l00213"></a>00213 u_int8_t *, <a name="l00214"></a>00214 <span class="keywordtype">int</span> *, <a name="l00215"></a>00215 u_int8_t, <a name="l00216"></a>00216 oid *, <a name="l00217"></a>00217 <span class="keywordtype">int</span> <a name="l00218"></a>00218 ); <a name="l00219"></a>00219 <a name="l00220"></a>00220 <a name="l00221"></a>00221 <span class="comment">/*</span> <a name="l00222"></a>00222 <span class="comment"> * Builds an ASN null object.</span> <a name="l00223"></a>00223 <span class="comment"> *</span> <a name="l00224"></a>00224 <span class="comment"> * Returns NULL upon error or a pointer to the first byte past the end of</span> <a name="l00225"></a>00225 <span class="comment"> * this object (the start of the next object).</span> <a name="l00226"></a>00226 <span class="comment"> */</span> <a name="l00227"></a>00227 <a name="l00228"></a>00228 u_int8_t * <a name="l00229"></a>00229 libnet_build_asn1_null( <a name="l00230"></a>00230 u_int8_t *, <a name="l00231"></a>00231 <span class="keywordtype">int</span> *, <a name="l00232"></a>00232 u_int8_t <a name="l00233"></a>00233 ); <a name="l00234"></a>00234 <a name="l00235"></a>00235 <a name="l00236"></a>00236 <span class="comment">/*</span> <a name="l00237"></a>00237 <span class="comment"> * Builds an ASN bitstring.</span> <a name="l00238"></a>00238 <span class="comment"> *</span> <a name="l00239"></a>00239 <span class="comment"> * Returns NULL upon error or a pointer to the first byte past the end of</span> <a name="l00240"></a>00240 <span class="comment"> * this object (the start of the next object).</span> <a name="l00241"></a>00241 <span class="comment"> */</span> <a name="l00242"></a>00242 <a name="l00243"></a>00243 u_int8_t * <a name="l00244"></a>00244 libnet_build_asn1_bitstring( <a name="l00245"></a>00245 u_int8_t *, <a name="l00246"></a>00246 <span class="keywordtype">int</span> *, <a name="l00247"></a>00247 u_int8_t, <a name="l00248"></a>00248 u_int8_t *, <span class="comment">/* Pointer to the input buffer */</span> <a name="l00249"></a>00249 <span class="keywordtype">int</span> <span class="comment">/* Length of the input buffer */</span> <a name="l00250"></a>00250 ); <a name="l00251"></a>00251 <a name="l00252"></a>00252 <a name="l00253"></a>00253 <span class="preprocessor">#endif </span><span class="comment">/* __LIBNET_ASN1_H */</span> <a name="l00254"></a>00254 <a name="l00255"></a>00255 <span class="comment">/* EOF */</span> </pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 9 16:16:39 2009 for libnet by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> </body> </html>