WinBer.h
上传用户:dzyhzl
上传日期:2019-04-29
资源大小:56270k
文件大小:13k
源码类别:

模拟服务器

开发平台:

C/C++

  1. /*++
  2. Copyright (c) 1996-1999  Microsoft Corporation
  3. Module Name:
  4.     winber.h   Basic Encoding Rules (BER) API header file
  5. Abstract:
  6.    This module is the header file for the 32 bit BER library on
  7.    Windows NT and Windows 95.
  8. Updates :
  9. Environments :
  10.     Win32 user mode
  11. --*/
  12. //
  13. // Only pull in this header file once.
  14. //
  15. #ifndef _WINBER_DEFINED_
  16. #define _WINBER_DEFINED_
  17. #if _MSC_VER > 1000
  18. #pragma once
  19. #endif
  20. #ifdef __cplusplus
  21. extern "C" {
  22. #endif
  23. #if !defined(_WINBER_)
  24. #define WINBERAPI DECLSPEC_IMPORT
  25. #else
  26. //#define WINBERAPI __declspec(dllexport)
  27. #define WINBERAPI
  28. #endif
  29. #ifndef BERAPI
  30. #define BERAPI __cdecl
  31. #endif
  32. #define LBER_ERROR   0xffffffffL
  33. #define LBER_DEFAULT 0xffffffffL
  34. typedef unsigned int ber_tag_t;   /* for BER tags */
  35. typedef int ber_int_t;            /* for BER ints, enums, and Booleans */
  36. typedef unsigned int ber_uint_t;  /* unsigned equivalent of ber_int_t */
  37. typedef int ber_slen_t;           /* signed equivalent of ber_len_t */
  38. //
  39. // This constructs a new BerElement structure containing a copy of the
  40. // data in the supplied berval structure.
  41. //
  42. WINBERAPI BerElement * BERAPI ber_init( BERVAL *pBerVal );
  43. //
  44. // This frees a BerElement which is returned from ber_alloc_t()
  45. // or ber_init(). The second argument - fbuf should always be set
  46. // to 1.
  47. //
  48. //
  49. WINBERAPI VOID BERAPI ber_free( BerElement *pBerElement, INT fbuf );
  50. //
  51. // Frees a BERVAL structure. Applications should not call
  52. // this API to free BERVAL structures which they themselves
  53. // have allocated
  54. //
  55. WINBERAPI VOID BERAPI ber_bvfree( BERVAL *pBerVal );
  56. //
  57. // Frees an array of BERVAL structures.
  58. //
  59. WINBERAPI VOID BERAPI ber_bvecfree( PBERVAL *pBerVal );
  60. //
  61. // Returns a copy of a the supplied berval structure
  62. //
  63. WINBERAPI BERVAL * BERAPI ber_bvdup( BERVAL *pBerVal );
  64. //
  65. // Constructs and returns a BerElement structure. The options field
  66. // contains a bitwise-or of options which are to be used when generating
  67. // the encoding of the BerElement
  68. //
  69. // The LBER_USE_DER options should always be specified.
  70. //
  71. WINBERAPI BerElement * BERAPI ber_alloc_t( INT options );
  72. //
  73. // This skips over the current tag and returns the tag of the next
  74. // element in the supplied BerElement. The lenght of this element is
  75. // stored in the pLen argument.
  76. //
  77. // LBER_DEFAULT is returned if there is no further data to be read
  78. // else the tag of the next element is returned.
  79. //
  80. // The difference between ber_skip_tag() and ber_peek_tag() is that the
  81. // state pointer is advanced past the first tag+lenght and is pointed to
  82. // the value part of the next element
  83. //
  84. WINBERAPI ULONG BERAPI ber_skip_tag( BerElement *pBerElement, ULONG *pLen );
  85. //
  86. // This returns the tag of the next element to be parsed in the
  87. // supplied BerElement. The length of this element is stored in the
  88. // pLen argument.
  89. //
  90. // LBER_DEFAULT is returned if there is no further data to be read
  91. // else the tag of the next element is returned.
  92. //
  93. WINBERAPI ULONG BERAPI ber_peek_tag( BerElement *pBerElement, ULONG *pLen);
  94. //
  95. // This returns the tag and length of the first element in a SET, SET OF
  96. // or SEQUENCE OF data value.
  97. //
  98. // LBER_DEFAULT is returned if the constructed value is empty else, the tag
  99. // is returned. It also returns an opaque cookie which has to be passed to
  100. // subsequent invocations of ber_next_element().
  101. //
  102. WINBERAPI ULONG BERAPI ber_first_element( BerElement *pBerElement, ULONG *pLen, CHAR **ppOpaque );
  103. //
  104. // This positions the state at the start of the next element in the
  105. // constructed type.
  106. //
  107. // LBER_DEFAULT is returned if the constructed value is empty else, the tag
  108. // is returned.
  109. //
  110. WINBERAPI ULONG BERAPI ber_next_element( BerElement *pBerElement, ULONG *pLen, CHAR *opaque );
  111. //
  112. // This allocates a BerVal structure whose contents are taken from the
  113. // supplied BerElement structure.
  114. //
  115. // The return values are 0 on success and -1 on error.
  116. //
  117. WINBERAPI INT BERAPI ber_flatten( BerElement *pBerElement, PBERVAL *pBerVal );
  118. /*
  119. The ber_printf() routine is used to encode a BER element in much the
  120. same way that sprintf() works.  One important difference, though, is
  121. that state information is kept in the ber argument so that multiple
  122. calls can be made to ber_printf() to append to the end of the BER ele-
  123. ment. ber MUST be a pointer to a BerElement returned by ber_alloc_t().
  124. ber_printf() interprets and formats its arguments according to the for-
  125. mat string fmt.  ber_printf() returns -1 if there is an error during
  126. encoding and a non-negative number if successful.  As with sprintf(),
  127. each character in fmt refers to an argument to ber_printf().
  128.  
  129. The format string can contain the following format characters:
  130. 't'     Tag.  The next argument is a ber_tag_t specifying the tag to
  131.         override the next element to be written to the ber.  This works
  132.         across calls.  The integer tag value SHOULD contain the tag
  133.         class, constructed bit, and tag value.  For example, a tag of
  134.         "[3]" for a constructed type is 0xA3U.  All implementations MUST
  135.         support tags that fit in a single octet (i.e., where the tag
  136.         value is less than 32) and they MAY support larger tags.
  137. 'b'     Boolean.  The next argument is an ber_int_t, containing either 0
  138.         for FALSE or 0xff for TRUE.  A boolean element is output.  If
  139.         this format character is not preceded by the 't' format modif-
  140.         ier, the tag 0x01U is used for the element.
  141. 'e'     Enumerated.  The next argument is a ber_int_t, containing the
  142.         enumerated value in the host's byte order.  An enumerated ele-
  143.         ment is output.  If this format character is not preceded by the
  144.         't' format modifier, the tag 0x0AU is used for the element.
  145. 'i'     Integer.  The next argument is a ber_int_t, containing the
  146.         integer in the host's byte order.  An integer element is output.
  147.         If this format character is not preceded by the 't' format
  148.         modifier, the tag 0x02U is used for the element.
  149. 'n'     Null.  No argument is needed.  An ASN.1 NULL element is output.
  150.         If this format character is not preceded by the 't' format
  151.         modifier, the tag 0x05U is used for the element.
  152.         
  153. 'o'     Octet string.  The next two arguments are a char *, followed by
  154.         a ber_len_t with the length of the string.  The string MAY con-
  155.         tain null bytes and are do not have to be zero-terminated.   An
  156.         octet string element is output, in primitive form.  If this for-
  157.         mat character is not preceded by the 't' format modifier, the
  158.         tag 0x04U is used for the element.
  159. 's'     Octet string.  The next argument is a char * pointing to a
  160.         zero-terminated string.  An octet string element in primitive
  161.         form is output, which does not include the trailing '' (null)
  162.         byte. If this format character is not preceded by the 't' format
  163.         modifier, the tag 0x04U is used for the element.
  164. 'v'     Several octet strings.  The next argument is a char **, an array
  165.         of char * pointers to zero-terminated strings.  The last element
  166.         in the array MUST be a NULL pointer. The octet strings do not
  167.         include the trailing '' (null) byte.  Note that a construct
  168.         like '{v}' is used to get an actual SEQUENCE OF octet strings.
  169.         The 't' format modifier cannot be used with this format charac-
  170.         ter.
  171. 'V'     Several octet strings.  A NULL-terminated array of struct berval
  172.         *'s is supplied.  Note that a construct like '{V}' is used to
  173.         get an actual SEQUENCE OF octet strings. The 't' format modifier
  174.         cannot be used with this format character.
  175. '{'     Begin sequence.  No argument is needed.  If this format charac-
  176.         ter is not preceded by the 't' format modifier, the tag 0x30U is
  177.         used.
  178. '}'     End sequence.  No argument is needed.  The 't' format modifier
  179.         cannot be used with this format character.
  180. '['     Begin set.  No argument is needed.  If this format character is
  181.         not preceded by the 't' format modifier, the tag 0x31U is used.
  182. ']'     End set.  No argument is needed.  The 't' format modifier cannot
  183.         be used with this format character.
  184. */
  185. WINBERAPI INT BERAPI ber_printf( BerElement *pBerElement, PCHAR fmt, ... );
  186. /*
  187. The ber_scanf() routine is used to decode a BER element in much the same
  188. way that sscanf() works.  One important difference, though, is that some
  189. state information is kept with the ber argument so that multiple calls
  190. can be made to ber_scanf() to sequentially read from the BER element.
  191. The ber argument SHOULD be a pointer to a BerElement returned by
  192. ber_init().  ber_scanf interprets the bytes according to the format
  193. string fmt, and stores the results in its additional arguments.
  194. ber_scanf() returns LBER_ERROR on error, and a different value on suc-
  195. cess.
  196. The format string contains conversion specifications which are used to
  197. direct the interpretation of the BER element.  The format string can
  198. contain the following characters:
  199. 'a'     Octet string.  A char ** argument MUST be supplied.  Memory is
  200.         allocated, filled with the contents of the octet string, zero-
  201.         terminated, and the pointer to the string is stored in the argu-
  202.         ment.  The returned value SHOULD be freed using ldap_memfree.
  203.         The tag of the element MUST indicate the primitive form
  204.         (constructed strings are not supported) but is otherwise ignored
  205.         and discarded during the decoding.  This format cannot be used
  206.         with octet strings which could contain null bytes.        
  207.         
  208. 'O'     Octet string.  A struct berval ** argument MUST be supplied,
  209.         which upon return points to an allocated struct berval contain-
  210.         ing the octet string and its length.  ber_bvfree() SHOULD be
  211.         called to free the allocated memory.  The tag of the element
  212.         MUST indicate the primitive form (constructed strings are not
  213.         supported) but is otherwise ignored during the decoding.
  214. 'b'     Boolean.  A pointer to a ber_int_t MUST be supplied. The
  215.         ber_int_t value stored will be 0 for FALSE or nonzero for TRUE.
  216.         The tag of the element MUST indicate the primitive form but is
  217.         otherwise ignored during the decoding.
  218. 'e'     Enumerated.  A pointer to a ber_int_t MUST be supplied. The
  219.         enumerated value stored will be in host byte order.  The tag of
  220.         the element MUST indicate the primitive form but is otherwise
  221.         ignored during the decoding.  ber_scanf() will return an error
  222.         if the value of the enumerated value cannot be stored in a
  223.         ber_int_t.
  224. 'i'     Integer.  A pointer to a ber_int_t MUST be supplied. The
  225.         ber_int_t value stored will be in host byte order.  The tag of
  226.         the element MUST indicate the primitive form but is otherwise
  227.         ignored during the decoding.  ber_scanf() will return an error
  228.         if the integer cannot be stored in a ber_int_t.
  229. 'B'     Bitstring.  A char ** argument MUST be supplied which will point
  230.         to the allocated bits, followed by a ber_len_t * argument, which
  231.         will point to the length (in bits) of the bitstring returned.
  232.         ldap_memfree SHOULD be called to free the bitstring.  The tag of
  233.         the element MUST indicate the primitive form (constructed bit-
  234.         strings are not supported) but is otherwise ignored during the
  235.         decoding.
  236. 'n'     Null.  No argument is needed.  The element is verified to have a
  237.         zero-length value and is skipped.  The tag is ignored.
  238. 'v'     Several octet strings.  A char *** argument MUST be supplied,
  239.         which upon return points to an allocated NULL-terminated array
  240.         of char *'s containing the octet strings.  NULL is stored if the
  241.         sequence is empty.  ldap_memfree SHOULD be called to free each
  242.         element of the array and the array itself.  The tag of the
  243.         sequence and of the octet strings are ignored.
  244. 'V'     Several octet strings (which could contain null bytes).  A
  245.         struct berval *** MUST be supplied, which upon return points to
  246.         a allocated NULL-terminated array of struct berval *'s contain-
  247.         ing the octet strings and their lengths.  NULL is stored if the
  248.         sequence is empty. ber_bvecfree() can be called to free the
  249.         allocated memory.  The tag of the sequence and of the octet
  250.         strings are ignored.
  251. 'x'     Skip element.  The next element is skipped.  No argument is
  252.         needed.
  253. '{'     Begin sequence.  No argument is needed.  The initial sequence
  254.         tag and length are skipped.
  255. '}'     End sequence.  No argument is needed.
  256. '['     Begin set.  No argument is needed.  The initial set tag and
  257.         length are skipped.
  258. ']'     End set.  No argument is needed.
  259. */
  260. WINBERAPI ULONG BERAPI ber_scanf( BerElement *pBerElement, PCHAR fmt, ... );
  261. #ifdef __cplusplus
  262. }
  263. #endif
  264. #endif  // _WINBER_DEFINED_