Some documentation corrections
[strongswan.git] / src / libstrongswan / credentials / cert_validator.h
1 /*
2 * Copyright (C) 2010 Martin Willi
3 * Copyright (C) 2010 revosec AG
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 cert_validator cert_validator
18 * @{ @ingroup credentials
19 */
20
21 #ifndef CERT_VALIDATOR_H_
22 #define CERT_VALIDATOR_H_
23
24 typedef struct cert_validator_t cert_validator_t;
25
26 #include <library.h>
27
28 /**
29 * Certificate validator interface.
30 *
31 * A certificate validator checks constraints or revocation in a certificate
32 * or its issuing CA certificate. The interface allows plugins to do
33 * revocation checking or similar tasks.
34 */
35 struct cert_validator_t {
36
37 /**
38 * Validate a subject certificate in relation to its issuer.
39 *
40 * @param subject subject certificate to check
41 * @param issuer issuer of subject
42 * @param online whether to do online revocation checking
43 * @param pathlen the current length of the path bottom-up
44 * @param anchor is issuer trusted root anchor
45 * @param auth container for resulting authentication info
46 */
47 bool (*validate)(cert_validator_t *this, certificate_t *subject,
48 certificate_t *issuer, bool online, u_int pathlen,
49 bool anchor, auth_cfg_t *auth);
50 };
51
52 #endif /** CERT_VALIDATOR_H_ @}*/