lib/libcrypto/man/X509_check_ca.3

   1 .\"     $OpenBSD: X509_check_ca.3,v 1.3 2017/01/06 19:19:54 schwarze Exp $
   2 .\"     OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
   3 .\"
   4 .\" This file was written by Victor B. Wagner <vitus@cryptocom.ru>.
   5 .\" Copyright (c) 2015, 2016 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: January 6 2017 $
  52 .Dt X509_CHECK_CA 3
  53 .Os
  54 .Sh NAME
  55 .Nm X509_check_ca
  56 .Nd check whether a certificate is a CA certificate
  57 .Sh SYNOPSIS
  58 .In openssl/x509v3.h
  59 .Ft int
  60 .Fo X509_check_ca
  61 .Fa "X509 *cert"
  62 .Fc
  63 .Sh DESCRIPTION
  64 This function checks whether the given certificate is a CA certificate,
  65 that is, whether it can be used to sign other certificates.
  66 .Sh RETURN VALUES
  67 This functions returns non-zero if
  68 .Fa cert
  69 is a CA certificate or 0 otherwise.
  70 .Pp
  71 The following return values identify specific kinds of CA certificates:
  72 .Bl -tag -width 2n
  73 .It 1
  74 an X.509 v3 CA certificate with
  75 .Sy basicConstraints
  76 extension CA:TRUE
  77 .It 3
  78 a self-signed X.509 v1 certificate
  79 .It 4
  80 a certificate with
  81 .Sy keyUsage
  82 extension with bit
  83 .Sy keyCertSign
  84 set, but without
  85 .Sy basicConstraints
  86 .It 5
  87 a certificate with an outdated Netscape Certificate Type extension telling
  88 that it is a CA certificate
  89 .El
  90 .Sh SEE ALSO
  91 .Xr X509_check_issued 3 ,
  92 .Xr X509_verify_cert 3