| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "BN_SET_BIT 3SSL" |
| 58 |
.TH BN_SET_BIT 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
BN_set_bit, BN_clear_bit, BN_is_bit_set, BN_mask_bits, BN_lshift, |
| 65 |
BN_lshift1, BN_rshift, BN_rshift1 \- bit operations on BIGNUMs |
| 66 |
.SH SYNOPSIS |
| 67 |
.IX Header "SYNOPSIS" |
| 68 |
.Vb 1 |
| 69 |
\& #include <openssl/bn.h> |
| 70 |
\& |
| 71 |
\& int BN_set_bit(BIGNUM *a, int n); |
| 72 |
\& int BN_clear_bit(BIGNUM *a, int n); |
| 73 |
\& |
| 74 |
\& int BN_is_bit_set(const BIGNUM *a, int n); |
| 75 |
\& |
| 76 |
\& int BN_mask_bits(BIGNUM *a, int n); |
| 77 |
\& |
| 78 |
\& int BN_lshift(BIGNUM *r, const BIGNUM *a, int n); |
| 79 |
\& int BN_lshift1(BIGNUM *r, BIGNUM *a); |
| 80 |
\& |
| 81 |
\& int BN_rshift(BIGNUM *r, BIGNUM *a, int n); |
| 82 |
\& int BN_rshift1(BIGNUM *r, BIGNUM *a); |
| 83 |
.Ve |
| 84 |
.SH DESCRIPTION |
| 85 |
.IX Header "DESCRIPTION" |
| 86 |
\&\fBBN_set_bit()\fR sets bit \fBn\fR in \fBa\fR to 1 (\f(CW\*(C`a|=(1<<n)\*(C'\fR). The |
| 87 |
number is expanded if necessary. |
| 88 |
.PP |
| 89 |
\&\fBBN_clear_bit()\fR sets bit \fBn\fR in \fBa\fR to 0 (\f(CW\*(C`a&=~(1<<n)\*(C'\fR). An |
| 90 |
error occurs if \fBa\fR is shorter than \fBn\fR bits. |
| 91 |
.PP |
| 92 |
\&\fBBN_is_bit_set()\fR tests if bit \fBn\fR in \fBa\fR is set. |
| 93 |
.PP |
| 94 |
\&\fBBN_mask_bits()\fR truncates \fBa\fR to an \fBn\fR bit number |
| 95 |
(\f(CW\*(C`a&=~((~0)<<n)\*(C'\fR). An error occurs if \fBn\fR is negative. An error is |
| 96 |
also returned if the internal representation of \fBa\fR is already shorter than |
| 97 |
\&\fBn\fR bits. The internal representation depends on the platform's word size, and |
| 98 |
this error can be safely ignored. Use \fBBN_num_bits\fR\|(3) to determine the exact |
| 99 |
number of bits if needed. |
| 100 |
.PP |
| 101 |
\&\fBBN_lshift()\fR shifts \fBa\fR left by \fBn\fR bits and places the result in |
| 102 |
\&\fBr\fR (\f(CW\*(C`r=a*2^n\*(C'\fR). Note that \fBn\fR must be nonnegative. \fBBN_lshift1()\fR shifts |
| 103 |
\&\fBa\fR left by one and places the result in \fBr\fR (\f(CW\*(C`r=2*a\*(C'\fR). |
| 104 |
.PP |
| 105 |
\&\fBBN_rshift()\fR shifts \fBa\fR right by \fBn\fR bits and places the result in |
| 106 |
\&\fBr\fR (\f(CW\*(C`r=a/2^n\*(C'\fR). Note that \fBn\fR must be nonnegative. \fBBN_rshift1()\fR shifts |
| 107 |
\&\fBa\fR right by one and places the result in \fBr\fR (\f(CW\*(C`r=a/2\*(C'\fR). |
| 108 |
.PP |
| 109 |
For the shift functions, \fBr\fR and \fBa\fR may be the same variable. |
| 110 |
.SH "RETURN VALUES" |
| 111 |
.IX Header "RETURN VALUES" |
| 112 |
\&\fBBN_is_bit_set()\fR returns 1 if the bit is set, 0 otherwise. |
| 113 |
.PP |
| 114 |
All other functions return 1 for success, 0 on error. The error codes |
| 115 |
can be obtained by \fBERR_get_error\fR\|(3). |
| 116 |
.SH "SEE ALSO" |
| 117 |
.IX Header "SEE ALSO" |
| 118 |
\&\fBBN_num_bytes\fR\|(3), \fBBN_add\fR\|(3) |
| 119 |
.SH COPYRIGHT |
| 120 |
.IX Header "COPYRIGHT" |
| 121 |
Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. |
| 122 |
.PP |
| 123 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 124 |
this file except in compliance with the License. You can obtain a copy |
| 125 |
in the file LICENSE in the source distribution or at |
| 126 |
<https://www.openssl.org/source/license.html>. |