From 19d585b1d0bfb7b60be8d1223888bfc82bf234b6 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Sat, 25 Mar 2017 19:12:59 +0000 Subject: document the public function X509_cmp_time(3); from Emilia Kasper , OpenSSL commit 80770da3, tweaked by me --- src/lib/libcrypto/man/Makefile | 3 +- src/lib/libcrypto/man/X509_cmp_time.3 | 86 +++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+), 1 deletion(-) create mode 100644 src/lib/libcrypto/man/X509_cmp_time.3 (limited to 'src') diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index 70a73799c6..ba04657232 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.116 2017/03/25 17:15:59 schwarze Exp $ +# $OpenBSD: Makefile,v 1.117 2017/03/25 19:12:59 schwarze Exp $ .include @@ -222,6 +222,7 @@ MAN= \ X509_check_ca.3 \ X509_check_host.3 \ X509_check_issued.3 \ + X509_cmp_time.3 \ X509_get_pubkey.3 \ X509_get_serialNumber.3 \ X509_get_subject_name.3 \ diff --git a/src/lib/libcrypto/man/X509_cmp_time.3 b/src/lib/libcrypto/man/X509_cmp_time.3 new file mode 100644 index 0000000000..55ac836515 --- /dev/null +++ b/src/lib/libcrypto/man/X509_cmp_time.3 @@ -0,0 +1,86 @@ +.\" $OpenBSD: X509_cmp_time.3,v 1.1 2017/03/25 19:12:59 schwarze Exp $ +.\" OpenSSL X509_cmp_time.pod 80770da3 Feb 17 19:00:15 2017 +0100 +.\" +.\" This file was written by Emilia Kasper +.\" Copyright (c) 2017 The OpenSSL Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" +.\" 3. All advertising materials mentioning features or use of this +.\" software must display the following acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" +.\" +.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to +.\" endorse or promote products derived from this software without +.\" prior written permission. For written permission, please contact +.\" openssl-core@openssl.org. +.\" +.\" 5. Products derived from this software may not be called "OpenSSL" +.\" nor may "OpenSSL" appear in their names without prior written +.\" permission of the OpenSSL Project. +.\" +.\" 6. Redistributions of any form whatsoever must retain the following +.\" acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY +.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR +.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +.\" OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd $Mdocdate: March 25 2017 $ +.Dt X509_CMP_TIME 3 +.Os +.Sh NAME +.Nm X509_cmp_time +.Nd compare an ASN.1 Time to a time in seconds since the Epoch +.Sh SYNOPSIS +.In openssl/x509.h +.Ft int +.Fo X509_cmp_time +.Fa "const ASN1_TIME *asn1_time" +.Fa "time_t *cmp_time" +.Fc +.Sh DESCRIPTION +.Fn X509_cmp_time +parses +.Fa asn1_time +with +.Xr ASN1_time_parse 3 +and compares it to +.Fa cmp_time . +If +.Fa cmp_time +is +.Dv NULL , +the current time is used. +.Sh RETURN VALUES +.Xr X509_cmp_time 3 +returns -1 if +.Fa asn1_time +is earlier than or equal to +.Fa cmp_time , +1 if it is later, or 0 on error. +.Sh SEE ALSO +.Xr ASN1_time_parse 3 , +.Xr time 3 -- cgit v1.2.3-55-g6feb