added component BUILD_FROM_FILE
[strongswan.git] / src / libstrongswan / credentials / builder.h
1 /*
2 * Copyright (C) 2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup builder builder
18 * @{ @ingroup credentials
19 */
20
21 #ifndef BUILDER_H_
22 #define BUILDER_H_
23
24 typedef struct builder_t builder_t;
25 typedef enum builder_part_t builder_part_t;
26
27 /**
28 * Constructor function which creates a new builder instance.
29 *
30 * @param subtype constructor specific subtype, e.g. certificate_type_t
31 * @return builder to construct a instance of type
32 */
33 typedef builder_t* (*builder_constructor_t)(int subtype);
34
35 #include <library.h>
36
37 /**
38 * Parts to build credentials from.
39 */
40 enum builder_part_t {
41 /** path to a file containing an ASN1 blob, char* */
42 BUILD_FROM_FILE,
43 /** DER encoded ASN1 blob, chunk_t */
44 BUILD_BLOB_ASN1_DER,
45 /** key size in bits, as used for key generation, u_int */
46 BUILD_KEY_SIZE,
47 /** private key to use for signing, private_key_t* */
48 BUILD_SIGNING_KEY,
49 /** certificate used for signing, certificate_t* */
50 BUILD_SIGNING_CERT,
51 /** public key to include, public_key_t* */
52 BUILD_PUBLIC_KEY,
53 /** subject for e.g. certificates, identification_t* */
54 BUILD_SUBJECT,
55 /** additional subject name, identification_t* */
56 BUILD_SUBJECT_ALTNAME,
57 /** issuer for e.g. certificates, identification_t* */
58 BUILD_ISSUER,
59 /** additional issuer name, identification_t* */
60 BUILD_ISSUER_ALTNAME,
61 /** notBefore, time_t* */
62 BUILD_NOT_BEFORE_TIME,
63 /** notAfter, time_t* */
64 BUILD_NOT_AFTER_TIME,
65 /** a serial number in binary form, chunk_t */
66 BUILD_SERIAL,
67 /** a comma-separated list of ietf group attributes, char* */
68 BUILD_IETF_GROUP_ATTR,
69 /** a ca certificate, certificate_t* */
70 BUILD_CA_CERT,
71 /** a certificate, certificate_t* */
72 BUILD_CERT,
73 /** enforce an additional X509 flag, x509_flag_t */
74 BUILD_X509_FLAG,
75 /** end of variable argument builder list */
76 BUILD_END,
77 };
78
79 /**
80 * enum names for build_part_t
81 */
82 extern enum_name_t *builder_part_names;
83
84 /**
85 * Credential construction API.
86 *
87 * The builder allows the construction of credentials in a generic and
88 * flexible way.
89 */
90 struct builder_t {
91
92 /**
93 * Add a part to the construct.
94 *
95 * Any added parts get owned by the builder/construct, so clone/refcount
96 * them if needed.
97 *
98 * @param part kind of part
99 * @param ... part specific variable argument
100 */
101 void (*add)(builder_t *this, builder_part_t part, ...);
102
103 /**
104 * Build the construct with all supplied parts.
105 *
106 * Once build() is called, the builder gets destroyed.
107 *
108 * @return specific interface, as requested with constructor.
109 */
110 void* (*build)(builder_t *this);
111 };
112
113 #endif /* BUILDER_H_ @}*/