Blame doc/manpages/gnutls_x509_crt_get_key_usage.3

Packit 549fdc
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit 549fdc
.TH "gnutls_x509_crt_get_key_usage" 3 "3.6.2" "gnutls" "gnutls"
Packit 549fdc
.SH NAME
Packit 549fdc
gnutls_x509_crt_get_key_usage \- API function
Packit 549fdc
.SH SYNOPSIS
Packit 549fdc
.B #include <gnutls/x509.h>
Packit 549fdc
.sp
Packit 549fdc
.BI "int gnutls_x509_crt_get_key_usage(gnutls_x509_crt_t " cert ", unsigned int * " key_usage ", unsigned int * " critical ");"
Packit 549fdc
.SH ARGUMENTS
Packit 549fdc
.IP "gnutls_x509_crt_t cert" 12
Packit 549fdc
should contain a \fBgnutls_x509_crt_t\fP type
Packit 549fdc
.IP "unsigned int * key_usage" 12
Packit 549fdc
where the key usage bits will be stored
Packit 549fdc
.IP "unsigned int * critical" 12
Packit 549fdc
will be non\-zero if the extension is marked as critical
Packit 549fdc
.SH "DESCRIPTION"
Packit 549fdc
This function will return certificate's key usage, by reading the
Packit 549fdc
keyUsage X.509 extension (2.5.29.15). The key usage value will ORed
Packit 549fdc
values of the: \fBGNUTLS_KEY_DIGITAL_SIGNATURE\fP,
Packit 549fdc
\fBGNUTLS_KEY_NON_REPUDIATION\fP, \fBGNUTLS_KEY_KEY_ENCIPHERMENT\fP,
Packit 549fdc
\fBGNUTLS_KEY_DATA_ENCIPHERMENT\fP, \fBGNUTLS_KEY_KEY_AGREEMENT\fP,
Packit 549fdc
\fBGNUTLS_KEY_KEY_CERT_SIGN\fP, \fBGNUTLS_KEY_CRL_SIGN\fP,
Packit 549fdc
\fBGNUTLS_KEY_ENCIPHER_ONLY\fP, \fBGNUTLS_KEY_DECIPHER_ONLY\fP.
Packit 549fdc
.SH "RETURNS"
Packit 549fdc
zero on success, or a negative error code in case of
Packit 549fdc
parsing error.  If the certificate does not contain the keyUsage
Packit 549fdc
extension \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be
Packit 549fdc
returned.
Packit 549fdc
.SH "REPORTING BUGS"
Packit 549fdc
Report bugs to <bugs@gnutls.org>.
Packit 549fdc
.br
Packit 549fdc
Home page: http://www.gnutls.org
Packit 549fdc
Packit 549fdc
.SH COPYRIGHT
Packit 549fdc
Copyright \(co 2001-2018 Free Software Foundation, Inc., and others.
Packit 549fdc
.br
Packit 549fdc
Copying and distribution of this file, with or without modification,
Packit 549fdc
are permitted in any medium without royalty provided the copyright
Packit 549fdc
notice and this notice are preserved.
Packit 549fdc
.SH "SEE ALSO"
Packit 549fdc
The full documentation for
Packit 549fdc
.B gnutls
Packit 549fdc
is maintained as a Texinfo manual.
Packit 549fdc
If the /usr/share/doc/gnutls/
Packit 549fdc
directory does not contain the HTML form visit
Packit 549fdc
.B
Packit 549fdc
.IP http://www.gnutls.org/manual/
Packit 549fdc
.PP