X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;ds=inline;f=include%2Flber.h;h=d85ec9f38b0758a512216faf16c7a96f1cb50140;hb=26c7d69e8c30decc73374fcb41f0d711a1af3500;hp=45e9681cca38afaa6b7395ad8dcab64386ef4c1d;hpb=48e53c8487ec1949d0217a1ce15200c7a8fde0a4;p=openldap

diff --git a/include/lber.h b/include/lber.h
index 45e9681cca..d85ec9f38b 100644
--- a/include/lber.h
+++ b/include/lber.h
@@ -1,4 +1,14 @@
+/* $OpenLDAP$ */
 /*
+ * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms are permitted only
+ * as authorized by the OpenLDAP Public License.  A copy of this
+ * license is available at http://www.OpenLDAP.org/license.html or
+ * in file LICENSE in the top-level directory of the distribution.
+ */
+/* Portions
  * Copyright (c) 1990 Regents of the University of Michigan.
  * All rights reserved.
  *
@@ -13,162 +23,466 @@
 #ifndef _LBER_H
 #define _LBER_H
 
-#include <ldap_cdefs.h>
+#include <lber_types.h>
 
 LDAP_BEGIN_DECL
 
+/* Overview of LBER tag construction
+ *
+ *	Bits
+ *	______
+ *	8 7 | CLASS
+ *	0 0 = UNIVERSAL
+ *	0 1 = APPLICATION
+ *	1 0 = CONTEXT-SPECIFIC
+ *	1 1 = PRIVATE
+ *		_____
+ *		| 6 | DATA-TYPE
+ *		  0 = PRIMITIVE
+ *		  1 = CONSTRUCTED
+ *			___________
+ *			| 5 ... 1 | TAG-NUMBER
+ */
+
 /* BER classes and mask */
-#define LBER_CLASS_UNIVERSAL	0x00
-#define LBER_CLASS_APPLICATION	0x40
-#define LBER_CLASS_CONTEXT	0x80
-#define LBER_CLASS_PRIVATE	0xc0
-#define LBER_CLASS_MASK		0xc0
+#define LBER_CLASS_UNIVERSAL	((ber_tag_t) 0x00U)
+#define LBER_CLASS_APPLICATION	((ber_tag_t) 0x40U)
+#define LBER_CLASS_CONTEXT		((ber_tag_t) 0x80U)
+#define LBER_CLASS_PRIVATE		((ber_tag_t) 0xc0U)
+#define LBER_CLASS_MASK			((ber_tag_t) 0xc0U)
 
 /* BER encoding type and mask */
-#define LBER_PRIMITIVE		0x00
-#define LBER_CONSTRUCTED	0x20
-#define LBER_ENCODING_MASK	0x20
+#define LBER_PRIMITIVE			((ber_tag_t) 0x00U)
+#define LBER_CONSTRUCTED		((ber_tag_t) 0x20U)
+#define LBER_ENCODING_MASK		((ber_tag_t) 0x20U)
 
-#define LBER_BIG_TAG_MASK	0x1f
-#define LBER_MORE_TAG_MASK	0x80
+#define LBER_BIG_TAG_MASK		((ber_tag_t) 0x1fU)
+#define LBER_MORE_TAG_MASK		((ber_tag_t) 0x80U)
 
 /*
  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
  * as valid BER tags, and so it is safe to use them to report errors.  In
  * fact, any tag for which the following is true is invalid:
- *     (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
  */
-#define LBER_ERROR		0xffffffffL
-#define LBER_DEFAULT		0xffffffffL
-#define LBER_END_SEQORSET	0xfffffffeL
+#define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080UL) \
+	&& (((t) & (ber_tag_t) ~ 0x0FF))
+
+#define LBER_ERROR			((ber_tag_t) -1)
+#define LBER_DEFAULT		((ber_tag_t) -1)
 
 /* general BER types we know about */
-#define LBER_BOOLEAN		0x01L
-#define LBER_INTEGER		0x02L
-#define LBER_BITSTRING		0x03L
-#define LBER_OCTETSTRING	0x04L
-#define LBER_NULL		0x05L
-#define LBER_ENUMERATED		0x0aL
-#define LBER_SEQUENCE		0x30L	/* constructed */
-#define LBER_SET		0x31L	/* constructed */
-
-#define OLD_LBER_SEQUENCE	0x10L	/* w/o constructed bit - broken */
-#define OLD_LBER_SET		0x11L	/* w/o constructed bit - broken */
+#define LBER_BOOLEAN		((ber_tag_t) 0x01UL)
+#define LBER_INTEGER		((ber_tag_t) 0x02UL)
+#define LBER_BITSTRING		((ber_tag_t) 0x03UL)
+#define LBER_OCTETSTRING	((ber_tag_t) 0x04UL)
+#define LBER_NULL			((ber_tag_t) 0x05UL)
+#define LBER_ENUMERATED		((ber_tag_t) 0x0aUL)
+#define LBER_SEQUENCE		((ber_tag_t) 0x30UL)	/* constructed */
+#define LBER_SET			((ber_tag_t) 0x31UL)	/* constructed */
 
-/* get/set options for BerElement */
-#define LBER_SOCKBUF_OPT_TO_FILE				0x01
-#define LBER_SOCKBUF_OPT_TO_FILE_ONLY			0x02
-#define	LBER_SOCKBUF_OPT_TO_MAX_INCOMING_SIZE	0x04
-#define LBER_SOCKBUF_OPT_TO_NO_READ_AHEAD		0x08
-#define LBER_SOCKBUF_OPT_TO_DESC				0x10
-#define	LBER_SOCKBUF_OPT_TO_COPYDESC			0x20
-#define LBER_SOCKBUF_OPT_TO_READFN				0x40
-#define LBER_SOCKBUF_OPT_TO_WRITE_FN			0x80
-
-/* LBER on/off values */
-#define LBER_OPT_ON ((void *) 1)
-#define LBER_OPT_OFF ((void *) 0)
-
-typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
-	unsigned long *buflenp,
+typedef int (*BERTranslateProc) LDAP_P((
+	char **bufp,
+	ber_len_t *buflenp,
 	int free_input ));
 
+/* LBER BerElement options */
 #define LBER_USE_DER		0x01
 #define LBER_USE_INDEFINITE_LEN	0x02
 #define LBER_TRANSLATE_STRINGS	0x04
 
-typedef struct berelement BerElement;
-#define NULLBER	((BerElement *) 0)
+/* get/set options for BerElement */
+#define LBER_OPT_BER_OPTIONS			0x01
+#define LBER_OPT_BER_DEBUG				0x02
+#define LBER_OPT_BER_REMAINING_BYTES	0x03
+#define LBER_OPT_BER_TOTAL_BYTES		0x04
+#define LBER_OPT_BER_BYTES_TO_WRITE		0x05
 
-typedef struct sockbuf Sockbuf;
-#define READBUFSIZ	8192
+#define LBER_OPT_DEBUG_LEVEL	LBER_OPT_BER_DEBUG
+#define LBER_OPT_REMAINING_BYTES	LBER_OPT_BER_REMAINING_BYTES
+#define LBER_OPT_TOTAL_BYTES		LBER_OPT_BER_TOTAL_BYTES
+#define LBER_OPT_BYTES_TO_WRITE		LBER_OPT_BER_BYTES_TO_WRITE
+
+#define LBER_OPT_LOG_PRINT_FN	0x8001
+#define LBER_OPT_MEMORY_FNS		0x8002
+#define LBER_OPT_ERROR_FN		0x8003
 
+typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
+
+typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
+
+typedef void* (*BER_MEMALLOC_FN)	LDAP_P(( ber_len_t size ));
+typedef void* (*BER_MEMCALLOC_FN)	LDAP_P(( ber_len_t n, ber_len_t size ));
+typedef void* (*BER_MEMREALLOC_FN)	LDAP_P(( void *p, ber_len_t size ));
+typedef void  (*BER_MEMFREE_FN)		LDAP_P(( void *p ));
+
+typedef struct lber_memory_fns {
+	BER_MEMALLOC_FN	bmf_malloc;
+	BER_MEMCALLOC_FN bmf_calloc;
+	BER_MEMREALLOC_FN bmf_realloc;
+	BER_MEMFREE_FN bmf_free;
+} BerMemoryFunctions;
+
+/* LBER Sockbuf options */ 
+#define LBER_TO_FILE           0x01	/* to a file referenced by sb_fd   */
+#define LBER_TO_FILE_ONLY      0x02	/* only write to file, not network */
+#define LBER_MAX_INCOMING_SIZE 0x04	/* impose limit on incoming stuff  */
+#define LBER_NO_READ_AHEAD     0x08	/* read only as much as requested  */
+
+/* get/set options for Sockbuf */
+#define LBER_OPT_SOCKBUF_DESC		0x1000
+#define LBER_OPT_SOCKBUF_OPTIONS	0x1001
+#define LBER_OPT_SOCKBUF_DEBUG		0x1002
+
+/* on/off values */
+#define LBER_OPT_ON		((void *) 1)
+#define LBER_OPT_OFF	((void *) 0)
+
+#define LBER_OPT_SUCCESS	(0)
+#define LBER_OPT_ERROR		(-1)
+
+typedef struct berelement BerElement;
+typedef struct sockbuf Sockbuf;
 typedef struct seqorset Seqorset;
-#define NULLSEQORSET ((Seqorset *) 0)
 
 /* structure for returning a sequence of octet strings + length */
-struct berval {
-	unsigned long	bv_len;
+typedef struct berval {
+	ber_len_t	bv_len;
 	char		*bv_val;
-};
+} BerValue;
 
-extern int lber_debug;
+/* this should be moved to lber-int.h */
 
 /*
  * in bprint.c:
  */
-LDAP_F void lber_bprint LDAP_P(( char *data, int len ));
+LIBLBER_F( void )
+ber_print_error LDAP_P((
+	LDAP_CONST char *data ));
+
+LIBLBER_F( void )
+ber_bprint LDAP_P((
+	LDAP_CONST char *data, ber_len_t len ));
+
+LIBLBER_F( void )
+ber_dump LDAP_P((
+	BerElement *ber, int inout ));
+
+LIBLBER_F( void )
+ber_sos_dump LDAP_P((
+	Seqorset *sos ));
+
 
 /*
  * in decode.c:
  */
-LDAP_F unsigned long ber_get_tag LDAP_P(( BerElement *ber ));
-LDAP_F unsigned long ber_skip_tag LDAP_P(( BerElement *ber, unsigned long *len ));
-LDAP_F unsigned long ber_peek_tag LDAP_P(( BerElement *ber, unsigned long *len ));
-LDAP_F unsigned long ber_get_int LDAP_P(( BerElement *ber, long *num ));
-LDAP_F unsigned long ber_get_stringb LDAP_P(( BerElement *ber, char *buf,
-	unsigned long *len ));
-LDAP_F unsigned long ber_get_stringa LDAP_P(( BerElement *ber, char **buf ));
-LDAP_F unsigned long ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv ));
-LDAP_F unsigned long ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf,
-	unsigned long *len ));
-LDAP_F unsigned long ber_get_null LDAP_P(( BerElement *ber ));
-LDAP_F unsigned long ber_get_boolean LDAP_P(( BerElement *ber, int *boolval ));
-LDAP_F unsigned long ber_first_element LDAP_P(( BerElement *ber, unsigned long *len,
+typedef int (*BERDecodeCallback) LDAP_P((
+	BerElement *ber,
+	void *data,
+	int mode ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_tag LDAP_P((
+	BerElement *ber ));
+
+LIBLBER_F( ber_tag_t )
+ber_skip_tag LDAP_P((
+	BerElement *ber,
+	ber_len_t *len ));
+
+LIBLBER_F( ber_tag_t )
+ber_peek_tag LDAP_P((
+	BerElement *ber,
+	ber_len_t *len ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_int LDAP_P((
+	BerElement *ber,
+	ber_int_t *num ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_stringb LDAP_P((
+	BerElement *ber,
+	char *buf,
+	ber_len_t *len ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_stringa LDAP_P((
+	BerElement *ber,
+	char **buf ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_stringal LDAP_P((
+	BerElement *ber,
+	struct berval **bv ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_bitstringa LDAP_P((
+	BerElement *ber,
+	char **buf,
+	ber_len_t *len ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_null LDAP_P((
+	BerElement *ber ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_boolean LDAP_P((
+	BerElement *ber,
+	ber_int_t *boolval ));
+
+LIBLBER_F( ber_tag_t )
+ber_first_element LDAP_P((
+	BerElement *ber,
+	ber_len_t *len,
 	char **last ));
-LDAP_F unsigned long ber_next_element LDAP_P(( BerElement *ber, unsigned long *len,
-	char *last ));
-LDAP_F unsigned long ber_scanf LDAP_P(( BerElement *ber, char *fmt, ... ));
-LDAP_F void ber_bvfree LDAP_P(( struct berval *bv ));
-LDAP_F void ber_bvecfree LDAP_P(( struct berval **bv ));
-LDAP_F struct berval *ber_bvdup LDAP_P(( struct berval *bv ));
-LDAP_F void ber_set_string_translators LDAP_P(( BerElement *ber,
-	BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
+
+LIBLBER_F( ber_tag_t )
+ber_next_element LDAP_P((
+	BerElement *ber,
+	ber_len_t *len,
+	LDAP_CONST char *last ));
+
+LIBLBER_F( ber_tag_t )
+ber_scanf LDAP_P((								  
+	BerElement *ber,
+	LDAP_CONST char *fmt,
+	... ));
+
+LIBLBER_F( void )
+ber_set_string_translators LDAP_P((
+	BerElement *ber,
+	BERTranslateProc encode_proc,
+	BERTranslateProc decode_proc ));
 
 /*
  * in encode.c
  */
-LDAP_F int ber_put_enum LDAP_P(( BerElement *ber, long num, unsigned long tag ));
-LDAP_F int ber_put_int LDAP_P(( BerElement *ber, long num, unsigned long tag ));
-LDAP_F int ber_put_ostring LDAP_P(( BerElement *ber, char *str, unsigned long len,
-	unsigned long tag ));
-LDAP_F int ber_put_string LDAP_P(( BerElement *ber, char *str, unsigned long tag ));
-LDAP_F int ber_put_bitstring LDAP_P(( BerElement *ber, char *str,
-	unsigned long bitlen, unsigned long tag ));
-LDAP_F int ber_put_null LDAP_P(( BerElement *ber, unsigned long tag ));
-LDAP_F int ber_put_boolean LDAP_P(( BerElement *ber, int boolval,
-	unsigned long tag ));
-LDAP_F int ber_start_seq LDAP_P(( BerElement *ber, unsigned long tag ));
-LDAP_F int ber_start_set LDAP_P(( BerElement *ber, unsigned long tag ));
-LDAP_F int ber_put_seq LDAP_P(( BerElement *ber ));
-LDAP_F int ber_put_set LDAP_P(( BerElement *ber ));
-LDAP_F int ber_printf LDAP_P(( BerElement *ber, char *fmt, ... ));
-LDAP_F int ber_fatten LDAP_P(( BerElement *ber, struct berval **bvPtr));
+typedef int (*BEREncodeCallback) LDAP_P((
+	BerElement *ber,
+	void *data ));
+
+LIBLBER_F( int )
+ber_put_enum LDAP_P((
+	BerElement *ber,
+	ber_int_t num,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_int LDAP_P((
+	BerElement *ber,
+	ber_int_t num,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_ostring LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *str,
+	ber_len_t len,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_berval LDAP_P((
+	BerElement *ber,
+	LDAP_CONST struct berval *bv,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_string LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *str,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_bitstring LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *str,
+	ber_len_t bitlen,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_null LDAP_P((
+	BerElement *ber,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_boolean LDAP_P((
+	BerElement *ber,
+	ber_int_t boolval,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_start_seq LDAP_P((
+	BerElement *ber,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_start_set LDAP_P((
+	BerElement *ber,
+	ber_tag_t tag ));
+
+LIBLBER_F( int )
+ber_put_seq LDAP_P((
+	BerElement *ber ));
+
+LIBLBER_F( int )
+ber_put_set LDAP_P((
+	BerElement *ber ));
+
+LIBLBER_F( int )
+ber_printf LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *fmt,
+	... ));
+
+
 /*
  * in io.c:
  */
 
-LDAP_F long ber_read LDAP_P(( BerElement *ber, char *buf, unsigned long len ));
-LDAP_F long ber_write LDAP_P(( BerElement *ber, char *buf, unsigned long len,
+LIBLBER_F( ber_slen_t )
+ber_read LDAP_P((
+	BerElement *ber,
+	char *buf,
+	ber_len_t len ));
+
+LIBLBER_F( ber_slen_t )
+ber_write LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *buf,
+	ber_len_t len,
 	int nosos ));
-LDAP_F void ber_free LDAP_P(( BerElement *ber, int freebuf ));
-LDAP_F int ber_flush LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit ));
-LDAP_F BerElement *ber_alloc LDAP_P(( void ));
-LDAP_F BerElement *der_alloc LDAP_P(( void ));
-LDAP_F BerElement *ber_alloc_t LDAP_P(( int options ));
-LDAP_F BerElement *ber_dup LDAP_P(( BerElement *ber ));
-LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
-LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
-LDAP_F unsigned long ber_get_next LDAP_P(( Sockbuf *sb, unsigned long *len,
+
+LIBLBER_F( void )
+ber_free LDAP_P((
+	BerElement *ber,
+	int freebuf ));
+
+LIBLBER_F( int )
+ber_flush LDAP_P((
+	Sockbuf *sb,
+	BerElement *ber,
+	int freeit ));
+
+LIBLBER_F( BerElement * )
+ber_alloc LDAP_P(( void )); /* DEPRECATED */
+
+LIBLBER_F( BerElement * )
+der_alloc LDAP_P(( void )); /* DEPRECATED */
+
+LIBLBER_F( BerElement * )
+ber_alloc_t LDAP_P((
+	int beroptions ));
+
+LIBLBER_F( BerElement * )
+ber_dup LDAP_P((
 	BerElement *ber ));
-LDAP_F void ber_init_w_nullc LDAP_P(( BerElement *ber, int options ));
-LDAP_F void ber_reset LDAP_P(( BerElement *ber, int was_writing ));
+
+LIBLBER_F( ber_tag_t )
+ber_get_next LDAP_P((
+	Sockbuf *sb,
+	ber_len_t *len,
+	BerElement *ber ));
+
+LIBLBER_F( void )
+ber_init_w_nullc LDAP_P((
+	BerElement *ber,
+	int options ));
+
+LIBLBER_F( void )
+ber_reset LDAP_P((
+	BerElement *ber,
+	int was_writing ));
+
+LIBLBER_F( BerElement * )
+ber_init LDAP_P((
+	struct berval *bv ));
+
+LIBLBER_F( int )
+ber_flatten LDAP_P((
+	BerElement *ber,
+	struct berval **bvPtr ));
 
 /*
- * LDAPv3 routines (not yet implemented)
+ * LBER ber accessor functions
  */
-LDAP_F BerElement *ber_init LDAP_P(( struct berval *bv ));
-LDAP_F int ber_flatten LDAP_P(( BerElement *ber, struct berval **bvPtr ));
+
+LIBLBER_F( int )
+ber_get_option LDAP_P((
+	void *item,
+	int option,
+	void *outvalue));
+
+LIBLBER_F( int )
+ber_set_option LDAP_P((
+	void *item,
+	int option,
+	LDAP_CONST void *invalue));
+
+/*
+ * LBER sockbuf.c
+ */
+
+LIBLBER_F( Sockbuf * )
+ber_sockbuf_alloc( void );
+
+LIBLBER_F( Sockbuf *  )
+ber_sockbuf_alloc_fd(
+	ber_socket_t fd );
+
+LIBLBER_F( void )
+ber_sockbuf_free(
+	Sockbuf *sb );
+
+/*
+ * LBER memory.c
+ */
+LIBLBER_F( void * )
+ber_memalloc LDAP_P((
+	ber_len_t s ));
+
+LIBLBER_F( void * )
+ber_memrealloc LDAP_P((
+	void* p,
+	ber_len_t s ));
+
+LIBLBER_F( void * )
+ber_memcalloc LDAP_P((
+	ber_len_t n,
+	ber_len_t s ));
+
+LIBLBER_F( void )
+ber_memfree LDAP_P((
+	void* p ));
+
+LIBLBER_F( void )
+ber_memvfree LDAP_P((
+	void** vector ));
+
+LIBLBER_F( void )
+ber_bvfree LDAP_P((
+	struct berval *bv ));
+
+LIBLBER_F( void )
+ber_bvecfree LDAP_P((
+	struct berval **bv ));
+
+LIBLBER_F( struct berval * )
+ber_bvdup LDAP_P((
+	LDAP_CONST struct berval *bv ));
+
+LIBLBER_F( char * )
+ber_strdup LDAP_P((
+	LDAP_CONST char * ));
+
+/*
+ * error.c
+ */
+LIBLBER_F( int * ) ber_errno_addr LDAP_P((void));
+#define ber_errno (*(ber_errno_addr)())
+
+#define LBER_ERROR_NONE		0
+#define LBER_ERROR_PARAM	0x1
+#define LBER_ERROR_MEMORY	0x2
 
 LDAP_END_DECL