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

   1 /*
   2  * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms are permitted only
   6  * as authorized by the OpenLDAP Public License.  A copy of this
   7  * license is available at http://www.OpenLDAP.org/license.html or
   8  * in file LICENSE in the top-level directory of the distribution.
   9  */
  10 /* Portions
  11  * Copyright (c) 1990 Regents of the University of Michigan.
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms are permitted
  15  * provided that this notice is preserved and that due credit is given
  16  * to the University of Michigan at Ann Arbor. The name of the University
  17  * may not be used to endorse or promote products derived from this
  18  * software without specific prior written permission. This software
  19  * is provided ``as is'' without express or implied warranty.
  20  */
  21
  22 #ifndef _LBER_H
  23 #define _LBER_H
  24
  25 #include <ldap_cdefs.h>
  26
  27 LDAP_BEGIN_DECL
  28
  29 /* BER classes and mask */
  30 #define LBER_CLASS_UNIVERSAL    0x00
  31 #define LBER_CLASS_APPLICATION  0x40
  32 #define LBER_CLASS_CONTEXT      0x80
  33 #define LBER_CLASS_PRIVATE      0xc0
  34 #define LBER_CLASS_MASK         0xc0
  35
  36 /* BER encoding type and mask */
  37 #define LBER_PRIMITIVE          0x00
  38 #define LBER_CONSTRUCTED        0x20
  39 #define LBER_ENCODING_MASK      0x20
  40
  41 #define LBER_BIG_TAG_MASK       0x1f
  42 #define LBER_MORE_TAG_MASK      0x80
  43
  44 /*
  45  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
  46  * as valid BER tags, and so it is safe to use them to report errors.  In
  47  * fact, any tag for which the following is true is invalid:
  48  *     (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
  49  */
  50 #define LBER_ERROR              0xffffffffL
  51 #define LBER_DEFAULT            0xffffffffL
  52
  53 /* general BER types we know about */
  54 #define LBER_BOOLEAN            0x01L
  55 #define LBER_INTEGER            0x02L
  56 #define LBER_BITSTRING          0x03L
  57 #define LBER_OCTETSTRING        0x04L
  58 #define LBER_NULL               0x05L
  59 #define LBER_ENUMERATED         0x0aL
  60 #define LBER_SEQUENCE           0x30L   /* constructed */
  61 #define LBER_SET                0x31L   /* constructed */
  62
  63 #define OLD_LBER_SEQUENCE       0x10L   /* w/o constructed bit - broken */
  64 #define OLD_LBER_SET            0x11L   /* w/o constructed bit - broken */
  65
  66 typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
  67         unsigned long *buflenp,
  68         int free_input ));
  69
  70 typedef struct berelement {
  71         char            *ber_buf;
  72         char            *ber_ptr;
  73         char            *ber_end;
  74         struct seqorset *ber_sos;
  75         unsigned long   ber_tag;
  76         unsigned long   ber_len;
  77         int             ber_usertag;
  78         char            ber_options;
  79 #define LBER_USE_DER            0x01
  80 #define LBER_USE_INDEFINITE_LEN 0x02
  81 #define LBER_TRANSLATE_STRINGS  0x04
  82         char            *ber_rwptr;
  83         BERTranslateProc ber_encode_translate_proc;
  84         BERTranslateProc ber_decode_translate_proc;
  85 } BerElement;
  86 #define NULLBER ((BerElement *) 0)
  87
  88 typedef struct sockbuf {
  89 #ifndef MACOS
  90         int             sb_sd;
  91 #else /* MACOS */
  92         void            *sb_sd;
  93 #endif /* MACOS */
  94         BerElement      sb_ber;
  95
  96         int             sb_naddr;       /* > 0 implies using CLDAP (UDP) */
  97         void            *sb_useaddr;    /* pointer to sockaddr to use next */
  98         void            *sb_fromaddr;   /* pointer to message source sockaddr */
  99         void            **sb_addrs;     /* actually an array of pointers to
 100                                                 sockaddrs */
 101
 102         int             sb_options;     /* to support copying ber elements */
 103 #define LBER_TO_FILE            0x01    /* to a file referenced by sb_fd   */
 104 #define LBER_TO_FILE_ONLY       0x02    /* only write to file, not network */
 105 #define LBER_MAX_INCOMING_SIZE  0x04    /* impose limit on incoming stuff  */
 106 #define LBER_NO_READ_AHEAD      0x08    /* read only as much as requested  */
 107         int             sb_fd;
 108         long            sb_max_incoming;
 109 } Sockbuf;
 110 #define READBUFSIZ      8192
 111
 112 typedef struct seqorset {
 113         BerElement      *sos_ber;
 114         unsigned long   sos_clen;
 115         unsigned long   sos_tag;
 116         char            *sos_first;
 117         char            *sos_ptr;
 118         struct seqorset *sos_next;
 119 } Seqorset;
 120 #define NULLSEQORSET    ((Seqorset *) 0)
 121
 122 /* structure for returning a sequence of octet strings + length */
 123 struct berval {
 124         unsigned long   bv_len;
 125         char            *bv_val;
 126 };
 127
 128 #ifdef LDAP_DEBUG
 129 extern int lber_debug;
 130 #endif
 131
 132 /*
 133  * in bprint.c:
 134  */
 135 LDAP_F void lber_bprint LDAP_P(( char *data, int len ));
 136
 137 /*
 138  * in decode.c:
 139  */
 140 LDAP_F unsigned long ber_get_tag LDAP_P(( BerElement *ber ));
 141 LDAP_F unsigned long ber_skip_tag LDAP_P(( BerElement *ber, unsigned long *len ));
 142 LDAP_F unsigned long ber_peek_tag LDAP_P(( BerElement *ber, unsigned long *len ));
 143 LDAP_F unsigned long ber_get_int LDAP_P(( BerElement *ber, long *num ));
 144 LDAP_F unsigned long ber_get_stringb LDAP_P(( BerElement *ber, char *buf,
 145         unsigned long *len ));
 146 LDAP_F unsigned long ber_get_stringa LDAP_P(( BerElement *ber, char **buf ));
 147 LDAP_F unsigned long ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv ));
 148 LDAP_F unsigned long ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf,
 149         unsigned long *len ));
 150 LDAP_F unsigned long ber_get_null LDAP_P(( BerElement *ber ));
 151 LDAP_F unsigned long ber_get_boolean LDAP_P(( BerElement *ber, int *boolval ));
 152 LDAP_F unsigned long ber_first_element LDAP_P(( BerElement *ber, unsigned long *len,
 153         char **last ));
 154 LDAP_F unsigned long ber_next_element LDAP_P(( BerElement *ber, unsigned long *len,
 155         char *last ));
 156 LDAP_F unsigned long ber_scanf LDAP_P(( BerElement *ber, char *fmt, ... ));
 157 LDAP_F void ber_bvfree LDAP_P(( struct berval *bv ));
 158 LDAP_F void ber_bvecfree LDAP_P(( struct berval **bv ));
 159 LDAP_F struct berval *ber_bvdup LDAP_P(( struct berval *bv ));
 160 LDAP_F void ber_set_string_translators LDAP_P(( BerElement *ber,
 161         BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 162
 163 /*
 164  * in encode.c
 165  */
 166 LDAP_F int ber_put_enum LDAP_P(( BerElement *ber, long num, unsigned long tag ));
 167 LDAP_F int ber_put_int LDAP_P(( BerElement *ber, long num, unsigned long tag ));
 168 LDAP_F int ber_put_ostring LDAP_P(( BerElement *ber, char *str, unsigned long len,
 169         unsigned long tag ));
 170 LDAP_F int ber_put_string LDAP_P(( BerElement *ber, char *str, unsigned long tag ));
 171 LDAP_F int ber_put_bitstring LDAP_P(( BerElement *ber, char *str,
 172         unsigned long bitlen, unsigned long tag ));
 173 LDAP_F int ber_put_null LDAP_P(( BerElement *ber, unsigned long tag ));
 174 LDAP_F int ber_put_boolean LDAP_P(( BerElement *ber, int boolval,
 175         unsigned long tag ));
 176 LDAP_F int ber_start_seq LDAP_P(( BerElement *ber, unsigned long tag ));
 177 LDAP_F int ber_start_set LDAP_P(( BerElement *ber, unsigned long tag ));
 178 LDAP_F int ber_put_seq LDAP_P(( BerElement *ber ));
 179 LDAP_F int ber_put_set LDAP_P(( BerElement *ber ));
 180 LDAP_F int ber_printf LDAP_P(( BerElement *ber, char *fmt, ... ));
 181
 182 /*
 183  * in io.c:
 184  */
 185
 186 LDAP_F long ber_read LDAP_P(( BerElement *ber, char *buf, unsigned long len ));
 187 LDAP_F long ber_write LDAP_P(( BerElement *ber, char *buf, unsigned long len,
 188         int nosos ));
 189 LDAP_F void ber_free LDAP_P(( BerElement *ber, int freebuf ));
 190 LDAP_F int ber_flush LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit ));
 191 LDAP_F BerElement *ber_alloc LDAP_P(( void ));
 192 LDAP_F BerElement *der_alloc LDAP_P(( void ));
 193 LDAP_F BerElement *ber_alloc_t LDAP_P(( int options ));
 194 LDAP_F BerElement *ber_dup LDAP_P(( BerElement *ber ));
 195 LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
 196 LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
 197 LDAP_F unsigned long ber_get_next LDAP_P(( Sockbuf *sb, unsigned long *len,
 198         BerElement *ber ));
 199 LDAP_F void ber_init LDAP_P(( BerElement *ber, int options ));
 200 LDAP_F void ber_reset LDAP_P(( BerElement *ber, int was_writing ));
 201
 202 LDAP_END_DECL
 203
 204 #endif /* _LBER_H */