1X509_CHECK_PURPOSE(3ossl)           OpenSSL          X509_CHECK_PURPOSE(3ossl)
2
3
4

NAME

6       X509_check_purpose - Check the purpose of a certificate
7

SYNOPSIS

9        #include <openssl/x509v3.h>
10
11        int X509_check_purpose(X509 *x, int id, int ca);
12

DESCRIPTION

14       This function checks if certificate x was created with the purpose
15       represented by id. If ca is nonzero, then certificate x is checked to
16       determine if it's a possible CA with various levels of certainty
17       possibly returned. The certificate x must be a complete certificate
18       otherwise the function returns an error.
19
20       Below are the potential ID's that can be checked:
21
22        # define X509_PURPOSE_SSL_CLIENT        1
23        # define X509_PURPOSE_SSL_SERVER        2
24        # define X509_PURPOSE_NS_SSL_SERVER     3
25        # define X509_PURPOSE_SMIME_SIGN        4
26        # define X509_PURPOSE_SMIME_ENCRYPT     5
27        # define X509_PURPOSE_CRL_SIGN          6
28        # define X509_PURPOSE_ANY               7
29        # define X509_PURPOSE_OCSP_HELPER       8
30        # define X509_PURPOSE_TIMESTAMP_SIGN    9
31
32       The checks performed take into account the X.509 extensions keyUsage,
33       extendedKeyUsage, and basicConstraints.
34

RETURN VALUES

36       For non-CA checks
37
38       -1 an error condition has occurred
39        1 if the certificate was created to perform the purpose represented by
40       id
41        0 if the certificate was not created to perform the purpose
42       represented by id
43
44       For CA checks the below integers could be returned with the following
45       meanings:
46
47       -1 an error condition has occurred
48        0 not a CA or does not have the purpose represented by id
49        1 is a CA.
50        2 Only possible in old versions of openSSL when basicConstraints are
51       absent. New versions will not return this value. May be a CA
52        3 basicConstraints absent but self signed V1.
53        4 basicConstraints absent but keyUsage present and keyCertSign
54       asserted.
55        5 legacy Netscape specific CA Flags present
56

58       Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
59       Licensed under the Apache License 2.0 (the "License"). You may not use
60       this file except in compliance with the License. You can obtain a copy
61       in the file LICENSE in the source distribution or at
62       <https://www.openssl.org/source/license.html>.
63
64
65
663.1.1                             2023-08-31         X509_CHECK_PURPOSE(3ossl)
Impressum