aboutsummaryrefslogtreecommitdiffstats
path: root/Source/lib/asn1/der_decoder.h
blob: 68731b5d9c609cb97f9ee747eff358640e0c6faf (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
/**
 * @file der_decoder.h
 *
 * @brief Interface of der_decoder_t.
 *
 */

/*
 * Copyright (C) 2006 Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * 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 the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef DER_DECODER_H_
#define DER_DECODER_H_

#include <types.h>
#include <asn1/asn1.h>

typedef struct der_decoder_t der_decoder_t;

/**
 * @brief Decode ASN1 DER encoded chunks.
 * 
 * @b Constructors:
 *  - der_decoder_create()
 * 
 * @todo A lot.
 * 
 * @ingroup asn1
 */
struct der_decoder_t {
	
	/**
	 * @brief Decode a chunk of bytes to a data structure
	 *
	 * @param der_decoder 	calling object
	 * @param input			chunk of data to decode
	 * @param output		data structure where decoded data is written
	 * @return
	 * 						- PARSE_ERROR
	 * 						- FAILED
	 * 						- NOT_SUPPORTED
	 * 						- or SUCCESS sometimes
	 */
	status_t (*decode) (der_decoder_t *this, chunk_t input, void *output);

	/**
	 * @brief Destroys a der_decoder object.
	 *
	 * @param der_decoder 	calling object
	 */
	void (*destroy) (der_decoder_t *this);
};


/**
 * @brief Create a der_decoder instance.
 * 
 * The instance needs ASN1 rules to know how to decode
 * data...
 * 
 * @param rules		set of ASN1 coding rules
 * @return			der_decoder_t object
 * 
 * @ingroup ans1
 */
der_decoder_t * der_decoder_create(asn1_rule_t* rules);

#endif /* DER_DECODER_H_ */