| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | =pod | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | =head1 NAME | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2000-02-24 19:55:57 +08:00
										 |  |  | BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word - arithmetic | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | functions on BIGNUMs with integers | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | =head1 SYNOPSIS | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |  #include <openssl/bn.h> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |  int BN_add_word(BIGNUM *a, BN_ULONG w); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |  int BN_sub_word(BIGNUM *a, BN_ULONG w); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |  int BN_mul_word(BIGNUM *a, BN_ULONG w); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |  BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2000-02-03 09:26:07 +08:00
										 |  |  |  BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w); | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | =head1 DESCRIPTION | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | These functions perform arithmetic operations on BIGNUMs with unsigned | 
					
						
							|  |  |  | integers. They are much more efficient than the normal BIGNUM | 
					
						
							|  |  |  | arithmetic operations. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | BN_add_word() adds B<w> to B<a> (C<a+=w>). | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2000-01-27 09:50:42 +08:00
										 |  |  | BN_sub_word() subtracts B<w> from B<a> (C<a-=w>). | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2005-07-26 06:57:54 +08:00
										 |  |  | BN_mul_word() multiplies B<a> and B<w> (C<a*=w>). | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | BN_div_word() divides B<a> by B<w> (C<a/=w>) and returns the remainder. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2005-07-26 06:57:54 +08:00
										 |  |  | BN_mod_word() returns the remainder of B<a> divided by B<w> (C<a%w>). | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | For BN_div_word() and BN_mod_word(), B<w> must not be 0. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | =head1 RETURN VALUES | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | BN_add_word(), BN_sub_word() and BN_mul_word() return 1 for success, 0 | 
					
						
							| 
									
										
										
										
											2015-08-18 03:21:33 +08:00
										 |  |  | on error. The error codes can be obtained by L<ERR_get_error(3)>. | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2005-07-26 06:57:54 +08:00
										 |  |  | BN_mod_word() and BN_div_word() return B<a>%B<w> on success and | 
					
						
							|  |  |  | B<(BN_ULONG)-1> if an error occurred. | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | =head1 SEE ALSO | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-11 21:56:44 +08:00
										 |  |  | L<ERR_get_error(3)>, L<BN_add(3)> | 
					
						
							| 
									
										
										
										
											2000-01-24 06:06:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-05-18 23:44:05 +08:00
										 |  |  | =head1 COPYRIGHT | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-11 21:56:44 +08:00
										 |  |  | Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. | 
					
						
							| 
									
										
										
										
											2016-05-18 23:44:05 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-12-06 21:04:44 +08:00
										 |  |  | Licensed under the Apache License 2.0 (the "License").  You may not use | 
					
						
							| 
									
										
										
										
											2016-05-18 23:44:05 +08:00
										 |  |  | this file except in compliance with the License.  You can obtain a copy | 
					
						
							|  |  |  | in the file LICENSE in the source distribution or at | 
					
						
							|  |  |  | L<https://www.openssl.org/source/license.html>. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | =cut |