$NetBSD: BN_zero.3,v 1.25 2024/09/08 13:08:17 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BN_zero 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment operations Header "SYNOPSIS" .Vb 1 #include <openssl/bn.h> \& void BN_zero(BIGNUM *a); int BN_one(BIGNUM *a); \& const BIGNUM *BN_value_one(void); \& int BN_set_word(BIGNUM *a, BN_ULONG w); unsigned BN_ULONG BN_get_word(BIGNUM *a); .Ve Header "DESCRIPTION" \fBBN_ULONG is a macro that will be an unsigned integral type optimized for the most efficient implementation on the local platform.

\fBBN_zero(), BN_one() and BN_set_word() set a to the values 0, 1 and \fBw respectively. BN_zero() and BN_one() are macros.

\fBBN_value_one() returns a BIGNUM constant of value 1. This constant is useful for use in comparisons and assignment.

\fBBN_get_word() returns a, if it can be represented as a BN_ULONG.

Header "RETURN VALUES" \fBBN_get_word() returns the value a, or all-bits-set if a cannot be represented as a single integer.

\fBBN_one() and BN_set_word() return 1 on success, 0 otherwise. \fBBN_value_one() returns the constant. \fBBN_zero() never fails and returns no value.

Header "BUGS" If a BIGNUM is equal to the value of all-bits-set, it will collide with the error condition returned by BN_get_word() which uses that as an error value.

\fBBN_ULONG should probably be a typedef.

Header "SEE ALSO" \fBBN_bn2bin\|(3) Header "HISTORY" In OpenSSL 0.9.8, BN_zero() was changed to not return a value; previous versions returned an int. Header "COPYRIGHT" Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.