Site Map | Careers | Contact Us

• PRODUCTS
• SUPPORT
• RESOURCES

• PARTNERS
• CUSTOMERS
• ABOUT US

Home > Support > Documentation

asn1ber.h

Go to the documentation of this file.

/*
 * Copyright (c) 1997-2006 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
/*
// CHANGE LOG
// Date         Init    Description
// 05/03/02     AB      Initial issue
// 05/06/02     AB      More only-BER things moved
// 05/10/02     AB      RELATIVE-OID
// 10/17/02     ED      Inline buffer save and restore macros
// 10/26/02     AB      UInt64 encode/decode funcs added
// 01/18/03     ED      Added more Doxygen comments
// 10/29/03     CZ      Added doxygen code for mainpage text.
//
*/
#ifndef _ASN1BER_H_
#define _ASN1BER_H_

#include "rtsrc/asn1type.h"

#define ASN_K_INDEFLEN   -9999   /* indefinite length message indicator  */

#define XU_DUMP(msg)           xu_dump(msg,0,0)
#define xd_resetp(pctxt)       rtxResetContext(pctxt)

#define ASN1TAG2BYTE(tag) \
((OSOCTET)(((tag)&TM_B_IDCODE)|((tag)>>ASN1TAG_LSHIFT)))

typedef struct _Asn1BufLocDescr {
   OSUINT32 numocts;
   OSINT32  offset;
} Asn1BufLocDescr;

#ifdef __cplusplus
extern "C" {

#endif

#ifndef EXTERNBER
#ifdef BUILDASN1BERDLL
#define EXTERNBER __declspec(dllexport)
#elif defined (USEASN1BERDLL)
#define EXTERNBER __declspec(dllimport)
#else
#define EXTERNBER
#endif /* BUILDASN1BERDLL */
#endif /* EXTERNBER */

/* decode functions */
EXTERNBER int xd_tag (OSCTXT* pctxt, ASN1TAG *tag_p);

EXTERNBER int xd_tag_len (OSCTXT *pctxt, ASN1TAG *tag_p, 
                          int *len_p, OSOCTET flags);

EXTERNBER int xd_match (OSCTXT *pctxt, ASN1TAG tag, 
                        int *len_p, OSOCTET flags);

EXTERNBER int xd_boolean (OSCTXT *pctxt, OSBOOL *object_p, 
                          ASN1TagType tagging, int length);

EXTERNBER int xd_integer (OSCTXT *pctxt, OSINT32 *object_p, 
                          ASN1TagType tagging, int length);

EXTERNBER int xd_int8 (OSCTXT *pctxt, OSINT8 *object_p, 
                       ASN1TagType tagging, int length);

EXTERNBER int xd_int16 (OSCTXT *pctxt, OSINT16 *object_p, 
                        ASN1TagType tagging, int length); 

EXTERNBER int xd_unsigned (OSCTXT *pctxt, OSUINT32 *object_p, 
                           ASN1TagType tagging, int length);

EXTERNBER int xd_uint8 (OSCTXT *pctxt, OSUINT8 *object_p, 
                        ASN1TagType tagging, int length); 

EXTERNBER int xd_uint16 (OSCTXT *pctxt, OSUINT16 *object_p, 
                         ASN1TagType tagging, int length); 

EXTERNBER int xd_int64 (OSCTXT *pctxt, OSINT64 *object_p, 
                        ASN1TagType tagging, int length);

EXTERNBER int xd_uint64 (OSCTXT *pctxt, OSUINT64 *object_p, 
                         ASN1TagType tagging, int length);

EXTERNBER int xd_bigint (OSCTXT *pctxt, const char** object_p, 
                         ASN1TagType tagging, int length);

EXTERNBER int xd_bitstr_s (OSCTXT *pctxt, OSOCTET* object_p, 
                           OSUINT32* numbits_p, ASN1TagType tagging, 
                           int length);

EXTERNBER int xd_bitstr (OSCTXT *pctxt, const OSOCTET** object_p2, 
                         OSUINT32* numbits_p, ASN1TagType tagging, int length);

EXTERNBER int xd_octstr_s (OSCTXT *pctxt, OSOCTET* object_p, 
                           OSUINT32* pnumocts, ASN1TagType tagging, 
                           int length);

EXTERNBER int xd_octstr (OSCTXT *pctxt, const OSOCTET** object_p2, 
                         OSUINT32* pnumocts, ASN1TagType tagging, int length);

EXTERNBER int xd_charstr (OSCTXT* pctxt, const char** object_p, 
                          ASN1TagType tagging, ASN1TAG tag, int length);

#define xd_utf8str(pctxt,object_p,tagging,length) \
xd_charstr (pctxt, (const char**)object_p, tagging, ASN_ID_UTF8String, length)

EXTERNBER int xd_16BitCharStr (OSCTXT* pctxt, Asn116BitCharString* object_p,
                               ASN1TagType tagging, ASN1TAG tag, int length);

EXTERNBER int xd_32BitCharStr (OSCTXT* pctxt, Asn132BitCharString* object_p,
                               ASN1TagType tagging, ASN1TAG tag, int length);

EXTERNBER int xd_null (OSCTXT *pctxt, ASN1TagType tagging);

EXTERNBER int xd_objid (OSCTXT *pctxt, ASN1OBJID *object_p, 
                        ASN1TagType tagging, int length);

EXTERNBER int xd_oid64 (OSCTXT *pctxt, ASN1OID64 *object_p, 
                        ASN1TagType tagging, int length);

EXTERNBER int xd_reloid (OSCTXT *pctxt, ASN1OBJID *object_p, 
                         ASN1TagType tagging, int length);

EXTERNBER int xd_real (OSCTXT *pctxt, OSREAL *object_p, 
                       ASN1TagType tagging, int length);

EXTERNBER int xd_enum (OSCTXT *pctxt, OSINT32 *object_p, 
                       ASN1TagType tagging, int length);

EXTERNBER int xd_OpenType (OSCTXT *pctxt, const OSOCTET** object_p2, 
                           OSUINT32* pnumocts);

EXTERNBER int xd_OpenTypeExt (OSCTXT* pctxt, ASN1CCB* ccb_p, ASN1TAG tag, 
                              OSRTDList *pElemList);

EXTERNBER int xd_OpenTypeAppend (OSCTXT *pctxt, OSRTDList *pElemList);

EXTERNBER int xd_real10 (OSCTXT *pctxt, const char** object_p, 
                         ASN1TagType tagging, int length);

EXTERNBER int xd_setp (OSCTXT *pctxt, const OSOCTET* msg_p, 
                       int msglen, ASN1TAG *tag_p, int *len_p);

EXTERNBER int xd_indeflen_ex (const OSOCTET* msg_p, int bufSize);

/* Backward compatibility macro */
#define xd_indeflen(m) xd_indeflen_ex(m, INT_MAX)

EXTERNBER int xd_len (OSCTXT *pctxt, int *len_p);

EXTERNBER int xd_chkend (OSCTXT *pctxt, ASN1CCB* ccb_p);

EXTERNBER int xd_count (OSCTXT *pctxt, int length, int *count_p);

EXTERNBER int xd_NextElement (OSCTXT* pctxt);

EXTERNBER int xd_Tag1AndLen (OSCTXT* pctxt, OSINT32* len_p);

/* internal decode function to do memory copies */
EXTERNBER int xd_memcpy (OSCTXT* pctxt, OSOCTET *object_p, int length) ;

EXTERNBER int xd_match1 (OSCTXT *pctxt, OSOCTET tag, int *len_p);


/* file decode functions */

EXTERNBER int xdf_tag (FILE* fp, ASN1TAG* ptag, OSOCTET* buffer, int* pbufidx);

EXTERNBER int xdf_len (FILE* fp, OSINT32* plen, OSOCTET* buffer, int* pbufidx);

EXTERNBER int xdf_TagAndLen (FILE* fp, ASN1TAG* ptag, OSINT32* plen, 
                             OSOCTET* buffer, int* pbufidx);

EXTERNBER int xdf_ReadPastEOC (FILE* fp, OSOCTET* buffer, 
                               int bufsiz, int* pbufidx);

EXTERNBER int xdf_ReadContents (FILE* fp, int len, OSOCTET* buffer,
                                int bufsiz, int* pbufidx);
/* encode functions */
EXTERNBER int xe_tag_len (OSCTXT *pctxt, ASN1TAG tag, int length) ;

EXTERNBER int xe_boolean (OSCTXT* pctxt, OSBOOL* object_p, 
                          ASN1TagType tagging);

EXTERNBER int xe_integer (OSCTXT* pctxt, int *object_p, ASN1TagType tagging);

EXTERNBER int xe_unsigned (OSCTXT* pctxt, OSUINT32 *object_p, 
                           ASN1TagType tagging);

EXTERNBER int xe_int8 (OSCTXT* pctxt, OSINT8 *object_p, ASN1TagType tagging);

EXTERNBER int xe_int16 (OSCTXT* pctxt, OSINT16 *object_p, ASN1TagType tagging);

EXTERNBER int xe_int64 (OSCTXT* pctxt, OSINT64 *object_p, 
                        ASN1TagType tagging);

EXTERNBER int xe_uint64 (OSCTXT* pctxt, OSUINT64 *object_p, 
                         ASN1TagType tagging);

EXTERNBER int xe_uint8 (OSCTXT* pctxt, OSUINT8 *object_p, ASN1TagType tagging);

EXTERNBER int xe_uint16 (OSCTXT* pctxt, OSUINT16 *object_p, ASN1TagType tagging);

EXTERNBER int xe_bigint (OSCTXT* pctxt, const char* object_p, 
                         ASN1TagType tagging);

EXTERNBER int xe_bitstr (OSCTXT* pctxt, const OSOCTET* object_p, 
                         OSUINT32 numbits, ASN1TagType tagging);

EXTERNBER int xe_octstr (OSCTXT* pctxt, const OSOCTET* object_p, 
                         OSUINT32 numocts, ASN1TagType tagging);

EXTERNBER int xe_charstr (OSCTXT* pctxt, const char* object_p, 
                          ASN1TagType tagging, ASN1TAG tag);
 
#define xe_utf8str(pctxt,object_p,tagging) \
xe_charstr (pctxt, (const char*)object_p, tagging, ASN_ID_UTF8String)

EXTERNBER int xe_16BitCharStr (OSCTXT* pctxt, Asn116BitCharString* object_p, 
                               ASN1TagType tagging, ASN1TAG tag);

EXTERNBER int xe_32BitCharStr (OSCTXT* pctxt, Asn132BitCharString* object_p, 
                               ASN1TagType tagging, ASN1TAG tag);

EXTERNBER int xe_null (OSCTXT* pctxt, ASN1TagType tagging);

EXTERNBER int xe_objid (OSCTXT* pctxt, ASN1OBJID *object_p, 
                        ASN1TagType tagging);

EXTERNBER int xe_oid64 (OSCTXT* pctxt, ASN1OID64 *object_p, 
                        ASN1TagType tagging);

EXTERNBER int xe_reloid (OSCTXT* pctxt, ASN1OBJID *object_p, 
                         ASN1TagType tagging);

EXTERNBER int xe_enum (OSCTXT* pctxt, OSINT32 *object_p, ASN1TagType tagging);

EXTERNBER int xe_real (OSCTXT* pctxt, OSREAL *object_p, ASN1TagType tagging);

EXTERNBER int xe_OpenType (OSCTXT* pctxt, const OSOCTET* object_p, 
                           OSUINT32 numocts);

EXTERNBER int xe_OpenTypeExt (OSCTXT* pctxt, OSRTDList* pElemList);

EXTERNBER int xe_real10 (OSCTXT *pctxt, const char* object_p, 
                         ASN1TagType tagging);

EXTERNBER int xe_derReal10 (OSCTXT *pctxt, const char* object_p, 
                            ASN1TagType tagging);

EXTERNBER int xe_setp (OSCTXT* pctxt, OSOCTET *buf_p, int bufsiz);

EXTERNBER OSOCTET* xe_getp (OSCTXT* pctxt);

EXTERNBER void xe_free (OSCTXT* pctxt);

EXTERNBER int xe_expandBuffer (OSCTXT *pctxt, size_t length);

EXTERNBER int xe_memcpy (OSCTXT *pctxt, const OSOCTET* object_p, 
                         size_t length) ;

EXTERNBER int xe_len (OSCTXT *pctxt, int length) ;

EXTERNBER int xe_derCanonicalSort (OSCTXT* pctxt, OSRTSList* pList);

EXTERNBER int xe_TagAndIndefLen (OSCTXT *pctxt, ASN1TAG tag, int length) ;

EXTERNBER void xe_getBufLocDescr (OSCTXT *pctxt, OSUINT32 length, 
                                  Asn1BufLocDescr* pDescr);

EXTERNBER int derEncBitString 
(OSCTXT* pctxt, const OSOCTET* pvalue, OSUINT32 numbits, 
 ASN1TagType tagging);

/* utility functions */

EXTERNBER OSBOOL berErrAddTagParm (OSCTXT* pctxt, ASN1TAG tag);

/* Note: this definition is deprecated.  Calls to xu_addTagErrParm      */
/* should be replaced with berErrAddTagParm.                            */
#define xu_addTagErrParm berErrAddTagParm

#ifndef _COMPACT

EXTERNBER int berErrUnexpTag (OSCTXT* pctxt, ASN1TAG exptag);
#else
#define berErrUnexpTag(pctxt,exptag) RTERR_IDNOTFOU
#endif

EXTERNBER const char* berTagToString 
(ASN1TAG tag, char* buffer, size_t bufsiz);

EXTERNBER const char* berTagToDynStr (OSCTXT* pctxt, ASN1TAG tag);

EXTERNBER int xu_verify_len (OSOCTET *msg_p);
EXTERNBER void *xu_parse_mmbuf (
  OSOCTET **buf_p2, int *buflen_p, OSOCTET *start_p, int bufsiz);

EXTERNBER void xu_alloc_array (
  OSCTXT* pctxt, ASN1SeqOf* seqOf_p, int recSize, int recCount);

EXTERNBER void xu_octscpy_s (
  OSUINT32* nocts_p, OSOCTET *data_p, char *cstr, char zterm);

EXTERNBER void xu_octscpy_ss (ASN1OctStr *octStr_p, char *cstring, char zterm);

EXTERNBER void xu_octscpy_d (
  OSCTXT* pctxt, OSUINT32* nocts_p, const OSOCTET** data_p2, 
  char* cstring, char zterm);

EXTERNBER void xu_octscpy_ds (
  OSCTXT* pctxt, ASN1DynOctStr *octStr_p, char *cstring, char zterm);

EXTERNBER void xu_octmcpy_s (ASN1OctStr *octStr_p, void* data_p, int datalen);

EXTERNBER void xu_octmcpy_d (
  OSCTXT* pctxt, ASN1DynOctStr *octStr_p, void* data_p, int datalen);

EXTERNBER char* xu_fetchstr (int numocts, char *data);

EXTERNBER int xu_hexstrcpy (char *data, char *hstring);
EXTERNBER int xu_binstrcpy (char *data, char *bstring);

EXTERNBER int xu_dump (OSOCTET *msgptr, ASN1DumpCbFunc cb, void* cbArg_p);

EXTERNBER int xu_fdump (FILE *file_p, OSOCTET *msgptr);

EXTERNBER void xu_hex_dump (OSOCTET *data, int numocts, OSBOOL hdrflg);

EXTERNBER void xu_fmt_tag (
  ASN1TAG *tag_p, char *class_p, char *form_p, char *id_code);

EXTERNBER char* xu_fmt_contents (OSCTXT* pctxt, int len, int *count);

EXTERNBER int  xu_fread (FILE* fp, OSOCTET* bufp, int bufsiz);

EXTERNBER void xu_SaveBufferState (OSCTXT* pCtxt, OSRTBufSave* pSavedInfo);

EXTERNBER void xu_RestoreBufferState (OSCTXT* pCtxt, OSRTBufSave* pSavedInfo);

/* This macro will fetch the next byte in the input stream.  A test is  */
/* done for buffer overrun.                                             */

#define XD_MEMCPY1(pctxt, object_p) \
((ASN1BUF_INDEFLEN(pctxt) || \
((pctxt)->buffer.byteIndex < (pctxt)->buffer.size)) ? \
(*object_p = *OSRTBUFPTR(pctxt), (pctxt)->buffer.byteIndex ++, 0) : \
RTERR_ENDOFBUF)

/* This macro will fetch the next byte in the input stream.  No test is */
/* done for buffer overrun..                                            */

#define XD_FETCH1(pctxt) ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex++])

/* This macro will match a single-byte tag. It does not advance the     */
/* decode cursor.                                                       */

#define XD_PEEKTAG(pctxt, tag) \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] & (~0x20)) == (tag & (~0x20)))

/* This macro returns true if the next tag is constructed.              */
/* It does not advance the decode cursor.                               */

#define XD_PEEKPC(pctxt) \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] & 0x20) == 0x20)

/* This macro will test for an EOC (end-of-context) marker */

#define XD_MATCHEOC(pctxt) \
( ( (pctxt)->buffer.byteIndex + 2 <= (pctxt)->buffer.size ) && \
( (pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == 0 ) && \
( (pctxt)->buffer.data[(pctxt)->buffer.byteIndex + 1] == 0 ) )

/* These macros will test a series of bytes in the decode buffer for a  */
/* match.                                                               */
#define XD_MATCHBYTES1(pctxt, b1) \
((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == b1)

#define XD_MATCHBYTES2(pctxt, b1, b2) \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == b1) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+1] == b2))

#define XD_MATCHBYTES3(pctxt, b1, b2, b3) \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == b1) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+1] == b2) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+2] == b3))

#define XD_MATCHBYTES4(pctxt, b1, b2, b3, b4) \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == b1) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+1] == b2) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+2] == b3) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+3] == b4))

#define XD_MATCHBYTES5(pctxt, b1, b2, b3, b4, b5) \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == b1) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+1] == b2) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+2] == b3) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+3] == b4) && \
 ((pctxt)->buffer.data[(pctxt)->buffer.byteIndex+4] == b5))

/* This macro will advance the decode buffer index by the given number  */
/* number of bytes.                                                     */

#define XD_BUMPIDX(pctxt, nbytes) ((pctxt)->buffer.byteIndex += nbytes)

/* This macro will test for buffer overrun */

#define XD_CHKBUFEND(pctxt) \
(((ASN1BUF_INDEFLEN(pctxt)) || \
((pctxt)->buffer.byteIndex <= (pctxt)->buffer.size)) ? 0 : RTERR_ENDOFBUF)

/* This macro will test if the given length value is within the current */
/* bounds of the message buffer.  The given length value is assumed to  */
/* be a definite length (i.e != ASN_K_INDEFLEN)..                       */

#define XD_CHKDEFLEN(pctxt,len) \
(((ASN1BUF_INDEFLEN(pctxt)) || \
(((pctxt)->buffer.byteIndex + len) <= (pctxt)->buffer.size)) ? \
0 : RTERR_ENDOFBUF)

/* This macro will test for EOB */

#define XD_CHKEOB(pctxt) \
(((pctxt)->buffer.byteIndex + 2 > (pctxt)->buffer.size) ? TRUE : \
(((pctxt)->buffer.data[(pctxt)->buffer.byteIndex] == 0 && \
(pctxt)->buffer.data[(pctxt)->buffer.byteIndex + 1] == 0 ) ? \
TRUE : FALSE))

/* This macro will test for CCB overrun */

#define XD_CHKEND(pctxt,ccb_p) \
(((ccb_p)->len == ASN_K_INDEFLEN) ? XD_CHKEOB(pctxt) : \
((OSRTBUFPTR(pctxt) - (ccb_p)->ptr >= (ccb_p)->len) || \
((pctxt)->buffer.byteIndex >= (pctxt)->buffer.size)))

/* This macro will check if the given amount of space is available      */
/* in the encode buffer and attempt tp expand the buffer if necessary   */

#define XE_CHKBUF(pctxt,len) \
if (len > (pctxt)->buffer.byteIndex) { \
int stat = xe_expandBuffer (pctxt, len); \
if (stat != 0) return stat; }

/* This macro will put one byte into the encode buffer.  It is assumed  */
/* that there is enough space available for the byte.                   */

#define XE_PUT1(pctxt,ch) \
(pctxt)->buffer.data[--(pctxt)->buffer.byteIndex] = ch;

/* This macro will put two bytes into the encode buffer.  It is assumed */
/* that there is enough space available for the bytes.                  */

#define XE_PUT2(pctxt,ch1,ch2) \
(pctxt)->buffer.byteIndex -= 2; \
(pctxt)->buffer.data[(pctxt)->buffer.byteIndex] = ch1; \
(pctxt)->buffer.data[(pctxt)->buffer.byteIndex+1] = ch2;

/*
 * This macro will put one byte into the encode buffer.  It will first
 * check to see if enough space is available for the byte and attempt
 * to expand the buffer if necessary.
*/
#define XE_SAFEPUT1(pctxt,ch) \
XE_CHKBUF(pctxt,1); (pctxt)->buffer.data[--(pctxt)->buffer.byteIndex] = ch;

#ifdef __cplusplus
}
#endif

#endif /* _OSRTBER_H_ */

©Copyright 2001-2007. Objective Systems, Inc. All Rights Reserved.