From 9ed44c721b279580400e0ce3cb27d488858207b5 Mon Sep 17 00:00:00 2001 From: david Date: Thu, 9 Oct 2008 00:26:46 +0000 Subject: [PATCH] Proofread and index the scripting.xml documentation on the openssl NSE module. --- docs/scripting.xml | 145 ++++++++++++++++++++++++++++----------------- 1 file changed, 91 insertions(+), 54 deletions(-) diff --git a/docs/scripting.xml b/docs/scripting.xml index 8e95b97bc..58e9512d5 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -1166,203 +1166,238 @@ if(s) code_to_be_done_on_match end openssl NSE module + OpenSSLopenssl NSE module OpenSSLin NSE OpenSSL NSE bindings - The openssl module provides functions for - dealing with multiprecision integers. The functions reside inside the - openssl namespace. - + The openssl module is a wrapper for OpenSSL + functions that provide encryption and decryption, hashing, and + multiprecision integers. + - + Returns the size of bignum in bits. - + Returns the size of bignum in bytes. - + - Sets bit at position in bignum. + Sets the bit at position in bignum. - + - Clears bit at position in bignum. + Clears the bit at position in bignum. - + - Get bit at position in bignum. + Gets the state of the bit at position in bignum. - + - Set sign of bignum. If negative is false the sign becomes positive otherwise it becomes negative. + Sets the sign of bignum. If + negative is true + the sign becomes negative, otherwise it becomes positive. - + - Check sign of bignum. + Returns true if bignum is + negative, false otherwise. - + - Converts binary encoded string into a bignum. + Converts the binary-encoded string into a bignum. - + - Converts decimal encoded string into a bignum. + Converts the decimal-encoded string into a bignum. - + - Converts hex-encoded string into a bignum. + Converts the hex-encoded string into a bignum. - + - Converts bignum into a binary encoded string. + Converts bignum into a binary-encoded string. - + - Converts bignum into a decimal encoded string. + Converts bignum into a decimal-encoded string. - + Converts bignum into a hex-encoded string. - + - Returns random bignum with bits bit size. + Returns a random bignum with a + size of bits bits. - + - Returns pseudo random bignum with bits bit size. + Returns a pseudorandom bignum + with a size of bits bits. - + - Returns bignum which is the result of a^p mod m. + Returns the bignum which is the result of a^p mod m. - + - Returns a string of bytes length with random data. + Returns a string of length + bytes containing random data. - + - Returns a string of bytes length with pseudo random data. + Returns a string of length + bytes containing pseudorandom data. - + + digests, cryptographic + hashes, cryptographic + Returns the MD2 digest of message. - + Returns the MD4 digest of message. - + Returns the MD5 digest of message. - + - Returns the SHA1 digest of message. + Returns the SHA-1 digest of message. - + - Returns the RIPEMD160 digest of message. + Returns the RIPEMD-160 digest of message. - + - Returns the digest specified by algorithm of message. + Returns the digest of message + using the algorithm given by the string + algorithm. The algorithm name may be + anything recognized by the + openssl.supported_digests + function. - + - + Returns the message authentication code of + message using the given algorithm and + key. algorithm may be anything + recognized by the + openssl.supported_digests + function. - + + keys, cryptographic + - Encrypt data with the encryption algorithm algorithm, key and the initialization vector iv. + Encrypt data with the given + algorithm, key, and initialization vector. + algorithm may be anything + returned by the + openssl.supported_ciphers + function. If padding is true then a + partial final block will be padded and encrypted. - + - Decrypt data with the encryption algorithm algorithm, key and the initialization vector iv. + Encrypt data with the given + algorithm, key, and initialization vector. + algorithm may be anything + returned by the + openssl.supported_ciphers + function. If padding is true then the + final block must be padded correctly. @@ -1381,9 +1416,11 @@ if(s) code_to_be_done_on_match end - + - Converts data which must be a 7-byte string into a 8-byte DES key and sets the parity. + Converts data, which must be a + 7-byte string, into an 8-byte DES key and sets the + parity.