summaryrefslogtreecommitdiff
path: root/ext
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2014-10-04 00:01:07 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2014-10-04 00:01:07 +0000
commit165625e8e11e678c6f882767382bc450ca623891 (patch)
treeeb08bb0ec41253cbdd4b3f39c72685f15ea3cabe /ext
parent27886620d85badb44c43cb962ab4960bc55cde24 (diff)
* ext/openssl/ossl_rand.c: [DOC] Add call signature for pseudo_bytes
and random_bytes, wrap lines at 80 chars, and remove useless comments. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@47782 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext')
-rw-r--r--ext/openssl/ossl_rand.c53
1 files changed, 23 insertions, 30 deletions
diff --git a/ext/openssl/ossl_rand.c b/ext/openssl/ossl_rand.c
index 0f92c2e..29cbf8c 100644
--- a/ext/openssl/ossl_rand.c
+++ b/ext/openssl/ossl_rand.c
@@ -2,33 +2,18 @@
* $Id$
* 'OpenSSL for Ruby' project
* Copyright (C) 2001-2002 Michal Rokos <m.rokos@sh.cvut.cz>
+ *
* All rights reserved.
- */
-/*
+ *
* This program is licenced under the same licence as Ruby.
* (See the file 'LICENCE'.)
*/
#include "ossl.h"
-/*
- * Classes
- */
VALUE mRandom;
VALUE eRandomError;
/*
- * Struct
- */
-
-/*
- * Public
- */
-
-/*
- * Private
- */
-
-/*
* call-seq:
* seed(str) -> str
*
@@ -47,11 +32,15 @@ ossl_rand_seed(VALUE self, VALUE str)
* call-seq:
* add(str, entropy) -> self
*
- * Mixes the bytes from +str+ into the Pseudo Random Number Generator(PRNG) state.
- * Thus, if the data from +str+ are unpredictable to an adversary, this increases the uncertainty about the state
- * and makes the PRNG output less predictable.
- * The +entropy+ argument is (the lower bound of) an estimate of how much randomness is contained in +str+,
- * measured in bytes.
+ * Mixes the bytes from +str+ into the Pseudo Random Number Generator(PRNG)
+ * state.
+ *
+ * Thus, if the data from +str+ are unpredictable to an adversary, this
+ * increases the uncertainty about the state and makes the PRNG output less
+ * predictable.
+ *
+ * The +entropy+ argument is (the lower bound of) an estimate of how much
+ * randomness is contained in +str+, measured in bytes.
*
* Example:
*
@@ -91,8 +80,9 @@ ossl_rand_load_file(VALUE self, VALUE filename)
* call-seq:
* write_random_file(filename) -> true
*
- * Writes a number of random generated bytes (currently 1024) to +filename+ which can be used to initialize the PRNG by
- * calling ::load_random_file in a later session.
+ * Writes a number of random generated bytes (currently 1024) to +filename+
+ * which can be used to initialize the PRNG by calling ::load_random_file in a
+ * later session.
*/
static VALUE
ossl_rand_write_file(VALUE self, VALUE filename)
@@ -106,9 +96,10 @@ ossl_rand_write_file(VALUE self, VALUE filename)
/*
* call-seq:
- * -> string
+ * random_bytes(length) -> string
*
- * Generates +string+ with +length+ number of cryptographically strong pseudo-random bytes.
+ * Generates +string+ with +length+ number of cryptographically strong
+ * pseudo-random bytes.
*
* Example:
*
@@ -131,12 +122,12 @@ ossl_rand_bytes(VALUE self, VALUE len)
/*
* call-seq:
- * -> string
+ * pseudo_bytes(length) -> string
*
* Generates +string+ with +length+ number of pseudo-random bytes.
*
- * Pseudo-random byte sequences generated by ::pseudo_bytes will be unique if they are of sufficient length,
- * but are not necessarily unpredictable.
+ * Pseudo-random byte sequences generated by ::pseudo_bytes will be unique if
+ * they are of sufficient length, but are not necessarily unpredictable.
*
* Example:
*
@@ -179,7 +170,9 @@ ossl_rand_egd(VALUE self, VALUE filename)
* egd_bytes(filename, length) -> true
*
* Queries the entropy gathering daemon EGD on socket path given by +filename+.
- * Fetches +length+ number of bytes and uses ::add to seed the OpenSSL built-in PRNG.
+ *
+ * Fetches +length+ number of bytes and uses ::add to seed the OpenSSL built-in
+ * PRNG.
*/
static VALUE
ossl_rand_egd_bytes(VALUE self, VALUE filename, VALUE len)