aboutsummaryrefslogtreecommitdiff
path: root/src/lib/krb5/asn.1/asn1_make.h
blob: dcbaa16c417c368832f3cbccdc92191efd6c3b83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 * src/lib/krb5/asn.1/asn1_make.h
 *
 * Copyright 1994 by the Massachusetts Institute of Technology.
 * All Rights Reserved.
 *
 * Export of this software from the United States of America may
 *   require a specific license from the United States Government.
 *   It is the responsibility of any person or organization contemplating
 *   export to obtain such a license before exporting.
 *
 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
 * distribute this software and its documentation for any purpose and
 * without fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright notice and
 * this permission notice appear in supporting documentation, and that
 * the name of M.I.T. not be used in advertising or publicity pertaining
 * to distribution of the software without specific, written prior
 * permission.  Furthermore if you modify this software you must label
 * your software as modified software and not distribute it in such a
 * fashion that it might be confused with the original M.I.T. software.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is" without express
 * or implied warranty.
 */

#ifndef __ASN1_MAKE_H__
#define __ASN1_MAKE_H__

#include "k5-int.h"
#include "krbasn1.h"
#include "asn1buf.h"

/*
 * Overview
 *
 *   Each of these procedures constructs a subpart of an ASN.1
 *   primitive in a coding buffer.
 *
 *  Operations
 *
 *    asn1_make_etag
 *    asn1_make_sequence
 *    asn1_make_set
 *    asn1_make_tag
 *    asn1_make_string
 */

asn1_error_code asn1_make_etag(asn1buf *buf, asn1_class asn1class,
                               asn1_tagnum tagnum, unsigned int in_len,
                               unsigned int *retlen);
/*
 * requires  *buf is allocated, in_len is the length of an ASN.1 encoding
 *           which has just been inserted in *buf
 * modifies  *buf, *retlen
 * effects   Inserts an explicit tag with class = asn1class, id# = tag
 *            length = in_len into *buf.
 *           Returns the length of this encoding in *retlen.
 *           Returns ENOMEM if memory runs out.
 */

asn1_error_code asn1_make_tag(asn1buf *buf, asn1_class asn1class,
                              asn1_construction construction,
                              asn1_tagnum tagnum, unsigned int in_len,
                              unsigned int *retlen);
/*
 * requires  *buf is allocated, in_len is the length of an ASN.1 encoding
 *           which has just been inserted in *buf
 * modifies  *buf, *retlen
 * effects   Inserts the encoding of a tag with class = asn1class,
 *            primitive/constructed staus = construction,
 *            id# = tag and length = in_len into *buf.
 *           Returns the length of this encoding in *retlen.
 *           Returns ENOMEM if memory runs out.
 *           Returns ASN1_OVERFLOW if tagnum exceeds the limits of
 *            the implementation.
 */

asn1_error_code asn1_make_sequence(asn1buf *buf, const unsigned int seq_len,
                                   unsigned int *len);
/*
 * requires  *buf is allocated, seq_len is the length of a series of
 *           sequence components which have just been inserted in *buf
 * modifies  *buf, *retlen
 * effects   Inserts the sequence header for a sequence of length seq_len
 *            in *buf.  Returns the length of this encoding in *retlen.
 *           Returns ENOMEM if memory runs out.
 */

asn1_error_code asn1_make_set(asn1buf *buf, const unsigned int set_len,
                              unsigned int *retlen);
/*
 * requires  *buf is allocated, seq_len is the length of a series of
 *           sequence components which have just been inserted in *buf
 * modifies  *buf, *retlen
 * effects   Inserts the set header for a set of length set_len in *buf.
 *           Returns the length of this encoding in *retlen.
 *           Returns ENOMEM if memory runs out.
 */

asn1_error_code asn1_make_string(asn1buf *buf, const unsigned int len,
                                 const char *string, int *retlen);
/*
 * requires  *buf is allocated, len is the length of *string
 * effects   Inserts the encoding of *string (a series of octets) in *buf.
 *           Returns the length of this encoding in *retlen.
 *           Returns ENOMEM if memory runs out.
 */


/****************************************************************/
/* Private procedures */

/* "helper" procedure for asn1_make_tag */
asn1_error_code asn1_make_length(asn1buf *buf, const unsigned int in_len,
                                 unsigned int *retlen);
/*
 * requires  *buf is allocated, in_len is the length of an ASN.1 encoding
 *           which has just been inserted in *buf
 * modifies  *buf, *retlen
 * effects   inserts length octet(s) for in_len into *buf
 */

/* "helper" procedure for asn1_make_tag */
asn1_error_code asn1_make_id(asn1buf *buf, asn1_class asn1class,
                             asn1_construction construction,
                             asn1_tagnum tagnum, unsigned int *retlen);
/*
 * requires  *buf is allocated, asn1class and tagnum are appropriate for
 *           the ASN.1 encoding which has just been inserted in *buf
 * modifies  *buf, *retlen
 * effects   Inserts id octet(s) of class asn1class and tag number tagnum
 *           into *buf
 */

#endif