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

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 ASN1_H
  34. #define ASN1_H
  35. #ifdef DEBUG
  36. static const char ASN1_CVS_ID[] = "@(#) $RCSfile: asn1.h,v $ $Revision: 1.1 $ $Date: 2000/03/31 19:54:58 $ $Name: NSS_3_1_1_RTM $";
  37. #endif /* DEBUG */
  38. /*
  39.  * asn1.h
  40.  *
  41.  * This file contains the ASN.1 encoder/decoder routines available
  42.  * internally within NSS.  It's not clear right now if this file
  43.  * will be folded into base.h or something, I just needed to get this
  44.  * going.  At the moment, most of these routines wrap the old SEC_ASN1
  45.  * calls.
  46.  */
  47. #ifndef ASN1T_H
  48. #include "asn1t.h"
  49. #endif /* ASN1T_H */
  50. #ifndef BASE_H
  51. #include "base.h"
  52. #endif /* BASE_H */
  53. PR_BEGIN_EXTERN_C
  54. /*
  55.  * nssASN1Decoder
  56.  *
  57.  * ... description here ...
  58.  *
  59.  *  nssASN1Decoder_Create (Factory/Constructor)
  60.  *  nssASN1Decoder_Update
  61.  *  nssASN1Decoder_Finish (Destructor)
  62.  *  nssASN1Decoder_SetFilter
  63.  *  nssASN1Decoder_GetFilter
  64.  *  nssASN1Decoder_SetNotify
  65.  *  nssASN1Decoder_GetNotify
  66.  *
  67.  * Debug builds only:
  68.  *
  69.  *  nssASN1Decoder_verify
  70.  *
  71.  * Related functions that aren't type methods:
  72.  *
  73.  *  nssASN1_Decode
  74.  *  nssASN1_DecodeBER
  75.  */
  76. /*
  77.  * nssASN1Decoder_Create
  78.  *
  79.  * This routine creates an ASN.1 Decoder, which will use the specified
  80.  * template to decode a datastream into the specified destination
  81.  * structure.  If the optional arena argument is non-NULL, blah blah 
  82.  * blah.  XXX fgmr Should we include an nssASN1EncodingType argument, 
  83.  * as a hint?  Or is each encoding distinctive?  This routine may 
  84.  * return NULL upon error, in which case an error will have been 
  85.  * placed upon the error stack.
  86.  *
  87.  * The error may be one of the following values:
  88.  *  NSS_ERROR_NO_MEMORY
  89.  *  NSS_ERROR_INVALID_ARENA
  90.  *  NSS_ERROR_INVALID_POINTER
  91.  *  ...
  92.  *
  93.  * Return value:
  94.  *  NULL upon error
  95.  *  A pointer to an ASN.1 Decoder upon success.
  96.  */
  97. NSS_EXTERN nssASN1Decoder *
  98. nssASN1Decoder_Create
  99. (
  100.   NSSArena *arenaOpt,
  101.   void *destination,
  102.   const nssASN1Template template[]
  103. );
  104. extern const NSSError NSS_ERROR_NO_MEMORY;
  105. extern const NSSError NSS_ERROR_INVALID_ARENA;
  106. extern const NSSError NSS_ERROR_INVALID_POINTER;
  107. /*
  108.  * nssASN1Decoder_Update
  109.  *
  110.  * This routine feeds data to the decoder.  In the event of an error, 
  111.  * it will place an error on the error stack and return PR_FAILURE.
  112.  *
  113.  * The error may be one of the following values:
  114.  *  NSS_ERROR_NO_MEMORY
  115.  *  NSS_ERROR_INVALID_POINTER
  116.  *  NSS_ERROR_INVALID_ASN1DECODER
  117.  *  NSS_ERROR_INVALID_BER
  118.  *  ...
  119.  *
  120.  * Return value:
  121.  *  PR_FAILURE upon error
  122.  *  PR_SUCCESS upon success.
  123.  */
  124. NSS_EXTERN PRStatus
  125. nssASN1Decoder_Update
  126. (
  127.   nssASN1Decoder *decoder,
  128.   const void *data,
  129.   PRUint32 amount
  130. );
  131. extern const NSSError NSS_ERROR_NO_MEMORY;
  132. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  133. extern const NSSError NSS_ERROR_INVALID_BER;
  134. /*
  135.  * nssASN1Decoder_Finish
  136.  *
  137.  * This routine finishes the decoding and destroys the decoder.
  138.  * In the event of an error, it will place an error on the error
  139.  * stack and return PR_FAILURE.
  140.  *
  141.  * The error may be one of the following values:
  142.  *  NSS_ERROR_INVALID_ASN1DECODER
  143.  *
  144.  * Return value:
  145.  *  PR_FAILURE upon error
  146.  *  PR_SUCCESS upon success
  147.  */
  148. NSS_EXTERN PRStatus
  149. nssASN1Decoder_Finish
  150. (
  151.   nssASN1Decoder *decoder
  152. );
  153. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  154. /*
  155.  * nssASN1Decoder_SetFilter
  156.  *
  157.  * This routine registers a callback filter routine with the decoder,
  158.  * which will be called blah blah blah.  The specified argument will
  159.  * be passed as-is to the filter routine.  The routine pointer may
  160.  * be NULL, in which case no filter callback will be called.  If the
  161.  * noStore boolean is PR_TRUE, then decoded fields will not be stored
  162.  * in the destination structure specified when the decoder was 
  163.  * created.  This routine returns a PRStatus value; in the event of
  164.  * an error, it will place an error on the error stack and return
  165.  * PR_FAILURE.
  166.  *
  167.  * The error may be one of the following values:
  168.  *  NSS_ERROR_INVALID_ASN1DECODER
  169.  *
  170.  * Return value:
  171.  *  PR_FAILURE upon error
  172.  *  PR_SUCCESS upon success
  173.  */
  174. NSS_EXTERN PRStatus
  175. nssASN1Decoder_SetFilter
  176. (
  177.   nssASN1Decoder *decoder,
  178.   nssASN1DecoderFilterFunction *callback,
  179.   void *argument,
  180.   PRBool noStore
  181. );
  182. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  183. /*
  184.  * nssASN1Decoder_GetFilter
  185.  *
  186.  * If the optional pCallbackOpt argument to this routine is non-null,
  187.  * then the pointer to any callback function established for this
  188.  * decoder with nssASN1Decoder_SetFilter will be stored at the 
  189.  * location indicated by it.  If the optional pArgumentOpt
  190.  * pointer is non-null, the filter's closure argument will be stored
  191.  * there.  If the optional pNoStoreOpt pointer is non-null, the
  192.  * noStore value specified when setting the filter will be stored
  193.  * there.  This routine returns a PRStatus value; in the event of
  194.  * an error it will place an error on the error stack and return
  195.  * PR_FAILURE.
  196.  *
  197.  * The error may be one of the following values:
  198.  *  NSS_ERROR_INVALID_ASN1DECODER
  199.  *
  200.  * Return value:
  201.  *  PR_FAILURE upon error
  202.  *  PR_SUCCESS upon success
  203.  */
  204. NSS_EXTERN PRStatus
  205. nssASN1Decoder_GetFilter
  206. (
  207.   nssASN1Decoder *decoder,
  208.   nssASN1DecoderFilterFunction **pCallbackOpt,
  209.   void **pArgumentOpt,
  210.   PRBool *pNoStoreOpt
  211. );
  212. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  213. /*
  214.  * nssASN1Decoder_SetNotify
  215.  *
  216.  * This routine registers a callback notify routine with the decoder,
  217.  * which will be called whenever.. The specified argument will be
  218.  * passed as-is to the notify routine.  The routine pointer may be
  219.  * NULL, in which case no notify routine will be called.  This routine
  220.  * returns a PRStatus value; in the event of an error it will place
  221.  * an error on the error stack and return PR_FAILURE.
  222.  *
  223.  * The error may be one of the following values:
  224.  *  NSS_ERROR_INVALID_ASN1DECODER
  225.  *
  226.  * Return value:
  227.  *  PR_FAILURE upon error
  228.  *  PR_SUCCESS upon success
  229.  */
  230. NSS_EXTERN PRStatus
  231. nssASN1Decoder_SetNotify
  232. (
  233.   nssASN1Decoder *decoder,
  234.   nssASN1NotifyFunction *callback,
  235.   void *argument
  236. );
  237. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  238. /*
  239.  * nssASN1Decoder_GetNotify
  240.  *
  241.  * If the optional pCallbackOpt argument to this routine is non-null,
  242.  * then the pointer to any callback function established for this
  243.  * decoder with nssASN1Decoder_SetNotify will be stored at the 
  244.  * location indicated by it.  If the optional pArgumentOpt pointer is
  245.  * non-null, the filter's closure argument will be stored there.
  246.  * This routine returns a PRStatus value; in the event of an error it
  247.  * will place an error on the error stack and return PR_FAILURE.
  248.  *
  249.  * The error may be one of the following values:
  250.  *  NSS_ERROR_INVALID_ASN1DECODER
  251.  *
  252.  * Return value:
  253.  *  PR_FAILURE upon error
  254.  *  PR_SUCCESS upon success
  255.  */
  256. NSS_EXTERN PRStatus
  257. nssASN1Decoder_GetNotify
  258. (
  259.   nssASN1Decoder *decoder,
  260.   nssASN1NotifyFunction **pCallbackOpt,
  261.   void **pArgumentOpt
  262. );
  263. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  264. /*
  265.  * nssASN1Decoder_verify
  266.  *
  267.  * This routine is only available in debug builds.
  268.  *
  269.  * If the specified pointer is a valid pointer to an nssASN1Decoder
  270.  * object, this routine will return PR_SUCCESS.  Otherwise, it will 
  271.  * put an error on the error stack and return PR_FAILURE.
  272.  *
  273.  * The error may be one of the following values:
  274.  *  NSS_ERROR_INVALID_ASN1DECODER
  275.  *
  276.  * Return value:
  277.  *  PR_FAILURE upon error
  278.  *  PR_SUCCESS upon success
  279.  */
  280. #ifdef DEBUG
  281. NSS_EXTERN PRStatus
  282. nssASN1Decoder_verify
  283. (
  284.   nssASN1Decoder *decoder
  285. );
  286. extern const NSSError NSS_ERROR_INVALID_ASN1DECODER;
  287. #endif /* DEBUG */
  288. /*
  289.  * nssASN1_Decode
  290.  *
  291.  * This routine will decode the specified data into the specified
  292.  * destination structure, as specified by the specified template.
  293.  * This routine returns a PRStatus value; in the event of an error
  294.  * it will place an error on the error stack and return PR_FAILURE.
  295.  *
  296.  * The error may be one of the following values:
  297.  *  NSS_ERROR_NO_MEMORY
  298.  *  NSS_ERROR_INVALID_ARENA
  299.  *  NSS_ERROR_INVALID_POINTER
  300.  *  NSS_ERROR_INVALID_BER
  301.  *
  302.  * Return value:
  303.  *  PR_FAILURE upon error
  304.  *  PR_SUCCESS upon success
  305.  */
  306. NSS_EXTERN PRStatus
  307. nssASN1_Decode
  308. (
  309.   NSSArena *arenaOpt,
  310.   void *destination,
  311.   const nssASN1Template template[],
  312.   const void *berData,
  313.   PRUint32 amount
  314. );
  315. extern const NSSError NSS_ERROR_NO_MEMORY;
  316. extern const NSSError NSS_ERROR_INVALID_ARENA;
  317. extern const NSSError NSS_ERROR_INVALID_POINTER;
  318. extern const NSSError NSS_ERROR_INVALID_BER;
  319. /*
  320.  * nssASN1_DecodeBER
  321.  *
  322.  * This routine will decode the data in the specified NSSBER
  323.  * into the destination structure, as specified by the template.
  324.  * This routine returns a PRStatus value; in the event of an error
  325.  * it will place an error on the error stack and return PR_FAILURE.
  326.  *
  327.  * The error may be one of the following values:
  328.  *  NSS_ERROR_NO_MEMORY
  329.  *  NSS_ERROR_INVALID_ARENA
  330.  *  NSS_ERROR_INVALID_POINTER
  331.  *  NSS_ERROR_INVALID_NSSBER
  332.  *  NSS_ERROR_INVALID_BER
  333.  *
  334.  * Return value:
  335.  *  PR_FAILURE upon error
  336.  *  PR_SUCCESS upon success
  337.  */
  338. NSS_EXTERN PRStatus
  339. nssASN1_DecodeBER
  340. (
  341.   NSSArena *arenaOpt,
  342.   void *destination,
  343.   const nssASN1Template template[],
  344.   const NSSBER *data
  345. );
  346. extern const NSSError NSS_ERROR_NO_MEMORY;
  347. extern const NSSError NSS_ERROR_INVALID_ARENA;
  348. extern const NSSError NSS_ERROR_INVALID_POINTER;
  349. extern const NSSError NSS_ERROR_INVALID_BER;
  350. /*
  351.  * nssASN1Encoder
  352.  *
  353.  * ... description here ...
  354.  *
  355.  *  nssASN1Encoder_Create (Factory/Constructor)
  356.  *  nssASN1Encoder_Update
  357.  *  nssASN1Encoder_Finish (Destructor)
  358.  *  nssASN1Encoder_SetNotify
  359.  *  nssASN1Encoder_GetNotify
  360.  *  nssASN1Encoder_SetStreaming
  361.  *  nssASN1Encoder_GetStreaming
  362.  *  nssASN1Encoder_SetTakeFromBuffer
  363.  *  nssASN1Encoder_GetTakeFromBuffer
  364.  *
  365.  * Debug builds only:
  366.  *
  367.  *  nssASN1Encoder_verify
  368.  *
  369.  * Related functions that aren't type methods:
  370.  *
  371.  *  nssASN1_Encode
  372.  *  nssASN1_EncodeItem
  373.  */
  374. /*
  375.  * nssASN1Encoder_Create
  376.  *
  377.  * This routine creates an ASN.1 Encoder, blah blah blah.  This 
  378.  * may return NULL upon error, in which case an error will have been
  379.  * placed on the error stack.
  380.  *
  381.  * The error may be one of the following values:
  382.  *  NSS_ERROR_NO_MEMORY
  383.  *  NSS_ERROR_INVALID_ARENA
  384.  *  NSS_ERROR_INVALID_POINTER
  385.  *  NSS_ERROR_ENCODING_NOT_SUPPORTED
  386.  *  ...
  387.  *
  388.  * Return value:
  389.  *  NULL upon error
  390.  *  A pointer to an ASN.1 Encoder upon success
  391.  */
  392. NSS_EXTERN nssASN1Encoder *
  393. nssASN1Encoder_Create
  394. (
  395.   const void *source,
  396.   const nssASN1Template template[],
  397.   NSSASN1EncodingType encoding,
  398.   nssASN1EncoderWriteFunction *sink,
  399.   void *argument
  400. );
  401. extern const NSSError NSS_ERROR_NO_MEMORY;
  402. extern const NSSError NSS_ERROR_INVALID_ARENA;
  403. extern const NSSError NSS_ERROR_INVALID_POINTER;
  404. extern const NSSError NSS_ERROR_ENCODING_NOT_SUPPORTED;
  405. /*
  406.  * nssASN1Encoder_Update
  407.  *
  408.  * The error may be one of the following values:
  409.  *  NSS_ERROR_INVALID_ASN1ENCODER
  410.  *  NSS_ERROR_INVALID_POINTER
  411.  *
  412.  * Return value:
  413.  *  PR_FAILURE upon error
  414.  *  PR_SUCCESS upon success
  415.  */
  416. NSS_EXTERN PRStatus
  417. nssASN1Encoder_Update
  418. (
  419.   nssASN1Encoder *encoder,
  420.   const void *data,
  421.   PRUint32 length
  422. );
  423. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  424. extern const NSSError NSS_ERROR_INVALID_POINTER;
  425. /*
  426.  * nssASN1Encoder_Finish
  427.  *
  428.  * Destructor.
  429.  *
  430.  * The error may be one of the following values:
  431.  *  NSS_ERROR_INVALID_ASN1ENCODER
  432.  *
  433.  * Return value:
  434.  *  PR_FAILURE upon error
  435.  *  PR_SUCCESS upon success
  436.  */
  437. NSS_EXTERN PRStatus
  438. nssASN1Encoder_Finish
  439. (
  440.   nssASN1Encoder *encoder
  441. );
  442. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  443. /*
  444.  * nssASN1Encoder_SetNotify
  445.  *
  446.  * This routine registers a callback notify routine with the encoder,
  447.  * which will be called whenever.. The specified argument will be
  448.  * passed as-is to the notify routine.  The routine pointer may be
  449.  * NULL, in which case no notify routine will be called.  This routine
  450.  * returns a PRStatus value; in the event of an error it will place
  451.  * an error on the error stack and return PR_FAILURE.
  452.  *
  453.  * The error may be one of the following values:
  454.  *  NSS_ERROR_INVALID_ASN1DECODER
  455.  *
  456.  * Return value:
  457.  *  PR_FAILURE upon error
  458.  *  PR_SUCCESS upon success
  459.  */
  460. NSS_EXTERN PRStatus
  461. nssASN1Encoder_SetNotify
  462. (
  463.   nssASN1Encoder *encoder,
  464.   nssASN1NotifyFunction *callback,
  465.   void *argument
  466. );
  467. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  468. /*
  469.  * nssASN1Encoder_GetNotify
  470.  *
  471.  * If the optional pCallbackOpt argument to this routine is non-null,
  472.  * then the pointer to any callback function established for this
  473.  * decoder with nssASN1Encoder_SetNotify will be stored at the 
  474.  * location indicated by it.  If the optional pArgumentOpt pointer is
  475.  * non-null, the filter's closure argument will be stored there.
  476.  * This routine returns a PRStatus value; in the event of an error it
  477.  * will place an error on the error stack and return PR_FAILURE.
  478.  *
  479.  * The error may be one of the following values:
  480.  *  NSS_ERROR_INVALID_ASN1ENCODER
  481.  *
  482.  * Return value:
  483.  *  PR_FAILURE upon error
  484.  *  PR_SUCCESS upon success
  485.  */
  486. NSS_EXTERN PRStatus
  487. nssASN1Encoder_GetNotify
  488. (
  489.   nssASN1Encoder *encoder,
  490.   nssASN1NotifyFunction **pCallbackOpt,
  491.   void **pArgumentOpt
  492. );
  493. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  494. /*
  495.  * nssASN1Encoder_SetStreaming
  496.  *
  497.  * 
  498.  * The error may be one of the following values:
  499.  *  NSS_ERROR_INVALID_ASN1ENCODER
  500.  *
  501.  * Return value:
  502.  *  PR_FAILURE upon error
  503.  *  PR_SUCCESS upon success
  504.  */
  505. NSS_EXTERN PRStatus
  506. nssASN1Encoder_SetStreaming
  507. (
  508.   nssASN1Encoder *encoder,
  509.   PRBool streaming
  510. );
  511. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  512. /*
  513.  * nssASN1Encoder_GetStreaming
  514.  *
  515.  *
  516.  * The error may be one of the following values:
  517.  *  NSS_ERROR_INVALID_ASN1ENCODER
  518.  *  NSS_ERROR_INVALID_POINTER
  519.  *
  520.  * Return value:
  521.  *  PR_FAILURE upon error
  522.  *  PR_SUCCESS upon success
  523.  */
  524. NSS_EXTERN PRStatus
  525. nssASN1Encoder_GetStreaming
  526. (
  527.   nssASN1Encoder *encoder,
  528.   PRBool *pStreaming
  529. );
  530. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  531. extern const NSSError NSS_ERROR_INVALID_POINTER;
  532. /*
  533.  * nssASN1Encoder_SetTakeFromBuffer
  534.  *
  535.  *
  536.  * The error may be one of the following values:
  537.  *  NSS_ERROR_INVALID_ASN1ENCODER
  538.  *
  539.  * Return value:
  540.  *  PR_FAILURE upon error
  541.  *  PR_SUCCESS upon success
  542.  */
  543. NSS_EXTERN PRStatus
  544. nssASN1Encoder_SetTakeFromBuffer
  545. (
  546.   nssASN1Encoder *encoder,
  547.   PRBool takeFromBuffer
  548. );
  549. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  550. /*
  551.  * nssASN1Encoder_GetTakeFromBuffer
  552.  *
  553.  *
  554.  * The error may be one of the following values:
  555.  *  NSS_ERROR_INVALID_ASN1ENCODER
  556.  *  NSS_ERROR_INVALID_POINTER
  557.  *
  558.  * Return value:
  559.  *  PR_FAILURE upon error
  560.  *  PR_SUCCESS upon success
  561.  */
  562. NSS_EXTERN PRStatus
  563. nssASN1Encoder_GetTakeFromBuffer
  564. (
  565.   nssASN1Encoder *encoder,
  566.   PRBool *pTakeFromBuffer
  567. );
  568. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  569. extern const NSSError NSS_ERROR_INVALID_POINTER;
  570. /*
  571.  * nssASN1Encoder_verify
  572.  *
  573.  * This routine is only available in debug builds.
  574.  *
  575.  * If the specified pointer is a valid pointer to an nssASN1Encoder
  576.  * object, this routine will return PR_SUCCESS.  Otherwise, it will 
  577.  * put an error on the error stack and return PR_FAILURE.
  578.  *
  579.  * The error may be one of the following values:
  580.  *  NSS_ERROR_INVALID_ASN1ENCODER
  581.  *
  582.  * Return value:
  583.  *  PR_FAILURE upon error
  584.  *  PR_SUCCESS upon success
  585.  */
  586. #ifdef DEBUG
  587. NSS_EXTERN PRStatus
  588. nssASN1Encoder_verify
  589. (
  590.   nssASN1Encoder *encoder
  591. );
  592. extern const NSSError NSS_ERROR_INVALID_ASN1ENCODER;
  593. #endif /* DEBUG */
  594. /*
  595.  * nssASN1_Encode
  596.  *
  597.  * 
  598.  * The error may be one of the following values:
  599.  *  NSS_ERROR_NO_MEMORY
  600.  *  NSS_ERROR_INVALID_ARENA
  601.  *  NSS_ERROR_INVALID_POINTER
  602.  *  NSS_ERROR_ENCODING_NOT_SUPPORTED
  603.  *  ...
  604.  *
  605.  * Return value:
  606.  *  PR_FAILURE upon error
  607.  *  PR_SUCCESS upon success
  608.  */
  609. NSS_EXTERN PRStatus
  610. nssASN1_Encode
  611. (
  612.   const void *source,
  613.   const nssASN1Template template[],
  614.   NSSASN1EncodingType encoding,
  615.   nssASN1EncoderWriteFunction *sink,
  616.   void *argument
  617. );
  618. extern const NSSError NSS_ERROR_NO_MEMORY;
  619. extern const NSSError NSS_ERROR_INVALID_ARENA;
  620. extern const NSSError NSS_ERROR_INVALID_POINTER;
  621. extern const NSSError NSS_ERROR_ENCODING_NOT_SUPPORTED;
  622. /*
  623.  * nssASN1_EncodeItem
  624.  *
  625.  * There must be a better name.  If the optional arena argument is
  626.  * non-null, it'll be used for the space.  If the optional rvOpt is
  627.  * non-null, it'll be the return value-- if it is null, a new one
  628.  * will be allocated.
  629.  *
  630.  * The error may be one of the following values:
  631.  *  NSS_ERROR_NO_MEMORY
  632.  *  NSS_ERROR_INVALID_ARENA
  633.  *  NSS_ERROR_INVALID_POINTER
  634.  *  NSS_ERROR_ENCODING_NOT_SUPPORTED
  635.  *
  636.  * Return value:
  637.  *  NULL upon error
  638.  *  A valid pointer to an NSSDER upon success
  639.  */
  640. NSS_EXTERN NSSDER *
  641. nssASN1_EncodeItem
  642. (
  643.   NSSArena *arenaOpt,
  644.   NSSDER *rvOpt,
  645.   const void *source,
  646.   const nssASN1Template template[],
  647.   NSSASN1EncodingType encoding
  648. );
  649. extern const NSSError NSS_ERROR_NO_MEMORY;
  650. extern const NSSError NSS_ERROR_INVALID_ARENA;
  651. extern const NSSError NSS_ERROR_INVALID_POINTER;
  652. extern const NSSError NSS_ERROR_ENCODING_NOT_SUPPORTED;
  653. /*
  654.  * Other basic types' encoding and decoding helper functions:
  655.  *
  656.  *  nssASN1_CreatePRUint32FromBER
  657.  *  nssASN1_GetDERFromPRUint32
  658.  *  nssASN1_CreatePRInt32FromBER
  659.  *  nssASN1_GetDERFromPRInt32
  660.  * ..etc..
  661.  */
  662. /*
  663.  * nssASN1_CreatePRUint32FromBER
  664.  *
  665.  */
  666. NSS_EXTERN PRStatus
  667. nssASN1_CreatePRUint32FromBER
  668. (
  669.   NSSBER *encoded,
  670.   PRUint32 *pResult
  671. );
  672. /*
  673.  * nssASN1_GetDERFromPRUint32
  674.  *
  675.  */
  676. NSS_EXTERN NSSDER *
  677. nssASN1_GetDERFromPRUint32
  678. (
  679.   NSSArena *arenaOpt,
  680.   NSSDER *rvOpt,
  681.   PRUint32 value
  682. );
  683. /*
  684.  * nssASN1_CreatePRInt32FromBER
  685.  *
  686.  */
  687. NSS_EXTERN PRStatus
  688. nssASN1_CreatePRInt32FromBER
  689. (
  690.   NSSBER *encoded,
  691.   PRInt32 *pResult
  692. );
  693. /*
  694.  * nssASN1_GetDERFromPRInt32
  695.  *
  696.  */
  697. NSS_EXTERN NSSDER *
  698. nssASN1_GetDERFromPRInt32
  699. (
  700.   NSSArena *arenaOpt,
  701.   NSSDER *rvOpt,
  702.   PRInt32 value
  703. );
  704. /*
  705.  * Builtin templates
  706.  */
  707. /*
  708.  * Generic Templates
  709.  * One for each of the simple types, plus a special one for ANY, plus:
  710.  * - a pointer to each one of those
  711.  * - a set of each one of those
  712.  *
  713.  * Note that these are alphabetical (case insensitive); please add new
  714.  * ones in the appropriate place.
  715.  */
  716. extern const nssASN1Template *nssASN1Template_Any;
  717. extern const nssASN1Template *nssASN1Template_BitString;
  718. extern const nssASN1Template *nssASN1Template_BMPString;
  719. extern const nssASN1Template *nssASN1Template_Boolean;
  720. extern const nssASN1Template *nssASN1Template_Enumerated;
  721. extern const nssASN1Template *nssASN1Template_GeneralizedTime;
  722. extern const nssASN1Template *nssASN1Template_IA5String;
  723. extern const nssASN1Template *nssASN1Template_Integer;
  724. extern const nssASN1Template *nssASN1Template_Null;
  725. extern const nssASN1Template *nssASN1Template_ObjectID;
  726. extern const nssASN1Template *nssASN1Template_OctetString;
  727. extern const nssASN1Template *nssASN1Template_PrintableString;
  728. extern const nssASN1Template *nssASN1Template_T61String;
  729. extern const nssASN1Template *nssASN1Template_UniversalString;
  730. extern const nssASN1Template *nssASN1Template_UTCTime;
  731. extern const nssASN1Template *nssASN1Template_UTF8String;
  732. extern const nssASN1Template *nssASN1Template_VisibleString;
  733. extern const nssASN1Template *nssASN1Template_PointerToAny;
  734. extern const nssASN1Template *nssASN1Template_PointerToBitString;
  735. extern const nssASN1Template *nssASN1Template_PointerToBMPString;
  736. extern const nssASN1Template *nssASN1Template_PointerToBoolean;
  737. extern const nssASN1Template *nssASN1Template_PointerToEnumerated;
  738. extern const nssASN1Template *nssASN1Template_PointerToGeneralizedTime;
  739. extern const nssASN1Template *nssASN1Template_PointerToIA5String;
  740. extern const nssASN1Template *nssASN1Template_PointerToInteger;
  741. extern const nssASN1Template *nssASN1Template_PointerToNull;
  742. extern const nssASN1Template *nssASN1Template_PointerToObjectID;
  743. extern const nssASN1Template *nssASN1Template_PointerToOctetString;
  744. extern const nssASN1Template *nssASN1Template_PointerToPrintableString;
  745. extern const nssASN1Template *nssASN1Template_PointerToT61String;
  746. extern const nssASN1Template *nssASN1Template_PointerToUniversalString;
  747. extern const nssASN1Template *nssASN1Template_PointerToUTCTime;
  748. extern const nssASN1Template *nssASN1Template_PointerToUTF8String;
  749. extern const nssASN1Template *nssASN1Template_PointerToVisibleString;
  750. extern const nssASN1Template *nssASN1Template_SetOfAny;
  751. extern const nssASN1Template *nssASN1Template_SetOfBitString;
  752. extern const nssASN1Template *nssASN1Template_SetOfBMPString;
  753. extern const nssASN1Template *nssASN1Template_SetOfBoolean;
  754. extern const nssASN1Template *nssASN1Template_SetOfEnumerated;
  755. extern const nssASN1Template *nssASN1Template_SetOfGeneralizedTime;
  756. extern const nssASN1Template *nssASN1Template_SetOfIA5String;
  757. extern const nssASN1Template *nssASN1Template_SetOfInteger;
  758. extern const nssASN1Template *nssASN1Template_SetOfNull;
  759. extern const nssASN1Template *nssASN1Template_SetOfObjectID;
  760. extern const nssASN1Template *nssASN1Template_SetOfOctetString;
  761. extern const nssASN1Template *nssASN1Template_SetOfPrintableString;
  762. extern const nssASN1Template *nssASN1Template_SetOfT61String;
  763. extern const nssASN1Template *nssASN1Template_SetOfUniversalString;
  764. extern const nssASN1Template *nssASN1Template_SetOfUTCTime;
  765. extern const nssASN1Template *nssASN1Template_SetOfUTF8String;
  766. extern const nssASN1Template *nssASN1Template_SetOfVisibleString;
  767. /*
  768.  *
  769.  */
  770. NSS_EXTERN NSSUTF8 *
  771. nssUTF8_CreateFromBER
  772. (
  773.   NSSArena *arenaOpt,
  774.   nssStringType type,
  775.   NSSBER *berData
  776. );
  777. NSS_EXTERN NSSDER *
  778. nssUTF8_GetDEREncoding
  779. (
  780.   NSSArena *arenaOpt,
  781.   /* Should have an NSSDER *rvOpt */
  782.   nssStringType type,
  783.   const NSSUTF8 *string
  784. );
  785. PR_END_EXTERN_C
  786. #endif /* ASN1_H */