Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2003 - 2005 Pekka Riikonen
+ Copyright (C) 2003 - 2007 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
* pre-allocated SilcStack is used as memory.
*
* The encoding and decoding interface is simple. silc_asn1_encode is used
- * encode and silc_asn1_decode to decode. The actual ASN.1 is defined
+ * to encode and silc_asn1_decode to decode. The actual ASN.1 is defined
* as variable argument list to the function. Various macros can be used
* to encode and decode different ASN.1 types. All types may also be used
* to encode and decode with various options (such as implicit and explicit
* tagging and defining specific class option).
*
- * The implementation supports all the common ASN.1 types. This
- * implementation does not support advanced ASN.1 features like macros.
+ * The implementation supports all the common ASN.1 types.
*
* References: ITU-T X.680 - X.693
* http://www.itu.int/ITU-T/studygroups/com17/languages/
* with SILC_ASN1_OPTS macro. Other options can be given with various
* SILC_ASN1_*_T macros.
*
+ * EXAMPLE
+ *
+ * // Encodes boolean value with explicit tag and private class, and
+ * // the result is allocated into `dest'.
+ * silc_asn1_encode(asn1, &dest,
+ * SILC_ASN1_OPTS(SILC_ASN1_ALLOC),
+ * SILC_ASN1_BOOLEAN_T(SILC_ASN1_PRIVATE |
+ * SILC_ASN1_EXPLICIT, 100, boolval),
+ * SILC_ASN1_END);
+ *
+ * // Decode optional value, with SILC_ASN1_OPTIONAL the type must be
+ * // a pointer so that NULL can be returned if the type is not present.
+ * SilcBool *val;
+ *
+ * silc_asn1_decode(asn1, src,
+ * SILC_ASN1_OPTS(SILC_ASN1_OPTIONAL),
+ * SILC_ASN1_BOOLEAN(&val),
+ * SILC_ASN1_END);
+ *
+ * // If val == NULL, the optional value was not present
+ * if (val == NULL)
+ * error;
+ *
* SOURCE
*/
typedef enum {
/* ASN.1 encoder/decoder options (bitmask). These can be given
only with SILC_ASN1_OPTS macro at the start of encoding/decoding. */
- SILC_ASN1_ALLOC = 0x0400, /* Dynamically allocate results */
+ SILC_ASN1_ALLOC = 0x0400, /* Dynamically allocate results,
+ or if stack was given to
+ silc_asn1_alloc, they are allocated
+ and consumed from the stack. */
SILC_ASN1_ACCUMUL = 0x0800, /* Accumulate memory for results,
next call to silc_asn1_decode
will not cancel old results. */
*
* SYNOPSIS
*
- * SilcAsn1 silc_asn1_alloc(void);
+ * SilcAsn1 silc_asn1_alloc(SilcStack stack);
*
* DESCRIPTION
*
* Allocates and initializes ASN.1 encoder/decoder and returns SilcAsn1
* context or NULL on error. This context can be used with both
- * silc_asn1_encode and silc_asn1_decode functions.
+ * silc_asn1_encode and silc_asn1_decode functions. If `stack' is non-NULL
+ * all memory will be allocated from `stack'.
*
* Usually SilcAsn1 is allocated when encoder or decoder is needed,
* however it is also possible to allocate long-lasting SilcAsn1 and
*
* When this context is freed with silc_asn1_free all memory will be
* freed, and all encoded ASN.1 buffers becomes invalid. Also all
- * data that is returned by silc_asn1_decode function becomes invalid.
+ * data that is returned by silc_asn1_encode and silc_asn1_decode function
+ * becomes invalid, unless SILC_ASN1_ALLOC flag is used, in which case the
+ * memory is allocated from `stack' and the `stack' is consumed.
*
***/
-SilcAsn1 silc_asn1_alloc(void);
+SilcAsn1 silc_asn1_alloc(SilcStack stack);
/****f* silcasn1/SilcASN1API/silc_asn1_free
*
*
* SYNOPSIS
*
- * SilcBool silc_asn1_init(SilcAsn1 asn1);
+ * SilcBool silc_asn1_init(SilcAsn1 asn1, SilcStack stack);
*
* DESCRIPTION
*
* EXAMPLE
*
* SilcAsn1Struct asn1;
- * if (!silc_asn1_init(&asn1))
+ * if (!silc_asn1_init(&asn1, NULL))
* error;
*
***/
-SilcBool silc_asn1_init(SilcAsn1 asn1);
+SilcBool silc_asn1_init(SilcAsn1 asn1, SilcStack stack);
/****f* silcasn1/SilcASN1API/silc_asn1_uninit
*
*
* If the SILC_ASN1_OPTS macro with SILC_ASN1_ALLOC option is given then
* the `dest' is dynamically allocated and caller must free it by itself.
- * Alternatively if SILC_ASN1_ACCUMUL is given then memory is accumulated
- * from `asn1' for `dest' and it is freed only when silc_asn1_free or
- * silc_asn1_uninit is called. Next call to silc_asn1_encode will not
- * cancel the previous result, but will accumulate more memory for new
- * result.
+ * If the `stack' was given to silc_asn1_alloc, the SILC_ASN1_ALLOC will
+ * allocate from that stack and consume the stack. Alternatively if
+ * SILC_ASN1_ACCUMUL is given then memory is accumulated from `asn1' for
+ * `dest' and it is freed only when silc_asn1_free or silc_asn1_uninit
+ * is called. Next call to silc_asn1_encode will not cancel the previous
+ * result, but will accumulate more memory for new result.
*
* The variable argument list is constructed by using various
* macros, for example SILC_ASN1_SEQUENCE, etc. The variable argument
*
* If the SILC_ASN1_OPTS macro with SILC_ASN1_ALLOC option is given then
* all results are dynamically allocated and caller must free them by
- * itself. Alternatively if SILC_ASN1_ACCUMUL is given then memory is
- * accumulated from `asn1' for results and they are freed only when the
- * silc_asn1_free or silc_asn1_uninit is called. Next calls to the
- * silc_asn1_decode will NOT invalidate the old results, but will
- * accumulate more memory for new results. If the SILC_ASN1_OPTS is not
- * given at all then the default allocation method (decribed above)
- * applies.
+ * itself. If the `stack' was given to silc_asn1_alloc, the SILC_ASN1_ALLOC
+ * will allocate from that stack and consume the stack. Alternatively if
+ * SILC_ASN1_ACCUMUL is given then memory is accumulated from `asn1' for
+ * results and they are freed only when the silc_asn1_free or
+ * silc_asn1_uninit is called. Next calls to the silc_asn1_decode will
+ * NOT invalidate the old results, but will accumulate more memory for new
+ * results. If the SILC_ASN1_OPTS is not given at all then the default
+ * allocation method (decribed above) applies.
*
* If caller needs to store the results even after `asn1' becomes invalid
* then call must either use SILC_ASN1_ALLOC option or duplicate the
*
* Decoding:
* SILC_ASN1_ANY(&buffer)
- * SILC_ASN1_ANY_T(opts, tag, &buffer)
+ * SILC_ASN1_ANY_T(opts, tag, buffer)
*
* DESCRIPTION
*
#define SILC_ASN1_ANY(x) SILC_ASN1_U1(ANY, x)
#define SILC_ASN1_ANY_T(o, t, x) SILC_ASN1_T1(ANY, o, t, x)
+/****f* silcasn1/SilcASN1API/SILC_ASN1_ANY_PRIMITIVE
+ *
+ * SYNOPSIS
+ *
+ * Encoding:
+ * SILC_ASN1_ANY_PRIMITIVE(tag, buffer)
+ * SILC_ASN1_ANY_PRIMITIVE_T(opts, tag, buffer)
+ *
+ * Decoding:
+ * SILC_ASN1_ANY_PRIMITIVE(tag, &buffer)
+ * SILC_ASN1_ANY_PRIMITIVE_T(opts, tag, buffer)
+ *
+ * DESCRIPTION
+ *
+ * Special macro used to encode pre-encoded primitive data blob. The data
+ * can be any primitive type that is already encoded in correct format.
+ * The caller is responsible of making sure the data is formatted
+ * correctly. When decoding this returns the raw data blob and the caller
+ * must know of what type and format it is. The buffer type is SilcBuffer.
+ *
+ * This macro can be used in cases when the data to be encoded is already
+ * in encoded format, and it only needs to be added to ASN.1 tree. The
+ * SILC_ASN1_ANY cannot be used with primitives when tagging implicitly,
+ * in these cases this macro can be used.
+ *
+ * The `opts' is SilcAsn1Options. The `tag' is a tag number.
+ *
+ * EXAMPLE
+ *
+ * // Get MP integer in encoded format
+ * mpbuf = mp_get_octet_string(mp);
+ *
+ * // Encode the MP integer data to the tree
+ * silc_asn1_encode(asn1, tree,
+ * SILC_ASN1_ANY_PRIMITIVE(SILC_ASN1_TAG_INTEGER, mpbuf),
+ * SILC_ASN1_END);
+ *
+ * // Decode the MP integer data from the tree
+ * silc_asn1_decode(asn1, tree,
+ * SILC_ASN1_ANY_PRIMITIVE(SILC_ASN1_TAG_INTEGER, &buffer),
+ * SILC_ASN1_END);
+ *
+ ***/
+#define SILC_ASN1_ANY_PRIMITIVE(t, x) SILC_ASN1_T1(ANY_PRIMITIVE, 0, t, x)
+#define SILC_ASN1_ANY_PRIMITIVE_T(o, t, x) SILC_ASN1_T1(ANY_PRIMITIVE, o, t, x)
+
/****f* silcasn1/SilcASN1API/SILC_ASN1_SEQUENCE
*
* SYNOPSIS
* SYNOPSIS
*
* Decoding:
- * SILC_ASN1_CHOICE
+ * SILC_ASN1_CHOICE(&chosen)
*
* DESCRIPTION
*
* Macro used to specify choices in decoding. The choice list must
* be terminated with SILC_ASN1_END. There is no limit how many choices
- * can be specified in the list.
+ * can be specified in the list. The `chosen' is SilcUInt32 and its
+ * value tells which of the choice was found. First choice in the list
+ * has value 1, second value 2, and so on.
*
* EXAMPLE
*
* // Decode timeval that is either UTC or generalized time
* silc_asn1_decode(asn1, tree,
* SILC_ASN1_SEQUENCE,
- * SILC_ASN1_CHOICE,
+ * SILC_ASN1_CHOICE(&chosen),
* SILC_ASN1_UTC_TIME(&timeval),
* SILC_ASN1_GEN_TIME(&timeval),
* SILC_ASN1_END,
* SILC_ASN1_END, SILC_ASN1_END);
*
***/
-#define SILC_ASN1_CHOICE SILC_ASN1_U0(CHOICE)
+#define SILC_ASN1_CHOICE(x) SILC_ASN1_U1(CHOICE, x)
/****f* silcasn1/SilcASN1API/SILC_ASN1_BOOLEAN
*
*
* DESCRIPTION
*
- * Macro used to encode or decode boolean value. Type boolean type
+ * Macro used to encode or decode boolean value. The boolean type
* is SilcBool.
*
* The `opts' is SilcAsn1Options. The `tag' is a tag number.
*
* Encoding:
* SILC_ASN1_INT(integer)
- * SILC_ASN1_INT_T(opts, tag, integer)
+ * SILC_ASN1_INT_T(opts, tag, &integer)
*
* Decoding:
* SILC_ASN1_INT(&integer)
#define SILC_ASN1_INT(x) SILC_ASN1_U1(INTEGER, x)
#define SILC_ASN1_INT_T(o, t, x) SILC_ASN1_T1(INTEGER, o, t, x)
+/****f* silcasn1/SilcASN1API/SILC_ASN1_SHORT_INT
+ *
+ * SYNOPSIS
+ *
+ * Encoding:
+ * SILC_ASN1_SHORT_INT(integer)
+ * SILC_ASN1_SHORT_INT_T(opts, tag, &integer)
+ *
+ * Decoding:
+ * SILC_ASN1_SHORT_INT(&integer)
+ * SILC_ASN1_SHORT_INT_T(opts, tag, &integer);
+ *
+ * DESCRIPTION
+ *
+ * Macro used to encode or decode short integer (32 bits). The
+ * integer type is SilcUInt32.
+ *
+ * The `opts' is SilcAsn1Options. The `tag' is a tag number.
+ *
+ ***/
+#define SILC_ASN1_SHORT_INT(x) SILC_ASN1_U1(SHORT_INTEGER, x)
+#define SILC_ASN1_SHORT_INT_T(o, t, x) SILC_ASN1_T1(SHORT_INTEGER, o, t, x)
+
/****f* silcasn1/SilcASN1API/SILC_ASN1_ENUM
*
* SYNOPSIS
*
* Encoding:
* SILC_ASN1_ENUM(enum)
- * SILC_ASN1_ENUM_T(opts, tag, enum)
+ * SILC_ASN1_ENUM_T(opts, tag, &enum)
*
* Decoding:
* SILC_ASN1_ENUM(&enum)
*
* Encoding:
* SILC_ASN1_NULL
- * SILC_ASN1_NULL_T(opts, tag)
+ * SILC_ASN1_NULL_T(opts, tag, set)
*
* Decoding:
* SILC_ASN1_NULL
- * SILC_ASN1_NULL_T(opts, tag)
+ * SILC_ASN1_NULL_T(opts, tag, &set)
*
* DESCRIPTION
*
* Macro used to encode or decode null value.
*
- * The `opts' is SilcAsn1Options. The `tag' is a tag number.
+ * The `opts' is SilcAsn1Options. The `tag' is a tag number. In encoding
+ * `set' is SilcBool and if it is TRUE the NULL value will be encoded. If
+ * it is FALSE the SILC_ASN1_NULL will be ignored. In decoding the `set'
+ * is SilcBool and if it is TRUE the NULL value was present. This can be
+ * used to verify whether NULL was present if it is SILC_ASN1_OPTIONAL.
*
***/
-#define SILC_ASN1_NULL SILC_ASN1_U0(NULL)
-#define SILC_ASN1_NULL_T(o, t) SILC_ASN1_T0(NULL, 0, t)
+#define SILC_ASN1_NULL(x) SILC_ASN1_U1(NULL, x)
+#define SILC_ASN1_NULL_T(o, t, x) SILC_ASN1_T1(NULL, o, t, x)
/****f* silcasn1/SilcASN1API/SILC_ASN1_OID
*
* DESCRIPTION
*
* Macro used to encode or decode octet string. The string type is
- * unsigned char and string length SilcUInt32.
+ * unsigned char and string length SilcUInt32. Octet string is
+ * considered to be 8-bit unsigned binary data.
*
* The `opts' is SilcAsn1Options. The `tag' is a tag number.
*
- * NOTES
- *
- * The string must be in UTF-8 encoding when encoding. The decoded
- * string will be in UTF-8 encoding. The actual data is encoded to
- * or decoded from 8-bit ASCII.
- *
***/
#define SILC_ASN1_OCTET_STRING(x, xl) SILC_ASN1_U2(OCTET_STRING, x, xl)
#define SILC_ASN1_OCTET_STRING_T(o, t, x, xl) SILC_ASN1_T2(OCTET_STRING, o, t, x, xl)
*
* Decoding:
* SILC_ASN1_UTC_TIME(&str, &timeval)
- * SILC_ASN1_UTC_TIME_T(opts, tag, &timeval)
+ * SILC_ASN1_UTC_TIME_T(opts, tag, timeval)
*
* DESCRIPTION
*
*
* Decoding:
* SILC_ASN1_GEN_TIME(&str, &timeval)
- * SILC_ASN1_GEN_TIME_T(opts, tag, &timeval)
+ * SILC_ASN1_GEN_TIME_T(opts, tag, timeval)
*
* DESCRIPTION
*
projects / silc.git / blobdiff