[thirdparty/openssl.git] / doc / man3 / RSA_blinding_on.pod

=pod

=head1 NAME

RSA_blinding_on, RSA_blinding_off - protect the RSA operation from timing attacks

=head1 SYNOPSIS

 #include <openssl/rsa.h>

 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);

 void RSA_blinding_off(RSA *rsa);

=head1 DESCRIPTION

RSA is vulnerable to timing attacks. In a setup where attackers can
measure the time of RSA decryption or signature operations, blinding
must be used to protect the RSA operation from that attack.

RSA_blinding_on() turns blinding on for key B<rsa> and generates a
random blinding factor. B<ctx> is B<NULL> or a pre-allocated and
initialized B<BN_CTX>. The random number generator must be seeded
prior to calling RSA_blinding_on().

RSA_blinding_off() turns blinding off and frees the memory used for
the blinding factor.

=head1 RETURN VALUES

RSA_blinding_on() returns 1 on success, and 0 if an error occurred.

RSA_blinding_off() returns no value.

=head1 COPYRIGHT

Copyright 2000-2016 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
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
2186cd8e UM	1	=pod
	2
	3	=head1 NAME
	4
4d524e10	5	RSA_blinding_on, RSA_blinding_off - protect the RSA operation from timing attacks
2186cd8e UM	6
	7	=head1 SYNOPSIS
	8
	9	#include <openssl/rsa.h>
	10
	11	int RSA_blinding_on(RSA rsa, BN_CTX ctx);
	12
	13	void RSA_blinding_off(RSA *rsa);
	14
	15	=head1 DESCRIPTION
	16
6a3fff5e	17	RSA is vulnerable to timing attacks. In a setup where attackers can
2186cd8e UM	18	measure the time of RSA decryption or signature operations, blinding
	19	must be used to protect the RSA operation from that attack.
	20
	21	RSA_blinding_on() turns blinding on for key B<rsa> and generates a
	22	random blinding factor. B<ctx> is B<NULL> or a pre-allocated and
	23	initialized B<BN_CTX>. The random number generator must be seeded
	24	prior to calling RSA_blinding_on().
	25
	26	RSA_blinding_off() turns blinding off and frees the memory used for
	27	the blinding factor.
	28
	29	=head1 RETURN VALUES
	30
	31	RSA_blinding_on() returns 1 on success, and 0 if an error occurred.
	32
	33	RSA_blinding_off() returns no value.
	34
e2f92610 RS	35	=head1 COPYRIGHT
	36
	37	Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
	38
4746f25a	39	Licensed under the Apache License 2.0 (the "License"). You may not use
e2f92610 RS	40	this file except in compliance with the License. You can obtain a copy
	41	in the file LICENSE in the source distribution or at
	42	L<https://www.openssl.org/source/license.html>.
	43
	44	=cut