lib/util/asn1.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    simple ASN1 code
   4    Copyright (C) Andrew Tridgell 2001
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef _ASN_1_H
  21 #define _ASN_1_H
  22
  23 #include "replace.h"
  24 #include <talloc.h>
  25 #include "lib/util/data_blob.h"
  26
  27
  28 struct nesting;
  29 struct asn1_data;
  30 typedef struct asn1_data ASN1_DATA;
  31
  32 #define ASN1_APPLICATION(x) ((x)+0x60)
  33 #define ASN1_APPLICATION_SIMPLE(x) ((x)+0x40)
  34 #define ASN1_SEQUENCE(x) ((x)+0x30)
  35 #define ASN1_CONTEXT(x) ((x)+0xa0)
  36 #define ASN1_CONTEXT_SIMPLE(x) ((x)+0x80)
  37 #define ASN1_GENERAL_STRING 0x1b
  38 #define ASN1_OCTET_STRING 0x4
  39 #define ASN1_OID 0x6
  40 #define ASN1_BOOLEAN 0x1
  41 #define ASN1_INTEGER 0x2
  42 #define ASN1_BIT_STRING 0x3
  43 #define ASN1_ENUMERATED 0xa
  44 #define ASN1_SET 0x31
  45
  46 #define ASN1_MAX_OIDS 20
  47
  48 struct asn1_data *asn1_init(TALLOC_CTX *mem_ctx);
  49 void asn1_free(struct asn1_data *data);
  50 bool asn1_has_error(const struct asn1_data *data);
  51 void asn1_set_error(struct asn1_data *data);
  52 bool asn1_has_nesting(const struct asn1_data *data);
  53 off_t asn1_current_ofs(const struct asn1_data *data);
  54 bool asn1_write(struct asn1_data *data, const void *p, int len);
  55 bool asn1_write_uint8(struct asn1_data *data, uint8_t v);
  56 bool asn1_push_tag(struct asn1_data *data, uint8_t tag);
  57 bool asn1_pop_tag(struct asn1_data *data);
  58 bool asn1_write_implicit_Integer(struct asn1_data *data, int i);
  59 bool asn1_write_Integer(struct asn1_data *data, int i);
  60 bool asn1_write_BitString(struct asn1_data *data, const void *p, size_t length, uint8_t padding);
  61 bool ber_write_OID_String(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, const char *OID);
  62 bool ber_write_partial_OID_String(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, const char *partial_oid);
  63 bool asn1_write_OID(struct asn1_data *data, const char *OID);
  64 bool asn1_write_OctetString(struct asn1_data *data, const void *p, size_t length);
  65 bool asn1_write_LDAPString(struct asn1_data *data, const char *s);
  66 bool asn1_write_DATA_BLOB_LDAPString(struct asn1_data *data, const DATA_BLOB *s);
  67 bool asn1_write_GeneralString(struct asn1_data *data, const char *s);
  68 bool asn1_write_ContextSimple(struct asn1_data *data, uint8_t num, DATA_BLOB *blob);
  69 bool asn1_write_BOOLEAN(struct asn1_data *data, bool v);
  70 bool asn1_read_BOOLEAN(struct asn1_data *data, bool *v);
  71 bool asn1_check_BOOLEAN(struct asn1_data *data, bool v);
  72 bool asn1_write_BOOLEAN_context(struct asn1_data *data, bool v, int context);
  73 bool asn1_read_BOOLEAN_context(struct asn1_data *data, bool *v, int context);
  74 bool asn1_load(struct asn1_data *data, DATA_BLOB blob);
  75 bool asn1_peek(struct asn1_data *data, void *p, int len);
  76 bool asn1_read(struct asn1_data *data, void *p, int len);
  77 bool asn1_read_uint8(struct asn1_data *data, uint8_t *v);
  78 bool asn1_peek_uint8(struct asn1_data *data, uint8_t *v);
  79 bool asn1_peek_tag(struct asn1_data *data, uint8_t tag);
  80 bool asn1_start_tag(struct asn1_data *data, uint8_t tag);
  81 bool asn1_end_tag(struct asn1_data *data);
  82 int asn1_tag_remaining(struct asn1_data *data);
  83 bool ber_read_OID_String(TALLOC_CTX *mem_ctx, DATA_BLOB blob, char **OID);
  84 bool ber_read_partial_OID_String(TALLOC_CTX *mem_ctx, DATA_BLOB blob, char **partial_oid);
  85 bool asn1_read_OID(struct asn1_data *data, TALLOC_CTX *mem_ctx, char **OID);
  86 bool asn1_check_OID(struct asn1_data *data, const char *OID);
  87 bool asn1_read_LDAPString(struct asn1_data *data, TALLOC_CTX *mem_ctx, char **s);
  88 bool asn1_read_GeneralString(struct asn1_data *data, TALLOC_CTX *mem_ctx, char **s);
  89 bool asn1_read_OctetString(struct asn1_data *data, TALLOC_CTX *mem_ctx, DATA_BLOB *blob);
  90 bool asn1_read_ContextSimple(struct asn1_data *data, TALLOC_CTX *mem_ctx, uint8_t num, DATA_BLOB *blob);
  91 bool asn1_read_implicit_Integer(struct asn1_data *data, int *i);
  92 bool asn1_read_Integer(struct asn1_data *data, int *i);
  93 bool asn1_read_BitString(struct asn1_data *data, TALLOC_CTX *mem_ctx, DATA_BLOB *blob, uint8_t *padding);
  94 bool asn1_read_enumerated(struct asn1_data *data, int *v);
  95 bool asn1_check_enumerated(struct asn1_data *data, int v);
  96 bool asn1_write_enumerated(struct asn1_data *data, uint8_t v);
  97 bool asn1_blob(const struct asn1_data *asn1, DATA_BLOB *blob);
  98 bool asn1_extract_blob(struct asn1_data *asn1, TALLOC_CTX *mem_ctx,
  99                        DATA_BLOB *pblob);
 100 void asn1_load_nocopy(struct asn1_data *data, uint8_t *buf, size_t len);
 101 int asn1_peek_full_tag(DATA_BLOB blob, uint8_t tag, size_t *packet_size);
 102
 103 #endif /* _ASN_1_H */