secder.h
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:7k
源码类别:

CA认证

开发平台:

WINDOWS

  1. /*
  2.  * The contents of this file are subject to the Mozilla Public
  3.  * License Version 1.1 (the "License"); you may not use this file
  4.  * except in compliance with the License. You may obtain a copy of
  5.  * the License at http://www.mozilla.org/MPL/
  6.  * 
  7.  * Software distributed under the License is distributed on an "AS
  8.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  9.  * implied. See the License for the specific language governing
  10.  * rights and limitations under the License.
  11.  * 
  12.  * The Original Code is the Netscape security libraries.
  13.  * 
  14.  * The Initial Developer of the Original Code is Netscape
  15.  * Communications Corporation.  Portions created by Netscape are 
  16.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  17.  * Rights Reserved.
  18.  * 
  19.  * Contributor(s):
  20.  * 
  21.  * Alternatively, the contents of this file may be used under the
  22.  * terms of the GNU General Public License Version 2 or later (the
  23.  * "GPL"), in which case the provisions of the GPL are applicable 
  24.  * instead of those above.  If you wish to allow use of your 
  25.  * version of this file only under the terms of the GPL and not to
  26.  * allow others to use your version of this file under the MPL,
  27.  * indicate your decision by deleting the provisions above and
  28.  * replace them with the notice and other provisions required by
  29.  * the GPL.  If you do not delete the provisions above, a recipient
  30.  * may use your version of this file under either the MPL or the
  31.  * GPL.
  32.  */
  33. #ifndef _SECDER_H_
  34. #define _SECDER_H_
  35. /*
  36.  * secder.h - public data structures and prototypes for the DER encoding and
  37.  *       decoding utilities library
  38.  *
  39.  * $Id: secder.h,v 1.1 2000/03/31 19:39:29 relyea%netscape.com Exp $
  40.  */
  41. #include <time.h>
  42. #include "plarena.h"
  43. #include "prlong.h"
  44. #include "seccomon.h"
  45. #include "secdert.h"
  46. SEC_BEGIN_PROTOS
  47. /*
  48. ** Decode a piece of der encoded data.
  49. **  "dest" points to a structure that will be filled in with the
  50. **    decoding results.  (NOTE: it should be zeroed before calling;
  51. **    optional/missing fields are not zero-filled by DER_Decode.)
  52. ** "t" is a template structure which defines the shape of the
  53. **    expected data.
  54. ** "src" is the der encoded data.
  55. ** NOTE: substructures of "dest" will be allocated as needed from
  56. ** "arena", but data subfields will point directly into the buffer
  57. ** passed in as src->data.  That is, the resulting "dest" structure
  58. ** will contain pointers back into src->data, which must remain
  59. ** active (allocated) and unmodified for as long as "dest" is active.
  60. ** If this is a potential problem, you may want to just dup the buffer
  61. ** (allocated from "arena", probably) and pass *that* in instead.
  62. */
  63. extern SECStatus DER_Decode(PRArenaPool *arena, void *dest, DERTemplate *t,
  64.    SECItem *src);
  65. /*
  66. ** Encode a data structure into DER.
  67. ** "dest" will be filled in (and memory allocated) to hold the der
  68. **    encoded structure in "src"
  69. ** "t" is a template structure which defines the shape of the
  70. **    stored data
  71. ** "src" is a pointer to the structure that will be encoded
  72. */
  73. extern SECStatus DER_Encode(PRArenaPool *arena, SECItem *dest, DERTemplate *t,
  74.    void *src);
  75. extern SECStatus DER_Lengths(SECItem *item, int *header_len_p, uint32 *contents_len_p);
  76. /*
  77. ** Lower level der subroutine that stores the standard header into "to".
  78. ** The header is of variable length, based on encodingLen.
  79. ** The return value is the new value of "to" after skipping over the header.
  80. ** "to" is where the header will be stored
  81. ** "code" is the der code to write
  82. ** "encodingLen" is the number of bytes of data that will follow
  83. **    the header
  84. */
  85. extern unsigned char *DER_StoreHeader(unsigned char *to, unsigned int code,
  86.       uint32 encodingLen);
  87. /*
  88. ** Return the number of bytes it will take to hold a der encoded length.
  89. */
  90. extern int DER_LengthLength(uint32 len);
  91. /*
  92. ** Store a der encoded *signed* integer (whose value is "src") into "dst".
  93. ** XXX This should really be enhanced to take a long.
  94. */
  95. extern SECStatus DER_SetInteger(PRArenaPool *arena, SECItem *dst, int32 src);
  96. /*
  97. ** Store a der encoded *unsigned* integer (whose value is "src") into "dst".
  98. ** XXX This should really be enhanced to take an unsigned long.
  99. */
  100. extern SECStatus DER_SetUInteger(PRArenaPool *arena, SECItem *dst, uint32 src);
  101. /*
  102. ** Decode a der encoded *signed* integer that is stored in "src".
  103. ** If "-1" is returned, then the caller should check the error in
  104. ** XP_GetError() to see if an overflow occurred (SEC_ERROR_BAD_DER).
  105. */
  106. extern long DER_GetInteger(SECItem *src);
  107. /*
  108. ** Decode a der encoded *unsigned* integer that is stored in "src".
  109. ** If the ULONG_MAX is returned, then the caller should check the error
  110. ** in XP_GetError() to see if an overflow occurred (SEC_ERROR_BAD_DER).
  111. */
  112. extern unsigned long DER_GetUInteger(SECItem *src);
  113. /*
  114. ** Convert a "UNIX" time value to a der encoded time value.
  115. ** "result" is the der encoded time (memory is allocated)
  116. ** "time" is the "UNIX" time value (Since Jan 1st, 1970).
  117. ** The caller is responsible for freeing up the buffer which
  118. ** result->data points to upon a successfull operation.
  119. */
  120. extern SECStatus DER_TimeToUTCTime(SECItem *result, int64 time);
  121. /*
  122. ** Convert an ascii encoded time value (according to DER rules) into
  123. ** a UNIX time value.
  124. ** "result" the resulting "UNIX" time
  125. ** "string" the der notation ascii value to decode
  126. */
  127. extern SECStatus DER_AsciiToTime(int64 *result, char *string);
  128. /*
  129. ** Same as DER_AsciiToTime except takes an SECItem instead of a string
  130. */
  131. extern SECStatus DER_UTCTimeToTime(int64 *result, SECItem *time);
  132. /*
  133. ** Convert a DER encoded UTC time to an ascii time representation
  134. ** "utctime" is the DER encoded UTC time to be converted. The
  135. ** caller is responsible for deallocating the returned buffer.
  136. */
  137. extern char *DER_UTCTimeToAscii(SECItem *utcTime);
  138. /*
  139. ** Convert a DER encoded UTC time to an ascii time representation, but only
  140. ** include the day, not the time.
  141. ** "utctime" is the DER encoded UTC time to be converted.
  142. ** The caller is responsible for deallocating the returned buffer.
  143. */
  144. extern char *DER_UTCDayToAscii(SECItem *utctime);
  145. /*
  146. ** Convert a int64 time to a DER encoded Generalized time
  147. */
  148. extern SECStatus DER_TimeToGeneralizedTime(SECItem *dst, int64 gmttime);
  149. /*
  150. ** Convert a DER encoded Generalized time value into a UNIX time value.
  151. ** "dst" the resulting "UNIX" time
  152. ** "string" the der notation ascii value to decode
  153. */
  154. extern SECStatus DER_GeneralizedTimeToTime(int64 *dst, SECItem *time);
  155. /*
  156. ** Convert from a int64 UTC time value to a formatted ascii value. The
  157. ** caller is responsible for deallocating the returned buffer.
  158. */
  159. extern char *CERT_UTCTime2FormattedAscii (int64 utcTime, char *format);
  160. /*
  161. ** Convert from a int64 Generalized time value to a formatted ascii value. The
  162. ** caller is responsible for deallocating the returned buffer.
  163. */
  164. extern char *CERT_GenTime2FormattedAscii (int64 genTime, char *format);
  165. SEC_END_PROTOS
  166. #endif /* _SECDER_H_ */