asn1.h File Reference


Detailed Description

Definitions for Abstract Syntax Notation One, ASN.1.

 * $Id: asn1.h,v 1.2 2008/02/15 17:13:17 haraldkipp Exp $
 * 

Definition in file asn1.h.

Go to the source code of this file.

Data Structures

struct  UNSIGNED64

Defines

#define MAX_OID_LEN   32
#define MAX_SUBID   0xFFFFFFFF
#define MIN_OID_LEN   2
#define ASN_BOOLEAN   0x01
#define ASN_INTEGER   0x02
#define ASN_BIT_STR   0x03
#define ASN_OCTET_STR   0x04
#define ASN_NULL   0x05
#define ASN_OBJECT_ID   0x06
#define ASN_SEQUENCE   0x10
#define ASN_SET   0x11
#define ASN_UNIVERSAL   0x00
#define ASN_APPLICATION   0x40
#define ASN_CONTEXT   0x80
#define ASN_PRIVATE   0xC0
#define ASN_PRIMITIVE   0x00
#define ASN_CONSTRUCTOR   0x20
#define ASN_LONG_LEN   0x80
#define ASN_EXTENSION_ID   0x1F
#define ASN_IPADDRESS   (ASN_APPLICATION | 0)
#define ASN_COUNTER   (ASN_APPLICATION | 1)
#define ASN_GAUGE   (ASN_APPLICATION | 2)
#define ASN_UNSIGNED   (ASN_APPLICATION | 2)
#define ASN_TIMETICKS   (ASN_APPLICATION | 3)
#define ASN_OPAQUE   (ASN_APPLICATION | 4)
#define ASN_NSAP   (ASN_APPLICATION | 5)
#define ASN_COUNTER64   (ASN_APPLICATION | 6)
#define ASN_UINTEGER   (ASN_APPLICATION | 7)
#define ACL_RONLY   0xAAAA
#define ACL_RWRITE   0xAABA
#define ACL_NOACCESS   0x0000
#define ASN_BIT8   0x80

Typedefs

typedef u_long OID

Functions

CONST u_charAsnHeaderParse (CONST u_char *, size_t *, u_char *)
 Interpret the ID and length of the next object.
u_charAsnHeaderBuild (u_char *, size_t *, u_char, size_t)
 Build an ASN header for an object with a given ID and length.
CONST u_charAsnSequenceParse (CONST u_char *, size_t *, u_char)
 Check the type and get the length of the next object.
u_charAsnSequenceBuild (u_char *, size_t *, u_char, size_t)
 Build an ASN header for a sequence with a given type and length.
CONST u_charAsnIntegerParse (CONST u_char *, size_t *, u_char *, long *)
 Pull a long out of an ASN integer type.
u_charAsnIntegerBuild (u_char *, size_t *, u_char, long *)
 Build an ASN object containing an integer.
CONST u_charAsnUnsignedParse (CONST u_char *, size_t *, u_char *, u_long *)
 Pull an unsigned long out of an ASN integer type.
u_charAsnUnsignedBuild (u_char *, size_t *, u_char, u_long *)
 Build an ASN object containing an unsigned integer.
CONST u_charAsnOctetStringParse (CONST u_char *, size_t *, u_char *, u_char *, size_t *)
 Pulls a string out of an ASN octet string type.
u_charAsnOctetStringBuild (u_char *, size_t *, u_char, CONST u_char *, size_t)
 Build an ASN object containing an octet string.
CONST u_charAsnOidParse (CONST u_char *, size_t *, u_char *, OID *, size_t *)
 Pulls an object identifier out of an ASN object ID type.
u_charAsnOidBuild (u_char *, size_t *, u_char, CONST OID *, size_t)
 Build an ASN object identifier.
CONST u_charAsnNullParse (CONST u_char *, size_t *, u_char *)
 Parse an ASN null type.
u_charAsnNullBuild (u_char *, size_t *, u_char)
 Build an ASN null object.
CONST u_charAsnBitStringParse (CONST u_char *, size_t *, u_char *, u_char *, size_t *)
 Pull a bitstring out of an ASN bitstring type.
u_charAsnBitStringBuild (u_char *, size_t *, u_char, CONST u_char *, size_t)
 Build an ASN bit string.
CONST u_charAsnUnsigned64Parse (CONST u_char *, size_t *, u_char *, UNSIGNED64 *)
 Pull a 64 bit unsigned long out of an ASN integer type.
u_charAsnUnsigned64Build (u_char *, size_t *, u_char, CONST UNSIGNED64 *)
 Build an ASN object containing a 64 bit unsigned integer.


Define Documentation

#define MAX_OID_LEN   32

Definition at line 49 of file asn1.h.

Referenced by AsnOidBuild().

#define MAX_SUBID   0xFFFFFFFF

Definition at line 52 of file asn1.h.

#define MIN_OID_LEN   2

Definition at line 54 of file asn1.h.

#define ASN_BOOLEAN   0x01

Definition at line 56 of file asn1.h.

#define ASN_INTEGER   0x02

Definition at line 57 of file asn1.h.

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), and SnmpVarBuild().

#define ASN_BIT_STR   0x03

Definition at line 58 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_OCTET_STR   0x04

Definition at line 59 of file asn1.h.

Referenced by SnmpAuthBuild(), and SnmpVarBuild().

#define ASN_NULL   0x05

Definition at line 60 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_OBJECT_ID   0x06

Definition at line 61 of file asn1.h.

Referenced by SnmpVarBuild(), and SnmpVarParse().

#define ASN_SEQUENCE   0x10

Definition at line 62 of file asn1.h.

Referenced by SnmpAuthBuild(), SnmpAuthParse(), SnmpVarBuild(), and SnmpVarParse().

#define ASN_SET   0x11

Definition at line 63 of file asn1.h.

#define ASN_UNIVERSAL   0x00

Definition at line 65 of file asn1.h.

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), SnmpVarBuild(), and SnmpVarParse().

#define ASN_APPLICATION   0x40

Definition at line 66 of file asn1.h.

#define ASN_CONTEXT   0x80

Definition at line 67 of file asn1.h.

#define ASN_PRIVATE   0xC0

Definition at line 68 of file asn1.h.

#define ASN_PRIMITIVE   0x00

Definition at line 70 of file asn1.h.

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), SnmpVarBuild(), and SnmpVarParse().

#define ASN_CONSTRUCTOR   0x20

Definition at line 71 of file asn1.h.

Referenced by SnmpAuthBuild(), SnmpAuthParse(), SnmpVarBuild(), and SnmpVarParse().

#define ASN_LONG_LEN   0x80

Definition at line 73 of file asn1.h.

#define ASN_EXTENSION_ID   0x1F

Definition at line 74 of file asn1.h.

Referenced by AsnHeaderParse().

#define ASN_IPADDRESS   (ASN_APPLICATION | 0)

Definition at line 77 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_COUNTER   (ASN_APPLICATION | 1)

Definition at line 78 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_GAUGE   (ASN_APPLICATION | 2)

Definition at line 79 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_UNSIGNED   (ASN_APPLICATION | 2)

Definition at line 80 of file asn1.h.

#define ASN_TIMETICKS   (ASN_APPLICATION | 3)

Definition at line 81 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_OPAQUE   (ASN_APPLICATION | 4)

Definition at line 82 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_NSAP   (ASN_APPLICATION | 5)

Definition at line 85 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_COUNTER64   (ASN_APPLICATION | 6)

Definition at line 86 of file asn1.h.

Referenced by SnmpVarBuild().

#define ASN_UINTEGER   (ASN_APPLICATION | 7)

Definition at line 87 of file asn1.h.

Referenced by SnmpVarBuild().

#define ACL_RONLY   0xAAAA

Definition at line 89 of file asn1.h.

#define ACL_RWRITE   0xAABA

Definition at line 90 of file asn1.h.

#define ACL_NOACCESS   0x0000

Definition at line 91 of file asn1.h.

#define ASN_BIT8   0x80

Definition at line 93 of file asn1.h.

Referenced by AsnOidParse().


Typedef Documentation

typedef u_long OID

Definition at line 95 of file asn1.h.


Function Documentation

CONST u_char* AsnHeaderParse ( CONST u_char data,
size_t *  datalength,
u_char type 
)

Interpret the ID and length of the next object.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the ID and length.
type Pointer to the variable that receives the ASN type of the object.
Returns:
A pointer to the first byte following ID and length (aka the start of the data field). Returns NULL on any error.

Definition at line 135 of file asn1.c.

References ASN_EXTENSION_ID, and CONST.

Referenced by AsnSequenceParse(), SnmpAgentProcessRequest(), and SnmpVarParse().

u_char* AsnHeaderBuild ( u_char data,
size_t *  datalength,
u_char  type,
size_t  length 
)

Build an ASN header for an object with a given ID and length.

This only works on data types < 30, i.e. no extension octets. The maximum length is 0xFFFF;

Parameters:
data Pointer to start of object.
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the encoded ID and length of this object.
type ASN type of the object.
length Length of object.
Returns:
Returns a pointer to the first byte of the contents of this object. Returns NULL on any error.

Definition at line 188 of file asn1.c.

Referenced by AsnBitStringBuild(), AsnIntegerBuild(), AsnNullBuild(), AsnOctetStringBuild(), AsnOidBuild(), AsnUnsigned64Build(), and AsnUnsignedBuild().

CONST u_char* AsnSequenceParse ( CONST u_char data,
size_t *  datalength,
u_char  type 
)

Check the type and get the length of the next object.

Similare to AsnHeaderParse, but tests for expected type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the ID and length.
type The expected ASN type of the object.
Returns:
A pointer to the first byte following ID and length (aka the start of the data field). Returns NULL on any error.

Definition at line 214 of file asn1.c.

References AsnHeaderParse().

Referenced by SnmpAuthParse(), and SnmpVarParse().

u_char* AsnSequenceBuild ( u_char data,
size_t *  datalength,
u_char  type,
size_t  length 
)

Build an ASN header for a sequence with a given type and length.

This only works on data types < 30, i.e. no extension octets. The maximum length is 0xFFFF;

Parameters:
data Pointer to start of object.
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the encoded ID and length of this object.
type ASN type of the object.
length Length of object.
Returns:
Returns a pointer to the first byte of the contents of this object. Returns NULL on any error.

Definition at line 243 of file asn1.c.

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), and SnmpVarBuild().

CONST u_char* AsnIntegerParse ( CONST u_char data,
size_t *  datalength,
u_char type,
long *  intp 
)

Pull a long out of an ASN integer type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
intp Pointer to the variable that receives the value of the object.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 276 of file asn1.c.

References CONST.

Referenced by SnmpAgentProcessRequest(), and SnmpAuthParse().

u_char* AsnIntegerBuild ( u_char data,
size_t *  datalength,
u_char  type,
long *  intp 
)

Build an ASN object containing an integer.

Parameters:
data Pointer to start of output buffer
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
intp Value of the object.
Returns:
A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 322 of file asn1.c.

References AsnHeaderBuild().

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), and SnmpVarBuild().

CONST u_char* AsnUnsignedParse ( CONST u_char data,
size_t *  datalength,
u_char type,
u_long intp 
)

Pull an unsigned long out of an ASN integer type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
intp Pointer to the variable that receives the value of the object.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 374 of file asn1.c.

References CONST.

u_char* AsnUnsignedBuild ( u_char data,
size_t *  datalength,
u_char  type,
u_long intp 
)

Build an ASN object containing an unsigned integer.

Parameters:
data Pointer to start of output buffer
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
intp Value of the object.
Returns:
A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 424 of file asn1.c.

References AsnHeaderBuild().

Referenced by SnmpVarBuild().

CONST u_char* AsnOctetStringParse ( CONST u_char data,
size_t *  datalength,
u_char type,
u_char string,
size_t *  strlength 
)

Pulls a string out of an ASN octet string type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
string Pointer to the variable that receives the value of the object.
strlength Contains the size of the string buffer on entry. On exit, it is returned as the number of bytes stored in the string buffer.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 490 of file asn1.c.

References CONST, and memcpy().

Referenced by SnmpAuthParse().

u_char* AsnOctetStringBuild ( u_char data,
size_t *  datalength,
u_char  type,
CONST u_char string,
size_t  strlength 
)

Build an ASN object containing an octet string.

Parameters:
data Pointer to start of output buffer
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
string Pointer to the value. If NULL, the octet string will be filled with zeros.
strlength Number of bytes in the string value.
Returns:
A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 532 of file asn1.c.

References AsnHeaderBuild(), memcpy(), and memset().

Referenced by SnmpAuthBuild(), and SnmpVarBuild().

CONST u_char* AsnOidParse ( CONST u_char data,
size_t *  datalength,
u_char type,
OID objid,
size_t *  objidlength 
)

Pulls an object identifier out of an ASN object ID type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
objid Pointer to the variable that receives the object identifier.
objidlength Points to a variable that contains the size of the output buffer on entry. On exit, it is returned as the number of sub IDs stored in the output buffer.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 573 of file asn1.c.

References ASN_BIT8, and CONST.

Referenced by SnmpVarParse().

u_char* AsnOidBuild ( u_char data,
size_t *  datalength,
u_char  type,
CONST OID objid,
size_t  objidlength 
)

Build an ASN object identifier.

Parameters:
data Pointer to start of the object.
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
objid Pointer to the object identifier.
objidlength Number of sub IDs in the object identifier.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 649 of file asn1.c.

References AsnHeaderBuild(), CONST, free, malloc, and MAX_OID_LEN.

Referenced by SnmpVarBuild().

CONST u_char* AsnNullParse ( CONST u_char data,
size_t *  datalength,
u_char type 
)

Parse an ASN null type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 774 of file asn1.c.

References CONST.

u_char* AsnNullBuild ( u_char data,
size_t *  datalength,
u_char  type 
)

Build an ASN null object.

Parameters:
data Pointer to start of the object.
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 805 of file asn1.c.

References AsnHeaderBuild().

Referenced by SnmpVarBuild().

CONST u_char* AsnBitStringParse ( CONST u_char data,
size_t *  datalength,
u_char type,
u_char string,
size_t *  strlength 
)

Pull a bitstring out of an ASN bitstring type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
string Pointer to the variable that receives the value of the object.
strlength Contains the size of the string buffer on entry. On exit, it is returned as the number of bytes stored in the string buffer.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 830 of file asn1.c.

References CONST, and memcpy().

u_char* AsnBitStringBuild ( u_char data,
size_t *  datalength,
u_char  type,
CONST u_char string,
size_t  strlength 
)

Build an ASN bit string.

Parameters:
data Pointer to start of output buffer
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
string Pointer to the value. If NULL, the octet string will be filled with zeros.
strlength Number of bytes in the string value.
Returns:
A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 872 of file asn1.c.

References AsnHeaderBuild(), and memcpy().

Referenced by SnmpVarBuild().

CONST u_char* AsnUnsigned64Parse ( CONST u_char data,
size_t *  datalength,
u_char type,
UNSIGNED64 cp 
)

Pull a 64 bit unsigned long out of an ASN integer type.

Parameters:
data Pointer to start of the object.
datalength Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type Pointer to the variable that receives the ASN type of the object.
intp Pointer to the variable that receives the value of the object.
Returns:
Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 905 of file asn1.c.

References CONST, UNSIGNED64::high, and UNSIGNED64::low.

u_char* AsnUnsigned64Build ( u_char data,
size_t *  datalength,
u_char  type,
CONST UNSIGNED64 cp 
)

Build an ASN object containing a 64 bit unsigned integer.

Parameters:
data Pointer to start of output buffer
datalength Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type ASN type of the object.
intp Value of the object.
Returns:
A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

Definition at line 952 of file asn1.c.

References AsnHeaderBuild().

Referenced by SnmpVarBuild().


© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/