1 /*
2  * src/lib/krb5/asn.1/asn1_decode.h
3  *
4  * Copyright 1994 by the Massachusetts Institute of Technology.
5  * All Rights Reserved.
6  *
7  * Export of this software from the United States of America may
8  *   require a specific license from the United States Government.
9  *   It is the responsibility of any person or organization contemplating
10  *   export to obtain such a license before exporting.
11  *
12  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
13  * distribute this software and its documentation for any purpose and
14  * without fee is hereby granted, provided that the above copyright
15  * notice appear in all copies and that both that copyright notice and
16  * this permission notice appear in supporting documentation, and that
17  * the name of M.I.T. not be used in advertising or publicity pertaining
18  * to distribution of the software without specific, written prior
19  * permission.  Furthermore if you modify this software you must label
20  * your software as modified software and not distribute it in such a
21  * fashion that it might be confused with the original M.I.T. software.
22  * M.I.T. makes no representations about the suitability of
23  * this software for any purpose.  It is provided "as is" without express
24  * or implied warranty.
25  */
26 
27 #ifndef __ASN1_DECODE_H__
28 #define __ASN1_DECODE_H__
29 
30 #include "k5-int.h"
31 #include "krbasn1.h"
32 #include "asn1buf.h"
33 
34 /*
35    Overview
36 
37      These procedures take an asn1buf whose current position points
38      to the beginning of an ASN.1 primitive (<id><length><contents>).
39      The primitive is removed from the buffer and decoded.
40 
41    Operations
42 
43     asn1_decode_integer
44     asn1_decode_unsigned_integer
45     asn1_decode_octetstring
46     asn1_decode_charstring
47     asn1_decode_generalstring
48     asn1_decode_null
49     asn1_decode_printablestring
50     asn1_decode_ia5string
51     asn1_decode_generaltime
52 */
53 
54 /* asn1_error_code asn1_decode_type(asn1buf *buf, ctype *val); */
55 /* requires  *buf is allocated
56    modifies  *buf, *len
57    effects   Decodes the octet string in *buf into *val.
58              Returns ENOMEM if memory is exhausted.
59 	     Returns asn1 errors. */
60 
61 asn1_error_code asn1_decode_integer
62 	(asn1buf *buf, long *val);
63 asn1_error_code asn1_decode_unsigned_integer
64 	(asn1buf *buf, unsigned long *val);
65 asn1_error_code asn1_decode_maybe_unsigned
66 	(asn1buf *buf, unsigned long *val);
67 asn1_error_code asn1_decode_null
68 	(asn1buf *buf);
69 
70 asn1_error_code asn1_decode_oid
71 	(asn1buf *buf, unsigned int *retlen, asn1_octet **val);
72 asn1_error_code asn1_decode_octetstring
73 	(asn1buf *buf, unsigned int *retlen, asn1_octet **val);
74 asn1_error_code asn1_decode_generalstring
75 	(asn1buf *buf, unsigned int *retlen, char **val);
76 asn1_error_code asn1_decode_charstring
77 	(asn1buf *buf, unsigned int *retlen, char **val);
78 /* Note: A charstring is a special hack to account for the fact that
79          krb5 structures store some OCTET STRING values in krb5_octet
80 	 arrays and others in krb5_data structures
81 	 (which use char arrays).
82 	 From the ASN.1 point of view, the two string types are the same,
83 	 only the receptacles differ. */
84 asn1_error_code asn1_decode_printablestring
85 	(asn1buf *buf, int *retlen, char **val);
86 asn1_error_code asn1_decode_ia5string
87 	(asn1buf *buf, int *retlen, char **val);
88 
89 asn1_error_code asn1_decode_generaltime
90 	(asn1buf *buf, time_t *val);
91 
92 #endif
93