git.sur5r.net Git - openldap/blob - include/lber.h

   1 /*
   2  * Copyright (c) 1990 Regents of the University of Michigan.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms are permitted
   6  * provided that this notice is preserved and that due credit is given
   7  * to the University of Michigan at Ann Arbor. The name of the University
   8  * may not be used to endorse or promote products derived from this
   9  * software without specific prior written permission. This software
  10  * is provided ``as is'' without express or implied warranty.
  11  */
  12
  13 #ifndef _LBER_H
  14 #define _LBER_H
  15
  16 #include <ldap_cdefs.h>
  17
  18 LDAP_BEGIN_DECL
  19
  20 /* BER classes and mask */
  21 #define LBER_CLASS_UNIVERSAL    0x00
  22 #define LBER_CLASS_APPLICATION  0x40
  23 #define LBER_CLASS_CONTEXT      0x80
  24 #define LBER_CLASS_PRIVATE      0xc0
  25 #define LBER_CLASS_MASK         0xc0
  26
  27 /* BER encoding type and mask */
  28 #define LBER_PRIMITIVE          0x00
  29 #define LBER_CONSTRUCTED        0x20
  30 #define LBER_ENCODING_MASK      0x20
  31
  32 #define LBER_BIG_TAG_MASK       0x1f
  33 #define LBER_MORE_TAG_MASK      0x80
  34
  35 /*
  36  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
  37  * as valid BER tags, and so it is safe to use them to report errors.  In
  38  * fact, any tag for which the following is true is invalid:
  39  *     (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
  40  */
  41 #define LBER_ERROR              0xffffffffL
  42 #define LBER_DEFAULT            0xffffffffL
  43 /* #define LBER_END_SEQORSET    0xfffffffeL *//* no part of LDAP C-API */
  44
  45 /* general BER types we know about */
  46 #define LBER_BOOLEAN            0x01L
  47 #define LBER_INTEGER            0x02L
  48 #define LBER_BITSTRING          0x03L
  49 #define LBER_OCTETSTRING        0x04L
  50 #define LBER_NULL               0x05L
  51 #define LBER_ENUMERATED         0x0aL
  52 #define LBER_SEQUENCE           0x30L   /* constructed */
  53 #define LBER_SET                0x31L   /* constructed */
  54
  55 #define OLD_LBER_SEQUENCE       0x10L   /* w/o constructed bit - broken */
  56 #define OLD_LBER_SET            0x11L   /* w/o constructed bit - broken */
  57
  58 typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
  59         unsigned long *buflenp,
  60         int free_input ));
  61
  62 /* LBER BerElement options */
  63 #define LBER_USE_DER            0x01
  64 #define LBER_USE_INDEFINITE_LEN 0x02
  65 #define LBER_TRANSLATE_STRINGS  0x04
  66
  67 /* get/set options for BerElement */
  68 #define LBER_OPT_BER_OPTIONS    0x01
  69 #define LBER_OPT_BER_DEBUG              0x02
  70 #define LBER_OPT_DEBUG_LEVEL    LBER_OPT_BER_DEBUG
  71
  72 /* LBER Sockbuf options */
  73 #define LBER_TO_FILE           0x01     /* to a file referenced by sb_fd   */
  74 #define LBER_TO_FILE_ONLY      0x02     /* only write to file, not network */
  75 #define LBER_MAX_INCOMING_SIZE 0x04     /* impose limit on incoming stuff  */
  76 #define LBER_NO_READ_AHEAD     0x08     /* read only as much as requested  */
  77
  78 /* get/set options for Sockbuf */
  79 #define LBER_OPT_SOCKBUF_DESC           0x1000
  80 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
  81 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
  82
  83 /* on/off values */
  84 #define LBER_OPT_ON             ((void *) 1)
  85 #define LBER_OPT_OFF    ((void *) 0)
  86
  87 #define LBER_OPT_SUCCESS        0
  88 #define LBER_OPT_ERROR          (-1)
  89
  90 typedef struct berelement BerElement;
  91 #define NULLBER ((BerElement *) 0)
  92
  93 typedef struct sockbuf Sockbuf;
  94
  95 typedef struct seqorset Seqorset;
  96 #define NULLSEQORSET ((Seqorset *) 0)
  97
  98 /* structure for returning a sequence of octet strings + length */
  99 struct berval {
 100         unsigned long   bv_len;
 101         char            *bv_val;
 102 };
 103
 104 /*
 105  * in bprint.c:
 106  */
 107 LDAP_F void ber_print_error LDAP_P(( char *data ));
 108 LDAP_F void ber_bprint LDAP_P(( char *data, int len ));
 109 #define lber_bprint(d,l)       ber_bprint((d),(l))
 110
 111 LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
 112 LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
 113
 114
 115 /*
 116  * in decode.c:
 117  */
 118 LDAP_F unsigned long ber_get_tag LDAP_P(( BerElement *ber ));
 119 LDAP_F unsigned long ber_skip_tag LDAP_P(( BerElement *ber, unsigned long *len ));
 120 LDAP_F unsigned long ber_peek_tag LDAP_P(( BerElement *ber, unsigned long *len ));
 121 LDAP_F unsigned long ber_get_int LDAP_P(( BerElement *ber, long *num ));
 122 LDAP_F unsigned long ber_get_stringb LDAP_P(( BerElement *ber, char *buf,
 123         unsigned long *len ));
 124 LDAP_F unsigned long ber_get_stringa LDAP_P(( BerElement *ber, char **buf ));
 125 LDAP_F unsigned long ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv ));
 126 LDAP_F unsigned long ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf,
 127         unsigned long *len ));
 128 LDAP_F unsigned long ber_get_null LDAP_P(( BerElement *ber ));
 129 LDAP_F unsigned long ber_get_boolean LDAP_P(( BerElement *ber, int *boolval ));
 130 LDAP_F unsigned long ber_first_element LDAP_P(( BerElement *ber, unsigned long *len,
 131         char **last ));
 132 LDAP_F unsigned long ber_next_element LDAP_P(( BerElement *ber, unsigned long *len,
 133         char *last ));
 134 LDAP_F unsigned long ber_scanf LDAP_P(( BerElement *ber, char *fmt, ... ));
 135 LDAP_F void ber_bvfree LDAP_P(( struct berval *bv ));
 136 LDAP_F void ber_bvecfree LDAP_P(( struct berval **bv ));
 137 LDAP_F struct berval *ber_bvdup LDAP_P(( struct berval *bv ));
 138 LDAP_F void ber_set_string_translators LDAP_P(( BerElement *ber,
 139         BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 140
 141 /*
 142  * in encode.c
 143  */
 144 LDAP_F int ber_put_enum LDAP_P(( BerElement *ber, long num, unsigned long tag ));
 145 LDAP_F int ber_put_int LDAP_P(( BerElement *ber, long num, unsigned long tag ));
 146 LDAP_F int ber_put_ostring LDAP_P(( BerElement *ber, char *str, unsigned long len,
 147         unsigned long tag ));
 148 LDAP_F int ber_put_string LDAP_P(( BerElement *ber, char *str, unsigned long tag ));
 149 LDAP_F int ber_put_bitstring LDAP_P(( BerElement *ber, char *str,
 150         unsigned long bitlen, unsigned long tag ));
 151 LDAP_F int ber_put_null LDAP_P(( BerElement *ber, unsigned long tag ));
 152 LDAP_F int ber_put_boolean LDAP_P(( BerElement *ber, int boolval,
 153         unsigned long tag ));
 154 LDAP_F int ber_start_seq LDAP_P(( BerElement *ber, unsigned long tag ));
 155 LDAP_F int ber_start_set LDAP_P(( BerElement *ber, unsigned long tag ));
 156 LDAP_F int ber_put_seq LDAP_P(( BerElement *ber ));
 157 LDAP_F int ber_put_set LDAP_P(( BerElement *ber ));
 158 LDAP_F int ber_printf LDAP_P(( BerElement *ber, char *fmt, ... ));
 159 /*
 160  * in io.c:
 161  */
 162
 163 LDAP_F long ber_read LDAP_P(( BerElement *ber, char *buf, unsigned long len ));
 164 LDAP_F long ber_write LDAP_P(( BerElement *ber, char *buf, unsigned long len,
 165         int nosos ));
 166 LDAP_F void ber_free LDAP_P(( BerElement *ber, int freebuf ));
 167 LDAP_F int ber_flush LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit ));
 168 LDAP_F BerElement *ber_alloc LDAP_P(( void ));
 169 LDAP_F BerElement *der_alloc LDAP_P(( void ));
 170 LDAP_F BerElement *ber_alloc_t LDAP_P(( int options ));
 171 LDAP_F BerElement *ber_dup LDAP_P(( BerElement *ber ));
 172 LDAP_F unsigned long ber_get_next LDAP_P(( Sockbuf *sb, unsigned long *len,
 173         BerElement *ber ));
 174 LDAP_F void ber_init_w_nullc LDAP_P(( BerElement *ber, int options ));
 175 LDAP_F void ber_reset LDAP_P(( BerElement *ber, int was_writing ));
 176
 177 /*
 178  * LBER draft-ietf-ldapext-ldap-c-api-01 routines
 179  */
 180 LDAP_F BerElement *ber_init LDAP_P(( struct berval *bv ));
 181 LDAP_F int ber_flatten LDAP_P(( BerElement *ber, struct berval **bvPtr ));
 182
 183 /*
 184  * LBER ber accessor functions
 185  */
 186 LDAP_F int
 187 lber_get_option LDAP_P((void *item, int option, void *outvalue));
 188
 189 LDAP_F int
 190 lber_set_option LDAP_P((void *item, int option, void *invalue));
 191
 192 /*
 193  * LBER Sockbuf functions
 194  */
 195 LDAP_F Sockbuf *lber_sockbuf_alloc LDAP_P((void));
 196 LDAP_F Sockbuf *lber_sockbuf_alloc_fd LDAP_P((int fd));
 197 LDAP_F void lber_sockbuf_free LDAP_P((Sockbuf *sb));
 198
 199 LDAP_END_DECL
 200
 201 #endif /* _LBER_H */