summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/doc')
-rw-r--r--src/lib/libcrypto/doc/RAND_add.pod30
-rw-r--r--src/lib/libcrypto/doc/RAND_bytes.pod43
-rw-r--r--src/lib/libcrypto/doc/RAND_cleanup.pod25
-rw-r--r--src/lib/libcrypto/doc/RAND_load_file.pod52
-rw-r--r--src/lib/libcrypto/doc/RAND_set_rand_method.pod40
5 files changed, 0 insertions, 190 deletions
diff --git a/src/lib/libcrypto/doc/RAND_add.pod b/src/lib/libcrypto/doc/RAND_add.pod
deleted file mode 100644
index 3ffd4910c4..0000000000
--- a/src/lib/libcrypto/doc/RAND_add.pod
+++ /dev/null
@@ -1,30 +0,0 @@
1=pod
2
3=head1 NAME
4
5RAND_add, RAND_seed, RAND_status - add entropy to the PRNG (DEPRECATED)
6
7=head1 SYNOPSIS
8
9 #include <openssl/rand.h>
10
11 void RAND_seed(const void *buf, int num);
12
13 void RAND_add(const void *buf, int num, double entropy);
14
15 int RAND_status(void);
16
17=head1 DESCRIPTION
18
19These functions used to allow for the state of the random number generator
20to be controlled by external sources.
21
22They are kept for ABI compatibility but are no longer functional, and
23should not be used in new programs.
24
25=head1 SEE ALSO
26
27L<rand(3)|rand(3)>,
28L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_cleanup(3)|RAND_cleanup(3)>
29
30=cut
diff --git a/src/lib/libcrypto/doc/RAND_bytes.pod b/src/lib/libcrypto/doc/RAND_bytes.pod
deleted file mode 100644
index c89961ada3..0000000000
--- a/src/lib/libcrypto/doc/RAND_bytes.pod
+++ /dev/null
@@ -1,43 +0,0 @@
1=pod
2
3=head1 NAME
4
5RAND_bytes, RAND_pseudo_bytes - generate random data
6
7=head1 SYNOPSIS
8
9 #include <openssl/rand.h>
10
11 int RAND_bytes(unsigned char *buf, int num);
12
13 int RAND_pseudo_bytes(unsigned char *buf, int num);
14
15=head1 DESCRIPTION
16
17RAND_bytes() puts B<num> cryptographically strong pseudo-random bytes
18into B<buf>.
19
20RAND_pseudo_bytes() puts B<num> pseudo-random bytes into B<buf>.
21Pseudo-random byte sequences generated by RAND_pseudo_bytes() will be
22unique if they are of sufficient length, but are not necessarily
23unpredictable. They can be used for non-cryptographic purposes and for
24certain purposes in cryptographic protocols, but usually not for key
25generation etc.
26
27=head1 RETURN VALUES
28
29RAND_bytes() returns 1.
30RAND_pseudo_bytes() returns 1.
31
32=head1 SEE ALSO
33
34L<rand(3)|rand(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
35L<RAND_add(3)|RAND_add(3)>
36
37=head1 HISTORY
38
39RAND_bytes() is available in all versions of SSLeay and OpenSSL. It
40has a return value since OpenSSL 0.9.5. RAND_pseudo_bytes() was added
41in OpenSSL 0.9.5.
42
43=cut
diff --git a/src/lib/libcrypto/doc/RAND_cleanup.pod b/src/lib/libcrypto/doc/RAND_cleanup.pod
deleted file mode 100644
index 10cb39ce7a..0000000000
--- a/src/lib/libcrypto/doc/RAND_cleanup.pod
+++ /dev/null
@@ -1,25 +0,0 @@
1=pod
2
3=head1 NAME
4
5RAND_cleanup - erase the PRNG state
6
7=head1 SYNOPSIS
8
9 #include <openssl/rand.h>
10
11 void RAND_cleanup(void);
12
13=head1 DESCRIPTION
14
15RAND_cleanup() erases the memory used by the PRNG.
16
17=head1 SEE ALSO
18
19L<rand(3)|rand(3)>
20
21=head1 HISTORY
22
23RAND_cleanup() is available in all versions of SSLeay and OpenSSL.
24
25=cut
diff --git a/src/lib/libcrypto/doc/RAND_load_file.pod b/src/lib/libcrypto/doc/RAND_load_file.pod
deleted file mode 100644
index 5e4c2481d8..0000000000
--- a/src/lib/libcrypto/doc/RAND_load_file.pod
+++ /dev/null
@@ -1,52 +0,0 @@
1=pod
2
3=head1 NAME
4
5RAND_load_file, RAND_write_file, RAND_file_name - PRNG seed file
6
7=head1 SYNOPSIS
8
9 #include <openssl/rand.h>
10
11 const char *RAND_file_name(char *buf, size_t num);
12
13 int RAND_load_file(const char *filename, long max_bytes);
14
15 int RAND_write_file(const char *filename);
16
17=head1 DESCRIPTION
18
19RAND_file_name() returns a default path for the random seed file.
20B<buf> points to a buffer of size B<num> in which to store the
21filename. If B<num> is too small for the path name, an error occurs.
22
23RAND_load_file() used to allow for the state of the random number generator
24to be controlled by external sources.
25
26It is kept for ABI compatibility but is no longer functional, and
27should not used in new programs.
28
29RAND_write_file() writes a number of random bytes (currently 1024) to
30file B<filename>.
31
32=head1 RETURN VALUES
33
34RAND_load_file() always returns 0.
35
36RAND_write_file() returns the number of bytes written, and -1 if the
37bytes written were generated without appropriate seed.
38
39RAND_file_name() returns a pointer to B<buf> on success, and NULL on
40error.
41
42=head1 SEE ALSO
43
44L<rand(3)|rand(3)>, L<RAND_add(3)|RAND_add(3)>,
45L<RAND_cleanup(3)|RAND_cleanup(3)>
46
47=head1 HISTORY
48
49RAND_load_file(), RAND_write_file() and RAND_file_name() are available in
50all versions of SSLeay and OpenSSL.
51
52=cut
diff --git a/src/lib/libcrypto/doc/RAND_set_rand_method.pod b/src/lib/libcrypto/doc/RAND_set_rand_method.pod
deleted file mode 100644
index c02068bf76..0000000000
--- a/src/lib/libcrypto/doc/RAND_set_rand_method.pod
+++ /dev/null
@@ -1,40 +0,0 @@
1=pod
2
3=head1 NAME
4
5RAND_set_rand_method, RAND_get_rand_method, RAND_SSLeay - select RAND method
6
7=head1 SYNOPSIS
8
9 #include <openssl/rand.h>
10
11 void RAND_set_rand_method(const RAND_METHOD *meth);
12
13 const RAND_METHOD *RAND_get_rand_method(void);
14
15 RAND_METHOD *RAND_SSLeay(void);
16
17=head1 DESCRIPTION
18
19These functions used to allow for the random number generator functions
20to be replaced by arbitrary code.
21
22They are kept for ABI compatibility but are no longer functional, and
23should not be used in new programs.
24
25=head1 SEE ALSO
26
27L<rand(3)|rand(3)>
28
29=head1 HISTORY
30
31RAND_set_rand_method(), RAND_get_rand_method() and RAND_SSLeay() are
32available in all versions of OpenSSL.
33
34In the engine version of version 0.9.6, RAND_set_rand_method() was altered to
35take an ENGINE pointer as its argument. As of version 0.9.7, that has been
36reverted as the ENGINE API transparently overrides RAND defaults if used,
37otherwise RAND API functions work as before. RAND_set_rand_engine() was also
38introduced in version 0.9.7.
39
40=cut