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
  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 /* get/set options for BerElement */
  59 #define LBER_SOCKBUF_OPT_TO_FILE                                0x01
  60 #define LBER_SOCKBUF_OPT_TO_FILE_ONLY                   0x02
  61 #define LBER_SOCKBUF_OPT_TO_MAX_INCOMING_SIZE   0x04
  62 #define LBER_SOCKBUF_OPT_TO_NO_READ_AHEAD               0x08
  63 #define LBER_SOCKBUF_OPT_TO_DESC                                0x10
  64 #define LBER_SOCKBUF_OPT_TO_COPYDESC                    0x20
  65 #define LBER_SOCKBUF_OPT_TO_READFN                              0x40
  66 #define LBER_SOCKBUF_OPT_TO_WRITE_FN                    0x80
  67
  68 /* LBER on/off values */
  69 #define LBER_OPT_ON ((void *) 1)
  70 #define LBER_OPT_OFF ((void *) 0)
  71
  72 typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
  73         unsigned long *buflenp,
  74         int free_input ));
  75
  76 #define LBER_USE_DER            0x01
  77 #define LBER_USE_INDEFINITE_LEN 0x02
  78 #define LBER_TRANSLATE_STRINGS  0x04
  79
  80 typedef struct berelement BerElement;
  81 #define NULLBER ((BerElement *) 0)
  82
  83 typedef struct sockbuf Sockbuf;
  84 #define READBUFSIZ      8192
  85
  86 typedef struct seqorset Seqorset;
  87 #define NULLSEQORSET ((Seqorset *) 0)
  88
  89 /* structure for returning a sequence of octet strings + length */
  90 struct berval {
  91         unsigned long   bv_len;
  92         char            *bv_val;
  93 };
  94
  95 #ifdef LDAP_DEBUG
  96 extern int lber_debug;
  97 #endif
  98
  99 /*
 100  * in bprint.c:
 101  */
 102 LDAP_F void ber_print_error LDAP_P(( char *data ));
 103 LDAP_F void ber_bprint LDAP_P(( char *data, int len ));
 104 #define lber_bprint(d,l)        ber_bprint((d),(l))
 105
 106 /*
 107  * in decode.c:
 108  */
 109 LDAP_F unsigned long ber_get_tag LDAP_P(( BerElement *ber ));
 110 LDAP_F unsigned long ber_skip_tag LDAP_P(( BerElement *ber, unsigned long *len ));
 111 LDAP_F unsigned long ber_peek_tag LDAP_P(( BerElement *ber, unsigned long *len ));
 112 LDAP_F unsigned long ber_get_int LDAP_P(( BerElement *ber, long *num ));
 113 LDAP_F unsigned long ber_get_stringb LDAP_P(( BerElement *ber, char *buf,
 114         unsigned long *len ));
 115 LDAP_F unsigned long ber_get_stringa LDAP_P(( BerElement *ber, char **buf ));
 116 LDAP_F unsigned long ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv ));
 117 LDAP_F unsigned long ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf,
 118         unsigned long *len ));
 119 LDAP_F unsigned long ber_get_null LDAP_P(( BerElement *ber ));
 120 LDAP_F unsigned long ber_get_boolean LDAP_P(( BerElement *ber, int *boolval ));
 121 LDAP_F unsigned long ber_first_element LDAP_P(( BerElement *ber, unsigned long *len,
 122         char **last ));
 123 LDAP_F unsigned long ber_next_element LDAP_P(( BerElement *ber, unsigned long *len,
 124         char *last ));
 125 LDAP_F unsigned long ber_scanf LDAP_P(( BerElement *ber, char *fmt, ... ));
 126 LDAP_F void ber_bvfree LDAP_P(( struct berval *bv ));
 127 LDAP_F void ber_bvecfree LDAP_P(( struct berval **bv ));
 128 LDAP_F struct berval *ber_bvdup LDAP_P(( struct berval *bv ));
 129 LDAP_F void ber_set_string_translators LDAP_P(( BerElement *ber,
 130         BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 131
 132 /*
 133  * in encode.c
 134  */
 135 LDAP_F int ber_put_enum LDAP_P(( BerElement *ber, long num, unsigned long tag ));
 136 LDAP_F int ber_put_int LDAP_P(( BerElement *ber, long num, unsigned long tag ));
 137 LDAP_F int ber_put_ostring LDAP_P(( BerElement *ber, char *str, unsigned long len,
 138         unsigned long tag ));
 139 LDAP_F int ber_put_string LDAP_P(( BerElement *ber, char *str, unsigned long tag ));
 140 LDAP_F int ber_put_bitstring LDAP_P(( BerElement *ber, char *str,
 141         unsigned long bitlen, unsigned long tag ));
 142 LDAP_F int ber_put_null LDAP_P(( BerElement *ber, unsigned long tag ));
 143 LDAP_F int ber_put_boolean LDAP_P(( BerElement *ber, int boolval,
 144         unsigned long tag ));
 145 LDAP_F int ber_start_seq LDAP_P(( BerElement *ber, unsigned long tag ));
 146 LDAP_F int ber_start_set LDAP_P(( BerElement *ber, unsigned long tag ));
 147 LDAP_F int ber_put_seq LDAP_P(( BerElement *ber ));
 148 LDAP_F int ber_put_set LDAP_P(( BerElement *ber ));
 149 LDAP_F int ber_printf LDAP_P(( BerElement *ber, char *fmt, ... ));
 150 /*
 151  * in io.c:
 152  */
 153
 154 LDAP_F long ber_read LDAP_P(( BerElement *ber, char *buf, unsigned long len ));
 155 LDAP_F long ber_write LDAP_P(( BerElement *ber, char *buf, unsigned long len,
 156         int nosos ));
 157 LDAP_F void ber_free LDAP_P(( BerElement *ber, int freebuf ));
 158 LDAP_F int ber_flush LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit ));
 159 LDAP_F BerElement *ber_alloc LDAP_P(( void ));
 160 LDAP_F BerElement *der_alloc LDAP_P(( void ));
 161 LDAP_F BerElement *ber_alloc_t LDAP_P(( int options ));
 162 LDAP_F BerElement *ber_dup LDAP_P(( BerElement *ber ));
 163 LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
 164 LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
 165 LDAP_F unsigned long ber_get_next LDAP_P(( Sockbuf *sb, unsigned long *len,
 166         BerElement *ber ));
 167 LDAP_F void ber_init_w_nullc LDAP_P(( BerElement *ber, int options ));
 168 LDAP_F void ber_reset LDAP_P(( BerElement *ber, int was_writing ));
 169
 170 /*
 171  * LDAPv3 routines (not yet implemented)
 172  */
 173 LDAP_F BerElement *ber_init LDAP_P(( struct berval *bv ));
 174 LDAP_F int ber_flatten LDAP_P(( BerElement *ber, struct berval **bvPtr ));
 175
 176 LDAP_END_DECL
 177
 178 #endif /* _LBER_H */