diff options
| author | Sylvestre Ledru <sledru@mozilla.com> | 2022-12-28 15:57:09 +0000 |
|---|---|---|
| committer | Sylvestre Ledru <sledru@mozilla.com> | 2022-12-28 15:57:09 +0000 |
| commit | 2a7304727b3d1b4095a7773e67792150b2b0f04e (patch) | |
| tree | f8ca8120102c2446775afe1654e3eef0d045d5b1 /doc | |
| parent | ce17568634f4b3ae7174ada1c77cd53ad620aba9 (diff) | |
| download | nss-hg-2a7304727b3d1b4095a7773e67792150b2b0f04e.tar.gz | |
Bug 1807822 - nss doc: remove some 'notranslate' r=nss-reviewers,bbeurdouche
done with:
L=$(rg "code:: notranslate"|cut -d: -f1|sort -u)
sed -i -e "s|.. code:: notranslate|.. code::|g" $L
Differential Revision: https://phabricator.services.mozilla.com/D165614
Diffstat (limited to 'doc')
38 files changed, 380 insertions, 380 deletions
diff --git a/doc/rst/build.rst b/doc/rst/build.rst index f773a3ffd..8192e466a 100644 --- a/doc/rst/build.rst +++ b/doc/rst/build.rst @@ -34,14 +34,14 @@ Building NSS **On Linux:** - .. code:: notranslate + .. code:: sudo apt install mercurial git ninja-build python3-pip python3 -m pip install gyp-next **On MacOS:** - .. code:: notranslate + .. code:: brew install mercurial git ninja python3-pip python3 -m pip install gyp-next @@ -51,13 +51,13 @@ Building NSS The Homebrew Python installation has the necessary symlink but may require explicit adding to the PATH variable, for example like this: - .. code:: notranslate + .. code:: export PATH="/opt/homebrew/opt/python/libexec/bin:$PATH" **On Windows:** - .. code:: notranslate + .. code:: <TODO> @@ -96,7 +96,7 @@ Building NSS check out the latest sources for NSS and NSPR--which may not be part of a stable release--use the following commands: - .. code:: notranslate + .. code:: hg clone https://hg.mozilla.org/projects/nspr hg clone https://hg.mozilla.org/projects/nss @@ -107,7 +107,7 @@ Building NSS To download the source using ``git-cinnabar`` instead: - .. code:: notranslate + .. code:: git clone hg::https://hg.mozilla.org/projects/nspr git clone hg::https://hg.mozilla.org/projects/nss @@ -120,7 +120,7 @@ Building NSS Build NSS and NSPR using our build script from the ``nss`` directory: - .. code:: notranslate + .. code:: cd nss ./build.sh @@ -143,7 +143,7 @@ Building NSS Alternatively, there is a ``make`` target, which produces a similar result. This supports some alternative options, but can be a lot slower. - .. code:: notranslate + .. code:: USE_64=1 make -j @@ -184,7 +184,7 @@ Building NSS NSS contains extensive unit tests. Scripts to run these are found in the ``tests`` directory. Run the standard suite by: - .. code:: notranslate + .. code:: HOST=localhost DOMSUF=localdomain USE_64=1 ./tests/all.sh @@ -204,7 +204,7 @@ Building NSS If you don't have a domain suffix you can add an entry to ``/etc/hosts`` (on Windows,\ ``c:\Windows\System32\drivers\etc\hosts``) as follows: - .. code:: notranslate + .. code:: 127.0.0.1 localhost.localdomain diff --git a/doc/rst/legacy/blank_function/index.rst b/doc/rst/legacy/blank_function/index.rst index 620454cf9..5541bf1a6 100644 --- a/doc/rst/legacy/blank_function/index.rst +++ b/doc/rst/legacy/blank_function/index.rst @@ -12,7 +12,7 @@ Function_Name .. container:: - .. code:: notranslate + .. code:: #include <headers.h> ReturnType Function_Name( diff --git a/doc/rst/legacy/building/index.rst b/doc/rst/legacy/building/index.rst index 3e2c77b57..21120ddf7 100644 --- a/doc/rst/legacy/building/index.rst +++ b/doc/rst/legacy/building/index.rst @@ -50,7 +50,7 @@ Building NSS latest sources for NSS and NSPR--which may not be part of a stable release--use the following commands: - .. code:: notranslate + .. code:: hg clone https://hg.mozilla.org/projects/nspr hg clone https://hg.mozilla.org/projects/nss @@ -64,7 +64,7 @@ Building NSS Build NSS using our build script: - .. code:: notranslate + .. code:: nss/build.sh @@ -80,7 +80,7 @@ Building NSS Alternatively, there is a ``make`` target called "nss_build_all", which produces a similar result. This supports some alternative options, but can be a lot slower. - .. code:: notranslate + .. code:: make -C nss nss_build_all USE_64=1 @@ -116,7 +116,7 @@ Building NSS NSS contains extensive unit tests. Scripts to run these are found in the ``tests`` directory. Run the standard suite by: - .. code:: notranslate + .. code:: HOST=localhost DOMSUF=localdomain USE_64=1 nss/tests/all.sh @@ -135,7 +135,7 @@ Building NSS If you don't have a domain suffix you can add an entry to ``/etc/hosts`` (on Windows,\ ``c:\Windows\System32\drivers\etc\hosts``) as follows: - .. code:: notranslate + .. code:: 127.0.0.1 localhost.localdomain diff --git a/doc/rst/legacy/cert_findcertbydercert/index.rst b/doc/rst/legacy/cert_findcertbydercert/index.rst index 8587a5157..c7b87d218 100644 --- a/doc/rst/legacy/cert_findcertbydercert/index.rst +++ b/doc/rst/legacy/cert_findcertbydercert/index.rst @@ -12,7 +12,7 @@ CERT_FindCertByDERCert .. container:: - .. code:: notranslate + .. code:: #include <cert.h> CERTCertificate *CERT_FindCertByDERCert( diff --git a/doc/rst/legacy/cert_findcertbyissuerandsn/index.rst b/doc/rst/legacy/cert_findcertbyissuerandsn/index.rst index 14d38abe2..933fff206 100644 --- a/doc/rst/legacy/cert_findcertbyissuerandsn/index.rst +++ b/doc/rst/legacy/cert_findcertbyissuerandsn/index.rst @@ -12,7 +12,7 @@ CERT_FindCertByIssuerAndSN .. container:: - .. code:: notranslate + .. code:: #include <cert.h> CERTCertificate *CERT_FindCertByIssuerAndSN ( @@ -58,7 +58,7 @@ CERT_FindCertByIssuerAndSN .. container:: - .. code:: notranslate + .. code:: CERTIssuerAndSN issuerSN; issuerSN.derIssuer.data = caName->data; diff --git a/doc/rst/legacy/jss/build_instructions_for_jss_4.3.x/index.rst b/doc/rst/legacy/jss/build_instructions_for_jss_4.3.x/index.rst index 62b345dc9..4d204430a 100644 --- a/doc/rst/legacy/jss/build_instructions_for_jss_4.3.x/index.rst +++ b/doc/rst/legacy/jss/build_instructions_for_jss_4.3.x/index.rst @@ -27,13 +27,13 @@ Build instructions for JSS 4.3.x #. Switch to the appropriate directory and check out JSS from the root of your source tree. - .. code:: notranslate + .. code:: cvs co -r JSS_4_3_1_RTM mozilla/security/jss or - .. code:: notranslate + .. code:: cvs co -r JSS_4_3_RTM mozilla/security/jss @@ -43,26 +43,26 @@ Build instructions for JSS 4.3.x **Unix** - .. code:: notranslate + .. code:: setenv JAVA_HOME /usr/local/jdk1.5.0 (or wherever your JDK is installed) **Windows** - .. code:: notranslate + .. code:: set JAVA_HOME=c:\programs\jdk1.5.0 (or wherever your JDK is installed) **Windows (Cygnus)** - .. code:: notranslate + .. code:: JAVA_HOME=/cygdrive/c/programs/jdk1.5.0 (or wherever your JDK is installed) export JAVA_HOME | **Windows build Configurations WINNT vs WIN95** - .. code:: notranslate + .. code:: As of NSS 3.15.4, NSPR/NSS/JSS build generates a "WIN95" configuration by default on Windows. We recommend most applications use the "WIN95" configuration. If you want JSS to be used @@ -80,14 +80,14 @@ Build instructions for JSS 4.3.x #. Build JSS. - .. code:: notranslate + .. code:: cd mozilla/security/jss gmake #. Sign the JSS jar. - .. code:: notranslate + .. code:: If you're intention is to modify and build the JSS source you need to Apply for your own JCE code-signing certificate diff --git a/doc/rst/legacy/jss/jss_faq/index.rst b/doc/rst/legacy/jss/jss_faq/index.rst index d2842e053..db088f560 100644 --- a/doc/rst/legacy/jss/jss_faq/index.rst +++ b/doc/rst/legacy/jss/jss_faq/index.rst @@ -182,7 +182,7 @@ JSS FAQ **How do I convert org.mozilla.jss.crypto.X509Certificate to org.mozilla.jss.pkix.cert.Certificate?** - - .. code:: notranslate + - .. code:: import java.io.ByteArrayInputStream; diff --git a/doc/rst/legacy/jss/jss_provider_notes/index.rst b/doc/rst/legacy/jss/jss_provider_notes/index.rst index 045fee89b..d6a2c611f 100644 --- a/doc/rst/legacy/jss/jss_provider_notes/index.rst +++ b/doc/rst/legacy/jss/jss_provider_notes/index.rst @@ -109,7 +109,7 @@ JSS Provider Notes The following example shows how you can specify which token is used for various JCA operations: - .. code:: notranslate + .. code:: // Lookup PKCS #11 tokens CryptoManager manager = CryptoManager.getInstance(); diff --git a/doc/rst/legacy/jss/mozilla-jss_jca_provider_notes/index.rst b/doc/rst/legacy/jss/mozilla-jss_jca_provider_notes/index.rst index bd525ec4c..f8edb0953 100644 --- a/doc/rst/legacy/jss/mozilla-jss_jca_provider_notes/index.rst +++ b/doc/rst/legacy/jss/mozilla-jss_jca_provider_notes/index.rst @@ -106,7 +106,7 @@ Mozilla-JSS JCA Provider notes The following example shows how you can specify which token is used for various JCA operations: - .. code:: notranslate + .. code:: // Lookup PKCS #11 tokens CryptoManager manager = CryptoManager.getInstance(); diff --git a/doc/rst/legacy/jss/using_jss/index.rst b/doc/rst/legacy/jss/using_jss/index.rst index ce01c8323..bf8db68c1 100644 --- a/doc/rst/legacy/jss/using_jss/index.rst +++ b/doc/rst/legacy/jss/using_jss/index.rst @@ -116,7 +116,7 @@ Using JSS You can put this directory in your classpath to run applications locally; or, you can package the class files into a JAR file for easier distribution: - .. code:: notranslate + .. code:: cd mozilla/dist/classes[_dbg] zip -r ../jss42.jar . diff --git a/doc/rst/legacy/nss_api_guidelines/index.rst b/doc/rst/legacy/nss_api_guidelines/index.rst index 65dcecb82..57faeea12 100644 --- a/doc/rst/legacy/nss_api_guidelines/index.rst +++ b/doc/rst/legacy/nss_api_guidelines/index.rst @@ -311,7 +311,7 @@ NSS API Guidelines Each file should include a CVS ID string for identification. The preferred format is: - .. code:: notranslate + .. code:: "@(#) $RCSfile: nss-guidelines.html, v $ $Revision: 48936 $ $Date: 2009-08-11 07:45:57 -0700 (Tue, 11 Aug 2009) $ $Name$" @@ -324,7 +324,7 @@ NSS API Guidelines Here is an example from lib/base/baset.h: - .. code:: notranslate + .. code:: #ifdef DEBUG static const char BASET_CVS_ID[] = "@(#) $RCSfile: nss-guidelines.html, @@ -448,13 +448,13 @@ NSS API Guidelines For example, for the structure SECMyOpaqueData you would add: - .. code:: notranslate + .. code:: typedef struct SECMyOpaqueDataStr SECMyOpaqueData; and add the actual structure definition to the private header file. In this same example: - .. code:: notranslate + .. code:: struct SECMyOpaqueDataStr { unsigned long myPrivateData1; @@ -559,7 +559,7 @@ NSS API Guidelines Usually, every public routine has a private counterpart, and the implementation of the public routine looks like this: - .. code:: notranslate + .. code:: NSSImplement rv * NSSType_Method @@ -842,7 +842,7 @@ NSS API Guidelines All encrypt and decrypt functions, which return data inline, should have a consistent signature: - .. code:: notranslate + .. code:: SECStatus MY_FunctionName(MyContext *context, unsigned char *outBuf, @@ -858,7 +858,7 @@ NSS API Guidelines All hashing update, MACing update, and encrypt/decrypt functions which act like filters should have a consistent signature: - .. code:: notranslate + .. code:: SECStatus PK11_DigestOp(PK11Context *context, unsigned char *inBuf, diff --git a/doc/rst/legacy/nss_config_options/index.rst b/doc/rst/legacy/nss_config_options/index.rst index 083d49dbf..4566ecc41 100644 --- a/doc/rst/legacy/nss_config_options/index.rst +++ b/doc/rst/legacy/nss_config_options/index.rst @@ -13,45 +13,45 @@ NSS Config Options The specified ciphers will be allowed by policy, but an application may allow more by policy explicitly: - .. code:: notranslate + .. code:: config="allow=curve1:curve2:hash1:hash2:rsa-1024..." Only the specified hashes and curves will be allowed: - .. code:: notranslate + .. code:: config="disallow=all allow=sha1:sha256:secp256r1:secp384r1" Only the specified hashes and curves will be allowed, and RSA keys of 2048 or more will be accepted, and DH key exchange with 1024-bit primes or more: - .. code:: notranslate + .. code:: config="disallow=all allow=sha1:sha256:secp256r1:secp384r1:min-rsa=2048:min-dh=1024" A policy that enables the AES ciphersuites and the SECP256/384 curves: - .. code:: notranslate + .. code:: config="allow=aes128-cbc:aes128-gcm::HMAC-SHA1:SHA1:SHA256:SHA384:RSA:ECDHE-RSA:SECP256R1:SECP384R1" Turn off md5 - .. code:: notranslate + .. code:: config="disallow=MD5" Turn off md5 and sha1 only for SSL - .. code:: notranslate + .. code:: config="disallow=MD5(SSL):SHA1(SSL)" Disallow values are parsed first, and then allow values, independent of the order in which they appear. - .. code:: notranslate + .. code:: Future key words (not yet implemented): enable: turn on ciphersuites by default. diff --git a/doc/rst/legacy/nss_releases/nss_3.12.4_release_notes/index.rst b/doc/rst/legacy/nss_releases/nss_3.12.4_release_notes/index.rst index 2c4caac5b..f00c4ef29 100644 --- a/doc/rst/legacy/nss_releases/nss_3.12.4_release_notes/index.rst +++ b/doc/rst/legacy/nss_releases/nss_3.12.4_release_notes/index.rst @@ -5,7 +5,7 @@ NSS 3.12.4 release notes .. container:: - .. code:: notranslate + .. code:: 2009-08-20 diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample1/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample1/index.rst index 34e7fdb28..36ca99314 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample1/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample1/index.rst @@ -38,7 +38,7 @@ NSS Sample Code Sample1 .. container:: - .. code:: notranslate + .. code:: #include <iostream.h> #include "pk11pub.h" diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample2/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample2/index.rst index dc04cf139..76f6c21d8 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample2/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample2/index.rst @@ -10,7 +10,7 @@ NSS Sample Code sample2 .. container:: - .. code:: notranslate + .. code:: /* Example code to illustrate DES enccryption/decryption using NSS. * The example skips the details of obtaining the Key & IV to use, and diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample3/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample3/index.rst index 84e55b93d..51f37f661 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample3/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample3/index.rst @@ -10,7 +10,7 @@ NSS Sample Code sample3 .. container:: - .. code:: notranslate + .. code:: /* * Demonstration program for hashing and MACs diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample4/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample4/index.rst index cfe86d4d6..1d5cba11c 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample4/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample4/index.rst @@ -10,7 +10,7 @@ NSS Sample Code sample4 .. container:: - .. code:: notranslate + .. code:: /* Example code to illustrate PKI crypto ops (encrypt with public key, * decrypt with private key) diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample5/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample5/index.rst index 80d03617b..f4e8235ad 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample5/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample5/index.rst @@ -10,7 +10,7 @@ NSS Sample Code sample5 .. container:: - .. code:: notranslate + .. code:: /* Example code to illustrate PKI crypto ops (encrypt with public key, * decrypt with private key) diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample6/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample6/index.rst index 82dc49352..b194873bc 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_sample6/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_sample6/index.rst @@ -10,7 +10,7 @@ NSS Sample Code sample6 .. container:: - .. code:: notranslate + .. code:: /* Example code to illustrate generation of a secret symmetric key ring * that PERSISTS in the NSS database. The symmetric keys can then be used diff --git a/doc/rst/legacy/nss_sample_code/nss_sample_code_utililies_1/index.rst b/doc/rst/legacy/nss_sample_code/nss_sample_code_utililies_1/index.rst index 74526878f..f55ddffc2 100644 --- a/doc/rst/legacy/nss_sample_code/nss_sample_code_utililies_1/index.rst +++ b/doc/rst/legacy/nss_sample_code/nss_sample_code_utililies_1/index.rst @@ -25,7 +25,7 @@ NSS Sample Code Utilities_1 .. container:: - .. code:: notranslate + .. code:: #include <prlog.h> #include <termios.h> diff --git a/doc/rst/legacy/nss_tech_notes/nss_tech_note2/index.rst b/doc/rst/legacy/nss_tech_notes/nss_tech_note2/index.rst index b07c569dd..efc80ff3a 100644 --- a/doc/rst/legacy/nss_tech_notes/nss_tech_note2/index.rst +++ b/doc/rst/legacy/nss_tech_notes/nss_tech_note2/index.rst @@ -24,14 +24,14 @@ nss tech note2 To enable the module logger, you must set the environment variable NSS_DEBUG_PKCS11_MODULE to the name of the target module. For example, to log the softoken, use: - .. code:: notranslate + .. code:: NSS_DEBUG_PKCS11_MODULE="NSS Internal PKCS #11 Module" Note: In the Command Prompt on Windows, do not quote the name of the target module, otherwise the quotes are considered part of the name. For example, to log the softoken on Windows, use: - .. code:: notranslate + .. code:: set NSS_DEBUG_PKCS11_MODULE=NSS Internal PKCS #11 Module @@ -49,21 +49,21 @@ nss tech note2 **1. Only display the sequence of PKCS #11 calls.** To enable this mode, set: - .. code:: notranslate + .. code:: NSPR_LOG_MODULES=nss_mod_log:1 NSPR_LOG_FILE=<logfile> The output format is: - .. code:: notranslate + .. code:: OSThreadID[NSPRThreadID]: C_XXX OSThreadID[NSPRThreadID]: rv = 0xYYYYYYYY For example, - .. code:: notranslate + .. code:: 1024[805ef10]: C_Initialize 1024[805ef10]: rv = 0x0 @@ -75,14 +75,14 @@ nss tech note2 **2. Display the sequence of PKCS #11 calls, and the parameters given to them.** To enable this mode, set: - .. code:: notranslate + .. code:: NSPR_LOG_MODULES=nss_mod_log:3 NSPR_LOG_FILE=<logfile> The output format is: - .. code:: notranslate + .. code:: OSThreadID[NSPRThreadID]: C_XXX OSThreadID[NSPRThreadID]: arg1 = 0xAAAAAAAA @@ -92,7 +92,7 @@ nss tech note2 For example, - .. code:: notranslate + .. code:: 1024[805ef10]: C_Initialize 1024[805ef10]: pInitArgs = 0x4010c938 @@ -113,14 +113,14 @@ nss tech note2 **3. Display verbose information, including template values, array values, etc.** To enable this mode, set: - .. code:: notranslate + .. code:: NSPR_LOG_MODULES=nss_mod_log:4 NSPR_LOG_FILE=<logfile> The output format is the same as above, but with more information. For example, - .. code:: notranslate + .. code:: 1024[805ef10]: C_FindObjectsInit 1024[805ef10]: hSession = 0x1000001 diff --git a/doc/rst/legacy/nss_tech_notes/nss_tech_note3/index.rst b/doc/rst/legacy/nss_tech_notes/nss_tech_note3/index.rst index 7efddd8ba..2d72c870c 100644 --- a/doc/rst/legacy/nss_tech_notes/nss_tech_note3/index.rst +++ b/doc/rst/legacy/nss_tech_notes/nss_tech_note3/index.rst @@ -17,7 +17,7 @@ nss tech note3 .. container:: - .. code:: notranslate + .. code:: 09 May 2002 Nelson B. Bolyard diff --git a/doc/rst/legacy/nss_tech_notes/nss_tech_note7/index.rst b/doc/rst/legacy/nss_tech_notes/nss_tech_note7/index.rst index 3d39895fd..e97586e80 100644 --- a/doc/rst/legacy/nss_tech_notes/nss_tech_note7/index.rst +++ b/doc/rst/legacy/nss_tech_notes/nss_tech_note7/index.rst @@ -59,7 +59,7 @@ nss tech note7 | PKCS #1 defines an RSA public key as a ``SEQUENCE`` of modulus and public exponent, both of which are ``INTEGER``\ s. Here is the ASN.1 type definition: - .. code:: notranslate + .. code:: RSAPublicKey ::= SEQUENCE { modulus INTEGER, -- n @@ -68,7 +68,7 @@ nss tech note7 The following sample code (error handling omitted for brevity) encodes a ``RSAPublicKey`` from a modulus and a public exponent and imports the public key into NSS. - .. code:: notranslate + .. code:: struct MyRSAPublicKey { SECItem m_modulus; diff --git a/doc/rst/legacy/nss_tech_notes/nss_tech_note8/index.rst b/doc/rst/legacy/nss_tech_notes/nss_tech_note8/index.rst index 8cfc2e6ae..efbb737d8 100644 --- a/doc/rst/legacy/nss_tech_notes/nss_tech_note8/index.rst +++ b/doc/rst/legacy/nss_tech_notes/nss_tech_note8/index.rst @@ -17,7 +17,7 @@ nss tech note8 .. container:: - .. code:: notranslate + .. code:: 27 February 2006 Nelson B. Bolyard diff --git a/doc/rst/legacy/pkcs11/module_specs/index.rst b/doc/rst/legacy/pkcs11/module_specs/index.rst index 9d9f3a01d..41c666b91 100644 --- a/doc/rst/legacy/pkcs11/module_specs/index.rst +++ b/doc/rst/legacy/pkcs11/module_specs/index.rst @@ -70,7 +70,7 @@ PKCS #11 Module Specs A new ``CK_C_INITIALIZE_ARGS`` structure is defined as - .. code:: notranslate + .. code:: typedef struct CK_C_INITIALIZE_ARGS { CK_CREATEMUTEX CreateMutex; @@ -214,7 +214,7 @@ PKCS #11 Module Specs Sample file: - .. code:: notranslate + .. code:: library= name="Netscape Internal Crypto Module" parameters="configdir=/u/relyea/.netscape certprefix= secmod=secmod.db" NSS="Flags=internal,pkcs11module TrustOrder=1 CipherOrder=-1 ciphers= slotParams={0x1=[slotFlags='RSA,DSA,DH,RC4,RC2,DES,MD2,MD5,SHA1,SSL,TLS,PublicCerts,Random'] 0x2=[slotFlags='RSA' askpw=only]}" library=dkck32.dll name="DataKey SignaSURE 3600" NSS="TrustOrder=50 ciphers= " diff --git a/doc/rst/legacy/pkcs11_functions/index.rst b/doc/rst/legacy/pkcs11_functions/index.rst index 0c47384b3..ad743f62f 100644 --- a/doc/rst/legacy/pkcs11_functions/index.rst +++ b/doc/rst/legacy/pkcs11_functions/index.rst @@ -37,7 +37,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax - .. code:: notranslate + .. code:: #include "secmod.h" @@ -84,7 +84,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_2 - .. code:: notranslate + .. code:: #include "secmod.h" @@ -121,7 +121,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_3 - .. code:: notranslate + .. code:: #include <pk11pub.h> @@ -151,7 +151,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_4 - .. code:: notranslate + .. code:: #include "pk11pub.h" @@ -234,7 +234,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_5 - .. code:: notranslate + .. code:: #include <pk11pub.h> #include <certt.h> @@ -279,7 +279,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_6 - .. code:: notranslate + .. code:: #include <pk11pub.h> #include <certt.h> @@ -325,7 +325,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_7 - .. code:: notranslate + .. code:: #include <pk11pub.h> @@ -360,7 +360,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_8 - .. code:: notranslate + .. code:: #include <pk11pub.h> @@ -395,7 +395,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_9 - .. code:: notranslate + .. code:: #include <pk11pub.h> #include <prtypes.h> @@ -425,7 +425,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_10 - .. code:: notranslate + .. code:: #include <pk11pub.h> #include <prtypes.h> @@ -455,7 +455,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_11 - .. code:: notranslate + .. code:: #include <pk11pub.h> #include <prtypes.h> @@ -486,7 +486,7 @@ NSS PKCS11 Functions .. rubric:: Syntax :name: syntax_12 - .. code:: notranslate + .. code:: #include <pk11pub.h> #include <prtypes.h> diff --git a/doc/rst/legacy/reference/building_and_installing_nss/build_instructions/index.rst b/doc/rst/legacy/reference/building_and_installing_nss/build_instructions/index.rst index eb9c7c749..30f38e78e 100644 --- a/doc/rst/legacy/reference/building_and_installing_nss/build_instructions/index.rst +++ b/doc/rst/legacy/reference/building_and_installing_nss/build_instructions/index.rst @@ -56,14 +56,14 @@ Build instructions For RHEL-5, you need to use the new assembler. You can install the new assembler as root as follows: - .. code:: notranslate + .. code:: yum install binutils220 You can then use the new assembler by adding /usr/libexec/binutils220 to the beginning of your build path. This can be done in sh or bash as follows: - .. code:: notranslate + .. code:: export PATH=/usr/libexec/binutils220:$PATH @@ -79,7 +79,7 @@ Build instructions #. Clone the NSPR and NSS repositories. - .. code:: notranslate + .. code:: hg clone https://hg.mozilla.org/projects/nspr hg clone https://hg.mozilla.org/projects/nss @@ -87,7 +87,7 @@ Build instructions #. If you want to build a releases other than the tips of these repositories, then switch to the release tags: - .. code:: notranslate + .. code:: cd nspr hg update NSPR_4_9_5_RTM @@ -135,7 +135,7 @@ Build instructions #. Check out NSPR and NSS: - .. code:: notranslate + .. code:: cvs co -r NSPR_4_9_5_RTM NSPR cvs co -r NSS_3_14_2_RTM NSS diff --git a/doc/rst/legacy/reference/fc_initialize/index.rst b/doc/rst/legacy/reference/fc_initialize/index.rst index 2e6b429ab..a7ce8678b 100644 --- a/doc/rst/legacy/reference/fc_initialize/index.rst +++ b/doc/rst/legacy/reference/fc_initialize/index.rst @@ -52,7 +52,7 @@ FC_Initialize The library parameters string has this format: - .. code:: notranslate + .. code:: "configdir='dir' certPrefix='prefix1' keyPrefix='prefix2' secmod='file' flags= " @@ -60,14 +60,14 @@ FC_Initialize ``NSS_NoDB_Init("")``, which initializes NSS with no databases: - .. code:: notranslate + .. code:: "configdir='' certPrefix='' keyPrefix='' secmod='' flags=readOnly,noCertDB,noMod DB,forceOpen,optimizeSpace " Mozilla Firefox initializes NSS with this string (on Windows): - .. code:: notranslate + .. code:: "configdir='C:\\Documents and Settings\\wtc\\Application Data\\Mozilla\\Firefox\\Profiles\\default.7tt' certPrefix='' keyPrefix='' secmod='secmod.db' flags=optimizeSpace manufacturerID='Mozilla.org' libraryDescription='PSM Internal Crypto Services' cryptoTokenDescription='Generic Crypto Services' dbTokenDescription='Software Security Device' cryptoSlotDescription='PSM Internal Cryptographic Services' dbSlotDescription='PSM Private Keys' FIPSSlotDescription='PSM Internal FIPS-140-1 Cryptographic Services' FIPSTokenDescription='PSM FIPS-140-1 User Private Key Services' minPS=0" diff --git a/doc/rst/legacy/reference/troubleshoot/index.rst b/doc/rst/legacy/reference/troubleshoot/index.rst index dd74071ed..3a38049a8 100644 --- a/doc/rst/legacy/reference/troubleshoot/index.rst +++ b/doc/rst/legacy/reference/troubleshoot/index.rst @@ -37,7 +37,7 @@ troubleshoot - Building a 32-bit version on a 64-bit may fail with: - .. code:: notranslate + .. code:: /usr/include/features.h:324:26: fatal error: bits/predefs.h: No such file or directory diff --git a/doc/rst/legacy/ssl_functions/pkfnc/index.rst b/doc/rst/legacy/ssl_functions/pkfnc/index.rst index 118bca933..df09d2d82 100644 --- a/doc/rst/legacy/ssl_functions/pkfnc/index.rst +++ b/doc/rst/legacy/ssl_functions/pkfnc/index.rst @@ -48,12 +48,12 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax - .. code:: notranslate + .. code:: #include <pk11func.h> #include <certt.h> - .. code:: notranslate + .. code:: CERTCertificate *PK11_FindCertFromNickname( char *nickname, @@ -65,11 +65,11 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the nickname in the certificate | + | .. code:: | A pointer to the nickname in the certificate | | | database or to the nickname in the token. | | nickname | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to application data for the password | + | .. code:: | A pointer to application data for the password | | | callback function. This pointer is set with | | wincx | :ref:`moz | | | illa_projects_nss_ssl_functions_sslfnc#1088040` | @@ -108,13 +108,13 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_2 - .. code:: notranslate + .. code:: #include <pk11func.h> #include <certt.h> #include <keyt.h> - .. code:: notranslate + .. code:: SECKEYPrivateKey *PK11_FindKeyByAnyCert( CERTCertificate *cert, @@ -126,11 +126,11 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a certificate structure in the | + | .. code:: | A pointer to a certificate structure in the | | | certificate database. | | cert | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to application data for the password | + | .. code:: | A pointer to application data for the password | | | callback function. This pointer is set with | | wincx | :ref:`moz | | | illa_projects_nss_ssl_functions_sslfnc#1088040` | @@ -166,11 +166,11 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_3 - .. code:: notranslate + .. code:: #include <pk11func.h> - .. code:: notranslate + .. code:: char *PK11_GetSlotName(PK11SlotInfo *slot); @@ -180,7 +180,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a slot info structure. | + | .. code:: | A pointer to a slot info structure. | | | | | slot | | +-------------------------------------------------+-------------------------------------------------+ @@ -207,11 +207,11 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_4 - .. code:: notranslate + .. code:: #include <pk11func.h> - .. code:: notranslate + .. code:: char *PK11_GetTokenName(PK11SlotInfo *slot); @@ -221,7 +221,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a slot info structure. | + | .. code:: | A pointer to a slot info structure. | | | | | slot | | +-------------------------------------------------+-------------------------------------------------+ @@ -248,12 +248,12 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_5 - .. code:: notranslate + .. code:: #include <pk11func.h> #include <prtypes.h> - .. code:: notranslate + .. code:: PRBool PK11_IsHW(PK11SlotInfo *slot); @@ -263,7 +263,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a slot info structure. | + | .. code:: | A pointer to a slot info structure. | | | | | slot | | +-------------------------------------------------+-------------------------------------------------+ @@ -284,12 +284,12 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_6 - .. code:: notranslate + .. code:: #include <pk11func.h> #include <prtypes.h> - .. code:: notranslate + .. code:: PRBool PK11_IsPresent(PK11SlotInfo *slot); @@ -299,7 +299,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a slot info structure. | + | .. code:: | A pointer to a slot info structure. | | | | | slot | | +-------------------------------------------------+-------------------------------------------------+ @@ -320,12 +320,12 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_7 - .. code:: notranslate + .. code:: #include <pk11func.h> #include <prtypes.h> - .. code:: notranslate + .. code:: PRBool PK11_IsReadOnly(PK11SlotInfo *slot); @@ -335,7 +335,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a slot info structure. | + | .. code:: | A pointer to a slot info structure. | | | | | slot | | +-------------------------------------------------+-------------------------------------------------+ @@ -357,12 +357,12 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ .. rubric:: Syntax :name: syntax_8 - .. code:: notranslate + .. code:: #include <pk11func.h> #include <prtypes.h> - .. code:: notranslate + .. code:: void PK11_SetPasswordFunc(PK11PasswordFunc func); @@ -372,7 +372,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the callback function to set. | + | .. code:: | A pointer to the callback function to set. | | | | | func | | +-------------------------------------------------+-------------------------------------------------+ @@ -388,7 +388,7 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ The callback function set up by ``PK11_SetPasswordFunc`` has the following prototype: - .. code:: notranslate + .. code:: typedef char *(*PK11PasswordFunc)( PK11SlotInfo *slot, @@ -398,15 +398,15 @@ PKCS #11 Functions <#chapter_7_pkcs_11_functions>`__ This callback function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a slot info structure. | + | .. code:: | A pointer to a slot info structure. | | | | | slot | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | Set to ``PR_TRUE`` if this is a retry. This | + | .. code:: | Set to ``PR_TRUE`` if this is a retry. This | | | implies that the callback has previously | | retry | returned the wrong password. | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer supplied by the application that can | + | .. code:: | A pointer supplied by the application that can | | | be used to pass state information. Can be | | arg | ``NULL``. | +-------------------------------------------------+-------------------------------------------------+ diff --git a/doc/rst/legacy/ssl_functions/sslcrt/index.rst b/doc/rst/legacy/ssl_functions/sslcrt/index.rst index 0c40aa93d..dc810373f 100644 --- a/doc/rst/legacy/ssl_functions/sslcrt/index.rst +++ b/doc/rst/legacy/ssl_functions/sslcrt/index.rst @@ -56,11 +56,11 @@ sslcrt .. rubric:: Syntax :name: syntax - .. code:: notranslate + .. code:: #include <cert.h> - .. code:: notranslate + .. code:: SECStatus CERT_VerifyCertNow( CERTCertDBHandle *handle, @@ -75,21 +75,21 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate database handle. | + | .. code:: | A pointer to the certificate database handle. | | | | | handle | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate to be checked. | + | .. code:: | A pointer to the certificate to be checked. | | | | | cert | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | Indicates whether certificate signatures are to | + | .. code:: | Indicates whether certificate signatures are to | | | be checked. ``PR_TRUE`` means certificate | | checkSig | signatures are to be checked. ``PR_FALSE`` | | | means certificate signatures will not be | | | checked. | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | One of these values: | + | .. code:: | One of these values: | | | | | certUsage | - ``certUsageSSLClient`` | | | - ``certUsageSSLServer`` | @@ -102,7 +102,7 @@ sslcrt | | - ``certUsageVerifyCA`` | | | - ``certUsageProtectedObjectSigner`` | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The PIN argument value to pass to PK11 | + | .. code:: | The PIN argument value to pass to PK11 | | | functions. See description below for more | | wincx | information. | +-------------------------------------------------+-------------------------------------------------+ @@ -134,11 +134,11 @@ sslcrt .. rubric:: Syntax :name: syntax_2 - .. code:: notranslate + .. code:: #include <cert.h> - .. code:: notranslate + .. code:: SECStatus CERT_VerifyCertName( CERTCertificate *cert, @@ -150,11 +150,11 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate against which to | + | .. code:: | A pointer to the certificate against which to | | | check the hostname referenced by ``hostname``. | | cert | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The hostname to be checked. | + | .. code:: | The hostname to be checked. | | | | | hostname | | +-------------------------------------------------+-------------------------------------------------+ @@ -199,12 +199,12 @@ sslcrt .. rubric:: Syntax :name: syntax_3 - .. code:: notranslate + .. code:: #include <cert.h> #include <certt.h> - .. code:: notranslate + .. code:: SECCertTimeValidity CERT_CheckCertValidTimes( CERTCertificate *cert, @@ -216,11 +216,11 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate whose validity | + | .. code:: | A pointer to the certificate whose validity | | | period you want to check against. | | cert | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The time to check against the certificate's | + | .. code:: | The time to check against the certificate's | | | validity period. For more information, see the | | t | NSPR header ``pr_time.h``. | +-------------------------------------------------+-------------------------------------------------+ @@ -230,7 +230,7 @@ sslcrt The function returns an enumerator of type ``SECCertTimeValidity``: - .. code:: notranslate + .. code:: typedef enum { secCertTimeValid, @@ -247,11 +247,11 @@ sslcrt .. rubric:: Syntax :name: syntax_4 - .. code:: notranslate + .. code:: #include <nss.h> - .. code:: notranslate + .. code:: SECStatus NSS_CmpCertChainWCANames( CERTCertificate *cert, @@ -263,11 +263,11 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate structure for the | + | .. code:: | A pointer to the certificate structure for the | | | certificate whose certificate chain is to be | | cert | checked. | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to a structure that contains a list | + | .. code:: | A pointer to a structure that contains a list | | | of distinguished names (DNs) against which to | | caNames | check the DNs for the signers in the | | | certificate chain. | @@ -301,11 +301,11 @@ sslcrt .. rubric:: Syntax :name: syntax_5 - .. code:: notranslate + .. code:: #include <cert.h> - .. code:: notranslate + .. code:: CERTCertificate *CERT_DupCertificate(CERTCertificate *c) @@ -315,7 +315,7 @@ sslcrt This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate object to be | + | .. code:: | A pointer to the certificate object to be | | | duplicated. | | c | | +-------------------------------------------------+-------------------------------------------------+ @@ -340,12 +340,12 @@ sslcrt .. rubric:: Syntax :name: syntax_6 - .. code:: notranslate + .. code:: #include <cert.h> #include <certt.h> - .. code:: notranslate + .. code:: void CERT_DestroyCertificate(CERTCertificate *cert); @@ -355,7 +355,7 @@ sslcrt This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate to destroy. | + | .. code:: | A pointer to the certificate to destroy. | | | | | cert | | +-------------------------------------------------+-------------------------------------------------+ @@ -396,11 +396,11 @@ sslcrt .. rubric:: Syntax :name: syntax_7 - .. code:: notranslate + .. code:: #include <cert.h> - .. code:: notranslate + .. code:: CERTCertificate *CERT_FindCertByName ( CERTCertDBHandle *handle, @@ -412,11 +412,11 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate database handle. | + | .. code:: | A pointer to the certificate database handle. | | | | | handle | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The subject DN of the certificate you wish to | + | .. code:: | The subject DN of the certificate you wish to | | | find. | | name | | +-------------------------------------------------+-------------------------------------------------+ @@ -435,12 +435,12 @@ sslcrt .. rubric:: Syntax :name: syntax_8 - .. code:: notranslate + .. code:: #include <cert.h> #include <certt.h> - .. code:: notranslate + .. code:: CERTCertNicknames *CERT_GetCertNicknames ( CERTCertDBHandle *handle, @@ -453,18 +453,18 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the certificate database handle. | + | .. code:: | A pointer to the certificate database handle. | | | | | handle | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | One of these values: | + | .. code:: | One of these values: | | | | | what | - ``SEC_CERT_NICKNAMES_ALL`` | | | - ``SEC_CERT_NICKNAMES_USER`` | | | - ``SEC_CERT_NICKNAMES_SERVER`` | | | - ``SEC_CERT_NICKNAMES_CA`` | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The PIN argument value to pass to PK11 | + | .. code:: | The PIN argument value to pass to PK11 | | | functions. See description below for more | | wincx | information. | +-------------------------------------------------+-------------------------------------------------+ @@ -492,11 +492,11 @@ sslcrt .. rubric:: Syntax :name: syntax_9 - .. code:: notranslate + .. code:: #include <cert.h> - .. code:: notranslate + .. code:: void CERT_FreeNicknames(CERTCertNicknames *nicknames); @@ -506,7 +506,7 @@ sslcrt This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the ``CERTCertNicknames`` | + | .. code:: | A pointer to the ``CERTCertNicknames`` | | | structure to be freed. | | nicknames | | +-------------------------------------------------+-------------------------------------------------+ @@ -519,11 +519,11 @@ sslcrt .. rubric:: Syntax :name: syntax_10 - .. code:: notranslate + .. code:: #include <cert.h> - .. code:: notranslate + .. code:: CERTCertDBHandle *CERT_GetDefaultCertDB(void); @@ -546,11 +546,11 @@ sslcrt .. rubric:: Syntax :name: syntax_11 - .. code:: notranslate + .. code:: #include <nss.h> - .. code:: notranslate + .. code:: SSLKEAType NSS_FindCertKEAType(CERTCertificate * cert); @@ -560,7 +560,7 @@ sslcrt This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The certificate to check. | + | .. code:: | The certificate to check. | | | | | a | | +-------------------------------------------------+-------------------------------------------------+ @@ -592,12 +592,12 @@ sslcrt .. rubric:: Syntax :name: syntax_12 - .. code:: notranslate + .. code:: #include <secitem.h> #include <seccomon.h> - .. code:: notranslate + .. code:: SECComparison SECITEM_CompareItem( SECItem *a, @@ -609,11 +609,11 @@ sslcrt This function has the following parameters: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to one of the items to be compared. | + | .. code:: | A pointer to one of the items to be compared. | | | | | a | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to one of the items to be compared. | + | .. code:: | A pointer to one of the items to be compared. | | | | | b | | +-------------------------------------------------+-------------------------------------------------+ @@ -623,7 +623,7 @@ sslcrt The function returns an enumerator of type ``SECComparison``. - .. code:: notranslate + .. code:: typedef enum _SECComparison { SECLessThan = -1, diff --git a/doc/rst/legacy/ssl_functions/sslfnc/index.rst b/doc/rst/legacy/ssl_functions/sslfnc/index.rst index 25cbac6eb..382c388f1 100644 --- a/doc/rst/legacy/ssl_functions/sslfnc/index.rst +++ b/doc/rst/legacy/ssl_functions/sslfnc/index.rst @@ -71,11 +71,11 @@ sslfnc .. rubric:: Syntax :name: syntax - .. code:: notranslate + .. code:: #include "nss.h" - .. code:: notranslate + .. code:: SECStatus NSS_Init(char *configdir); @@ -132,11 +132,11 @@ sslfnc .. rubric:: Syntax :name: syntax_2 - .. code:: notranslate + .. code:: #include "nss.h" - .. code:: notranslate + .. code:: SECStatus NSS_InitReadWrite(char *configdir); @@ -185,11 +185,11 @@ sslfnc .. rubric:: Syntax :name: syntax_3 - .. code:: notranslate + .. code:: #include "nss.h" - .. code:: notranslate + .. code:: SECStatus NSS_NoDB_Init(char *reserved); @@ -237,11 +237,11 @@ sslfnc .. rubric:: Syntax :name: syntax_4 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_OptionSetDefault(PRInt32 option, PRBool on); @@ -450,11 +450,11 @@ sslfnc .. rubric:: Syntax :name: syntax_5 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_OptionGetDefault(PRInt32 option, PRBool *on) @@ -501,11 +501,11 @@ sslfnc .. rubric:: Syntax :name: syntax_6 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_CipherPrefSetDefault(PRInt32 cipher, PRBool enabled); @@ -639,11 +639,11 @@ sslfnc .. rubric:: Syntax :name: syntax_7 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_CipherPrefSetDefault(PRInt32 cipher, PRBool *enabled); @@ -687,11 +687,11 @@ sslfnc .. rubric:: Syntax :name: syntax_8 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: void SSL_ClearSessionCache(void); @@ -723,11 +723,11 @@ sslfnc .. rubric:: Syntax :name: syntax_9 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_ConfigServerSessionIDCache( int maxCacheEntries, @@ -830,11 +830,11 @@ sslfnc .. rubric:: Syntax :name: syntax_10 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_ConfigMPServerSIDCache( int maxCacheEntries, @@ -911,11 +911,11 @@ sslfnc .. rubric:: Syntax :name: syntax_11 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_InheritMPServerSIDCache (const char *envString); @@ -1015,11 +1015,11 @@ sslfnc .. rubric:: Syntax :name: syntax_12 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: extern SECStatus NSS_SetDomesticPolicy(void); @@ -1073,11 +1073,11 @@ sslfnc .. rubric:: Syntax :name: syntax_13 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: extern SECStatus NSS_SetExportPolicy(void); @@ -1140,11 +1140,11 @@ sslfnc .. rubric:: Syntax :name: syntax_14 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus NSS_SetFrancePolicy(void); @@ -1204,12 +1204,12 @@ sslfnc .. rubric:: Syntax :name: syntax_15 - .. code:: notranslate + .. code:: #include "ssl.h" #include "proto.h" - .. code:: notranslate + .. code:: SECStatus SSL_CipherPolicySet(PRInt32 cipher, PRInt32 policy); @@ -1350,12 +1350,12 @@ sslfnc .. rubric:: Syntax :name: syntax_16 - .. code:: notranslate + .. code:: #include "ssl.h" #include "proto.h" - .. code:: notranslate + .. code:: SECStatus SSL_CipherPolicyGet(PRInt32 cipher, PRInt32 *policy); @@ -1422,11 +1422,11 @@ sslfnc .. rubric:: Syntax :name: syntax_17 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: PRFileDesc *SSL_ImportFD( PRFileDesc *model, @@ -1482,11 +1482,11 @@ sslfnc .. rubric:: Syntax :name: syntax_18 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_OptionSet( PRFileDesc *fd, @@ -1707,11 +1707,11 @@ sslfnc .. rubric:: Syntax :name: syntax_19 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_OptionGet( PRFileDesc *fd, @@ -1758,12 +1758,12 @@ sslfnc .. rubric:: Syntax :name: syntax_20 - .. code:: notranslate + .. code:: #include "ssl.h" #include "proto.h" - .. code:: notranslate + .. code:: SECStatus SSL_CipherPrefSet( PRFileDesc *fd, @@ -1857,12 +1857,12 @@ sslfnc .. rubric:: Syntax :name: syntax_21 - .. code:: notranslate + .. code:: #include "ssl.h" #include "proto.h" - .. code:: notranslate + .. code:: SECStatus SSL_CipherPrefGet( PRFileDesc *fd, @@ -1903,11 +1903,11 @@ sslfnc .. rubric:: Syntax :name: syntax_22 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_ConfigSecureServer( PRFileDesc *fd, @@ -1984,11 +1984,11 @@ sslfnc .. rubric:: Syntax :name: syntax_23 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: int SSL_SetURL( PRFileDesc *fd, @@ -2035,11 +2035,11 @@ sslfnc .. rubric:: Syntax :name: syntax_24 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: int SSL_SetPKCS11PinArg(PRFileDesc *fd, void *a); @@ -2121,11 +2121,11 @@ sslfnc .. rubric:: Syntax :name: syntax_25 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_AuthCertificateHook( PRFileDesc *fd, @@ -2170,7 +2170,7 @@ sslfnc The callback function has the following prototype: - .. code:: notranslate + .. code:: typedef SECStatus (*SSLAuthCertificate) ( void *arg, @@ -2241,11 +2241,11 @@ sslfnc .. rubric:: Syntax :name: syntax_26 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_AuthCertificate( void *arg, @@ -2310,11 +2310,11 @@ sslfnc .. rubric:: Syntax :name: syntax_27 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_BadCertHook( PRFileDesc *fd, @@ -2355,7 +2355,7 @@ sslfnc The callback function set up by ``SSL_BadCertHook`` has the following prototype: - .. code:: notranslate + .. code:: typedef SECStatus (*SSLBadCertHandler)( void *arg, @@ -2402,11 +2402,11 @@ sslfnc .. rubric:: Syntax :name: syntax_28 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_GetClientAuthDataHook( PRFileDesc *fd, @@ -2453,7 +2453,7 @@ sslfnc The callback function has the following prototype: - .. code:: notranslate + .. code:: typedef SECStatus (*SSLGetClientAuthData)( void *arg, @@ -2486,11 +2486,11 @@ sslfnc .. rubric:: Syntax :name: syntax_29 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus NSS_GetClientAuthData( void * arg, @@ -2551,11 +2551,11 @@ sslfnc .. rubric:: Syntax :name: syntax_30 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_HandshakeCallback( PRFileDesc *fd, @@ -2591,7 +2591,7 @@ sslfnc The callback function set by ``SSL_HandshakeCallback`` has the following prototype: - .. code:: notranslate + .. code:: typedef void (*SSLHandshakeCallback)( PRFileDesc *fd, @@ -2635,11 +2635,11 @@ sslfnc .. rubric:: Syntax :name: syntax_31 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: int SSL_InvalidateSession(PRFileDesc *fd); @@ -2677,11 +2677,11 @@ sslfnc .. rubric:: Syntax :name: syntax_32 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: int SSL_DataPending(PRFileDesc *fd); @@ -2724,11 +2724,11 @@ sslfnc .. rubric:: Syntax :name: syntax_33 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_SecurityStatus( PRFileDesc *fd, @@ -2837,11 +2837,11 @@ sslfnc .. rubric:: Syntax :name: syntax_34 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECItem *SSL_GetSessionID(PRFileDesc *fd); @@ -2878,11 +2878,11 @@ sslfnc .. rubric:: Syntax :name: syntax_35 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: int SSL_SetSockPeerID(PRFileDesc *fd, char *peerID); @@ -2968,11 +2968,11 @@ sslfnc .. rubric:: Syntax :name: syntax_36 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: CERTCertificate *SSL_PeerCertificate(PRFileDesc *fd); @@ -3015,11 +3015,11 @@ sslfnc .. rubric:: Syntax :name: syntax_37 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: char *SSL_RevealURL(PRFileDesc *fd); @@ -3058,11 +3058,11 @@ sslfnc .. rubric:: Syntax :name: syntax_38 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: void *SSL_RevealPinArg(PRFileDesc *fd); @@ -3111,11 +3111,11 @@ sslfnc .. rubric:: Syntax :name: syntax_39 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_ForceHandshake(PRFileDesc *fd); @@ -3179,11 +3179,11 @@ sslfnc .. rubric:: Syntax :name: syntax_40 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_RedoHandshake(PRFileDesc *fd, PRBool flushCache); @@ -3242,11 +3242,11 @@ sslfnc .. rubric:: Syntax :name: syntax_41 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_ResetHandshake( PRFileDesc *fd, @@ -3307,11 +3307,11 @@ sslfnc .. rubric:: Syntax :name: syntax_42 - .. code:: notranslate + .. code:: #include "nss.h" - .. code:: notranslate + .. code:: SECStatus NSS_Shutdown(void); @@ -3348,11 +3348,11 @@ sslfnc .. rubric:: Syntax :name: syntax_43 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_EnableDefault(int which, PRBool on); @@ -3395,11 +3395,11 @@ sslfnc .. rubric:: Syntax :name: syntax_44 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: SECStatus SSL_Enable( PRFileDesc *fd, @@ -3449,12 +3449,12 @@ sslfnc .. rubric:: Syntax :name: syntax_45 - .. code:: notranslate + .. code:: #include "ssl.h" #include "sslproto.h" - .. code:: notranslate + .. code:: SECStatus SSL_EnableCipher(long which, PRBool enabled); @@ -3498,12 +3498,12 @@ sslfnc .. rubric:: Syntax :name: syntax_46 - .. code:: notranslate + .. code:: #include <ssl.h> #include <sslproto.h> - .. code:: notranslate + .. code:: SECStatus SSL_SetPolicy(long which, int policy); @@ -3553,11 +3553,11 @@ sslfnc .. rubric:: Syntax :name: syntax_47 - .. code:: notranslate + .. code:: #include "ssl.h" - .. code:: notranslate + .. code:: int SSL_RedoHandshake(PRFileDesc *fd); diff --git a/doc/rst/legacy/ssl_functions/sslkey/index.rst b/doc/rst/legacy/ssl_functions/sslkey/index.rst index 1c25c6e28..eafd40314 100644 --- a/doc/rst/legacy/ssl_functions/sslkey/index.rst +++ b/doc/rst/legacy/ssl_functions/sslkey/index.rst @@ -42,12 +42,12 @@ sslkey .. rubric:: Syntax :name: syntax - .. code:: notranslate + .. code:: #include <key.h> #include <keyt.h> - .. code:: notranslate + .. code:: SECKEYKeyDBHandle *SECKEY_GetDefaultKeyDB(void); @@ -71,12 +71,12 @@ sslkey .. rubric:: Syntax :name: syntax_2 - .. code:: notranslate + .. code:: #include <key.h> #include <keyt.h> - .. code:: notranslate + .. code:: void SECKEY_DestroyPrivateKey(SECKEYPrivateKey *key); @@ -86,7 +86,7 @@ sslkey This function has the following parameter: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | A pointer to the private key structure to | + | .. code:: | A pointer to the private key structure to | | | destroy. | | key | | +-------------------------------------------------+-------------------------------------------------+ diff --git a/doc/rst/legacy/ssl_functions/ssltyp/index.rst b/doc/rst/legacy/ssl_functions/ssltyp/index.rst index 4b5b58c80..e1745f88a 100644 --- a/doc/rst/legacy/ssl_functions/ssltyp/index.rst +++ b/doc/rst/legacy/ssl_functions/ssltyp/index.rst @@ -68,11 +68,11 @@ ssltyp .. rubric:: Syntax :name: syntax - .. code:: notranslate + .. code:: #include <certt.h> - .. code:: notranslate + .. code:: typedef struct CERTCertDBHandleStr CERTCertDBHandle; @@ -84,11 +84,11 @@ ssltyp .. rubric:: Syntax :name: syntax_2 - .. code:: notranslate + .. code:: #include <certt.h> - .. code:: notranslate + .. code:: typedef struct CERTCertificateStr CERTCertificate; @@ -113,7 +113,7 @@ ssltyp .. rubric:: Syntax :name: syntax_3 - .. code:: notranslate + .. code:: #include <pk11expt.h> @@ -127,13 +127,13 @@ ssltyp .. rubric:: Syntax :name: syntax_4 - .. code:: notranslate + .. code:: #include <seccomon.h> #include <prtypes.h> #include <secport.h> - .. code:: notranslate + .. code:: typedef enum { siBuffer, @@ -148,11 +148,11 @@ ssltyp siDEROID } SECItemType; - .. code:: notranslate + .. code:: typedef struct SECItemStr SECItem; - .. code:: notranslate + .. code:: struct SECItemStr { SECItemType type; @@ -177,11 +177,11 @@ ssltyp .. rubric:: Syntax :name: syntax_5 - .. code:: notranslate + .. code:: #include <keyt.h> - .. code:: notranslate + .. code:: typedef struct SECKEYPrivateKeyStr SECKEYPrivateKey; @@ -203,11 +203,11 @@ ssltyp .. rubric:: Syntax :name: syntax_6 - .. code:: notranslate + .. code:: #include <seccomon.h> - .. code:: notranslate + .. code:: typedef enum { SECWouldBlock = -2, @@ -221,15 +221,15 @@ ssltyp The enum includes the following enumerators: +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | Reserved for internal use. | + | .. code:: | Reserved for internal use. | | | | | SECWouldBlock | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The operation failed. To find out why, call | + | .. code:: | The operation failed. To find out why, call | | | ``PR_GetError``. | | SECFailure | | +-------------------------------------------------+-------------------------------------------------+ - | .. code:: notranslate | The operation succeeded. In this case the value | + | .. code:: | The operation succeeded. In this case the value | | | returned by ``PR_GetError`` is meaningless. | | SECSuccess | | +-------------------------------------------------+-------------------------------------------------+ @@ -255,11 +255,11 @@ ssltyp .. rubric:: Syntax :name: syntax_7 - .. code:: notranslate + .. code:: #include <prtypes.h> - .. code:: notranslate + .. code:: SECStatus SECItem_FreeItem ( SECItem *item, @@ -302,11 +302,11 @@ ssltyp .. rubric:: Syntax :name: syntax_8 - .. code:: notranslate + .. code:: #include <prtypes.h> - .. code:: notranslate + .. code:: SECStatus SECItem_ZfreeItem ( SECItem *item, diff --git a/doc/rst/legacy/tls_cipher_suite_discovery/index.rst b/doc/rst/legacy/tls_cipher_suite_discovery/index.rst index fd0988e88..009eb5f82 100644 --- a/doc/rst/legacy/tls_cipher_suite_discovery/index.rst +++ b/doc/rst/legacy/tls_cipher_suite_discovery/index.rst @@ -45,7 +45,7 @@ TLS Cipher Suite Discovery in that table publicly available too. The table and the number of entries are declared in "ssl.h", as follows: - .. code:: notranslate + .. code:: /* constant table enumerating all implemented SSL 2 and 3 cipher suites. */ SSL_IMPORT const PRUint16 SSL_ImplementedCiphers[]; @@ -57,7 +57,7 @@ TLS Cipher Suite Discovery so libSSL provides a function by which the application can obtain a wealth of information about any supported cipher suite, by its number. This function is declared in "ssl.h" as follows: - .. code:: notranslate + .. code:: SSL_IMPORT SECStatus SSL_GetCipherSuiteInfo( @@ -75,7 +75,7 @@ TLS Cipher Suite Discovery ``SSLCipherSuiteInfo`` structure for that cipher suite. The ``SSLCipherSuiteInfo`` structure contains this information, declared in "sslt.h": - .. code:: notranslate + .. code:: typedef struct SSLCipherSuiteInfoStr { PRUint16 length; diff --git a/doc/rst/legacy/tools/nss_tools_certutil/index.rst b/doc/rst/legacy/tools/nss_tools_certutil/index.rst index aac6753c1..cca614307 100644 --- a/doc/rst/legacy/tools/nss_tools_certutil/index.rst +++ b/doc/rst/legacy/tools/nss_tools_certutil/index.rst @@ -40,7 +40,7 @@ NSS Tools certutil To run the Certificate Database Tool, type the command - .. code:: notranslate + .. code:: certutil option [arguments ] @@ -472,47 +472,47 @@ NSS Tools certutil options and arguments. Options and arguments in square brackets are optional, those without square brackets are required. - .. code:: notranslate + .. code:: -N [-d certdir ] - .. code:: notranslate + .. code:: -S -k rsa|dsa -n certname -s subject [-c issuer |-x] -t trustargs [-h tokenname ] [-m serial-number ] [-v valid-months ] [-w offset-months ] [-d certdir ] [-p phone ] [-f password-file ] [-1] [-2] [-3] [-4] - .. code:: notranslate + .. code:: -R -k rsa|dsa -s subject [-h tokenname ] [-d certdir ] [-p phone ] [-o output-file ] [-f password-file ] - .. code:: notranslate + .. code:: -C -c issuer [-f password-file ] [-h tokenname ] -i cert-request-file -o output-file [-m serial-number ] [-v valid-months ] [-w offset-months ] [-d certdir ] [-1] [-2] [-3] [-4] - .. code:: notranslate + .. code:: -A -n certname -t trustargs [-h tokenname ] [-d certdir ] [-a] [-i cert-request-file ] - .. code:: notranslate + .. code:: -L [-n certname ] [-d certdir ] [-r] [-a] - .. code:: notranslate + .. code:: -V -n certname -b validity-time -u certusage [-e] [-l] [-d certdir ] - .. code:: notranslate + .. code:: -M -n certname -t trustargs [-d certdir ] - .. code:: notranslate + .. code:: -H @@ -540,7 +540,7 @@ NSS Tools certutil This example creates a new certificate database (``cert8.db`` file) in the specified directory: - .. code:: notranslate + .. code:: certutil -N -d certdir @@ -556,7 +556,7 @@ NSS Tools certutil This example lists all the certificates in the ``cert8.db`` file in the specified directory: - .. code:: notranslate + .. code:: certutil -L -d certdir @@ -575,13 +575,13 @@ NSS Tools certutil This example generates a binary certificate request file named ``e95c.req`` in the specified directory: - .. code:: notranslate + .. code:: certutil -R -s "CN=John Smith, O=Netscape, L=Mountain View, ST=California, C=US" -p "650-555-8888" -o mycert.req -d certdir Before it creates the request file, the Certificate Database Tool prompts you for a password: - .. code:: notranslate + .. code:: Enter Password or Pin for "Communicator Certificate DB": @@ -597,7 +597,7 @@ NSS Tools certutil example creates a new binary, self-signed CA certificate named ``myissuer``, in the specified directory. - .. code:: notranslate + .. code:: certutil -S -s "CN=My Issuer" -n myissuer -x -t "C,C,C" -1 -2 -5 -m 1234 -f password-file -d certdir @@ -605,7 +605,7 @@ NSS Tools certutil certificate request named ``mycert.req``, in the specified directory. It is issued by the self-signed certificate created above, ``myissuer``. - .. code:: notranslate + .. code:: certutil -C -m 2345 -i mycert.req -o mycert.crt -c myissuer -d certdir @@ -618,13 +618,13 @@ NSS Tools certutil This example adds a certificate to the certificate database: - .. code:: notranslate + .. code:: certutil -A -n jsmith@netscape.com -t "p,p,p" -i mycert.crt -d certdir You can see this certificate in the database with this command: - .. code:: notranslate + .. code:: certutil -L -n jsmith@netscape.com -d certdir @@ -643,24 +643,24 @@ NSS Tools certutil This example validates a certificate: - .. code:: notranslate + .. code:: certutil -V -n jsmith@netscape.com -b 9803201212Z -u SR -e -l -d certdir The Certificate Database Tool shows results similar to - .. code:: notranslate + .. code:: Certificate:'jsmith@netscape.com' is valid. or - .. code:: notranslate + .. code:: UID=jsmith, E=jsmith@netscape.com, CN=John Smith, O=Netscape Communications Corp., C=US : Expired certificate or - .. code:: notranslate + .. code:: UID=jsmith, E=jsmith@netscape.com, CN=John Smith, O=Netscape Communications Corp., C=US : Certificate not approved for this operation
\ No newline at end of file diff --git a/doc/rst/legacy/tools/nss_tools_modutil/index.rst b/doc/rst/legacy/tools/nss_tools_modutil/index.rst index d2fcbba78..9dd26e278 100644 --- a/doc/rst/legacy/tools/nss_tools_modutil/index.rst +++ b/doc/rst/legacy/tools/nss_tools_modutil/index.rst @@ -326,12 +326,12 @@ NSS Tools modutil metainfo file for the `Netscape Signing Tool <http://developer.netscape.com/docs/manuals/signedobj/signtool/index.htm>`__ would include a line such as this: - .. code:: notranslate + .. code:: + Pkcs11_install_script: pk11install The sample script file could contain the following: - .. code:: notranslate + .. code:: ForwardCompatible { IRIX:6.2:mips SUNOS:5.5.1:sparc } Platforms { @@ -387,39 +387,39 @@ NSS Tools modutil .. container:: The script file grammar is as follows: - .. code:: notranslate + .. code:: --> valuelist - .. code:: notranslate + .. code:: valuelist --> value valuelist <null> - .. code:: notranslate + .. code:: value ---> key_value_pair string - .. code:: notranslate + .. code:: key_value_pair --> key { valuelist } - .. code:: notranslate + .. code:: key --> string - .. code:: notranslate + .. code:: string --> simple_string "complex_string" - .. code:: notranslate + .. code:: simple_string --> [^ \t\n\""{""}"]+ (No whitespace, quotes, or braces.) - .. code:: notranslate + .. code:: complex_string --> ([^\"\\\r\n]|(\\\")|(\\\\))+ (Quotes and backslashes must be escaped with a backslash. A complex string must not @@ -474,7 +474,7 @@ NSS Tools modutil - WINNT (x86) Here are some examples of valid platform strings: - .. code:: notranslate + .. code:: IRIX:6.2:mips SUNOS:5.5.1:sparc @@ -497,7 +497,7 @@ NSS Tools modutil This key-value pair is a bitstring specified in hexadecimal (0x) format. It is constructed as a bitwise OR of the following constants. If the ``DefaultMechanismFlags`` entry is omitted, the value defaults to 0x0. - .. code:: notranslate + .. code:: RSA: 0x00000001 DSA: 0x00000002 @@ -519,7 +519,7 @@ NSS Tools modutil not, so that Communicator can enable them. This key is a bitstring specified in hexadecimal (0x) format. It is constructed as a bitwise OR of the following constants. If the ``CipherEnableFlags`` entry is omitted, the value defaults to 0x0. - .. code:: notranslate + .. code:: FORTEZZA: 0x0000 0001 @@ -552,7 +552,7 @@ NSS Tools modutil in the order in which they are specified in the script file. ``FilePermissions`` Interpreted as a string of octal digits, according to the standard Unix format. This string is a bitwise OR of the following constants: - .. code:: notranslate + .. code:: user read: 0400 user write: 0200 @@ -591,12 +591,12 @@ NSS Tools modutil .. container:: This example creates a set of security management database files in the specified directory: - .. code:: notranslate + .. code:: modutil -create -dbdir c:\databases The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while Communicator is running could cause corruption of your security databases. If Communicator is @@ -604,7 +604,7 @@ NSS Tools modutil operation. Type 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: Creating "c:\databases\key3.db"...done. Creating "c:\databases\cert8.db"...done. @@ -618,12 +618,12 @@ NSS Tools modutil .. container:: This example gives detailed information about the specified module: - .. code:: notranslate + .. code:: modutil -list "Netscape Internal PKCS #11 Module" -dbdir c:\databases The Security Module Database Tool displays information similar to this: - .. code:: notranslate + .. code:: Using database directory c:\databases... -------------------------------------------------------- @@ -636,7 +636,7 @@ NSS Tools modutil Cipher Enable Flags: None Default Mechanism Flags: RSA:DSA:RC2:RC4:DES:SHA1:MD5:MD2 - .. code:: notranslate + .. code:: Slot: Communicator Internal Cryptographic Services Version 4.0 Manufacturer: Netscape Communications Corp @@ -654,7 +654,7 @@ NSS Tools modutil Login Type: Public (no login required) User Pin: NOT Initialized - .. code:: notranslate + .. code:: Slot: Communicator User Private Key and Certificate Services Manufacturer: Netscape Communications Corp @@ -681,13 +681,13 @@ NSS Tools modutil This example makes the specified module a default provider for the RSA, DSA, and RC2 security mechanisms: - .. code:: notranslate + .. code:: modutil -default "Cryptographic Module" -dbdir c:\databases -mechanisms RSA:DSA:RC2 The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while Communicator is running could cause corruption of your security databases. If Communicator is @@ -695,11 +695,11 @@ NSS Tools modutil operation. Type 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: Using database directory c:\databases... - .. code:: notranslate + .. code:: Successfully changed defaults. @@ -711,13 +711,13 @@ NSS Tools modutil .. container:: This example enables a particular slot in the specified module: - .. code:: notranslate + .. code:: modutil -enable "Cryptographic Module" -slot "Cryptographic Reader" -dbdir c:\databases The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while Communicator is running could cause corruption of your security databases. If Communicator is @@ -725,11 +725,11 @@ NSS Tools modutil operation. Type 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: Using database directory c:\databases... - .. code:: notranslate + .. code:: Slot "Cryptographic Reader" enabled. @@ -741,12 +741,12 @@ NSS Tools modutil .. container:: This example enables FIPS 140-2 compliance in Communicator's internal module: - .. code:: notranslate + .. code:: modutil -dbdir "C:\databases" -fips true The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while the browser is running could cause corruption of your security databases. If the browser is currently running, @@ -754,7 +754,7 @@ NSS Tools modutil 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: FIPS mode enabled. @@ -766,13 +766,13 @@ NSS Tools modutil .. container:: This example adds a new cryptographic module to the database: - .. code:: notranslate + .. code:: C:\modutil> modutil -dbdir "C:\databases" -add "Cryptorific Module" - libfile "C:\winnt\system32\crypto.dll" -mechanisms RSA:DSA:RC2:RANDOM The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while Communicator is running could cause corruption of your security databases. If Communicator is @@ -780,7 +780,7 @@ NSS Tools modutil operation. Type 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: Using database directory C:\databases... Module "Cryptorific Module" added to database. @@ -794,7 +794,7 @@ NSS Tools modutil .. container:: This example installs a cryptographic module from the following sample installation script. - .. code:: notranslate + .. code:: Platforms { WinNT::x86 { @@ -819,13 +819,13 @@ NSS Tools modutil To install from the script, use the following command. The root directory should be the Windows root directory (for example, ``c:\\windows``, or ``c:\\winnt``). - .. code:: notranslate + .. code:: C:\modutil> modutil -dbdir "c:\databases" -jar install.jar -installdir "C:/winnt" The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while Communicator is running could cause corruption of your security databases. If Communicator is @@ -833,20 +833,20 @@ NSS Tools modutil operation. Type 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: Using database directory c:\databases... - .. code:: notranslate + .. code:: This installation JAR file was signed by: ---------------------------------------------- - .. code:: notranslate + .. code:: **SUBJECT NAME** - .. code:: notranslate + .. code:: C=US, ST=California, L=Mountain View, CN=Cryptorific Inc., OU=Digital ID Class 3 - Netscape Object Signing, OU="www.verisign.com/repository/CPS @@ -858,7 +858,7 @@ NSS Tools modutil OU="VeriSign, Inc.", O=VeriSign Trust Network ---------------------------------------------- - .. code:: notranslate + .. code:: Do you wish to continue this installation? (y/n) y Using installer script "installer_script" @@ -871,7 +871,7 @@ NSS Tools modutil "./pk11inst.dir/setup.exe" executed successfully Installed module "Cryptorific Module" into module database - .. code:: notranslate + .. code:: Installation completed successfully C:\modutil> @@ -884,13 +884,13 @@ NSS Tools modutil .. container:: This example changes the password for a token on an existing module. - .. code:: notranslate + .. code:: C:\modutil> modutil -dbdir "c:\databases" -changepw "Communicator Certificate DB" The Security Module Database Tool displays a warning: - .. code:: notranslate + .. code:: WARNING: Performing this operation while Communicator is running could cause corruption of your security databases. If Communicator is @@ -898,7 +898,7 @@ NSS Tools modutil operation. Type 'q <enter>' to abort, or <enter> to continue: After you press Enter, the tool displays the following: - .. code:: notranslate + .. code:: Using database directory c:\databases... Enter old password: diff --git a/doc/rst/legacy/tools/nss_tools_ssltap/index.rst b/doc/rst/legacy/tools/nss_tools_ssltap/index.rst index dfbc760a3..7a971f7c2 100644 --- a/doc/rst/legacy/tools/nss_tools_ssltap/index.rst +++ b/doc/rst/legacy/tools/nss_tools_ssltap/index.rst @@ -135,7 +135,7 @@ NSS Tools ssltap *hostname:port*, the information you get in this way is not very useful. For example, assume your development machine is called ``intercept``. The simplest way to use the debugging tool is to execute the following command from a command shell: - .. code:: notranslate + .. code:: ssltap www.netscape.com:80 @@ -162,7 +162,7 @@ NSS Tools ssltap .. rubric:: Command :name: command - .. code:: notranslate + .. code:: ssltap.exe -sx -p 444 interzone.mcom.com:443 > sx.txt @@ -170,7 +170,7 @@ NSS Tools ssltap :name: output Output - .. code:: notranslate + .. code:: Connected to interzone.mcom.com:443 --> [ @@ -182,7 +182,7 @@ NSS Tools ssltap challenge-length = 16 (0x10) cipher-suites = { - .. code:: notranslate + .. code:: (0x010080) SSL2/RSA/RC4-128/MD5 (0x020080) SSL2/RSA/RC4-40/MD5 @@ -201,7 +201,7 @@ NSS Tools ssltap session-id = { } challenge = { 0xec5d 0x8edb 0x37c9 0xb5c9 0x7b70 0x8fe9 0xd1d3 - .. code:: notranslate + .. code:: 0x2592 } } @@ -223,13 +223,13 @@ NSS Tools ssltap wn&l.ì..XOG.-.E 10: 5c 17 75 43 a7 4c 88 c7 88 64 3c 50 41 48 4f 7f | - .. code:: notranslate + .. code:: \.uC§L.Ç.d<PAHO. session ID = { length = 32 - .. code:: notranslate + .. code:: contents = {..} 0: 14 11 07 a8 2a 31 91 29 11 94 40 37 57 10 a7 32 | ...¨*1.)..@7W.§2 @@ -287,7 +287,7 @@ NSS Tools ssltap length = 56 (0x38) < encrypted > - .. code:: notranslate + .. code:: } ] @@ -308,7 +308,7 @@ NSS Tools ssltap length = 56 (0x38) < encrypted > - .. code:: notranslate + .. code:: } ] @@ -329,7 +329,7 @@ NSS Tools ssltap length = 160 (0xa0) < encrypted > - .. code:: notranslate + .. code:: } ] @@ -341,7 +341,7 @@ NSS Tools ssltap length = 223 (0xdf) < encrypted > - .. code:: notranslate + .. code:: } SSLRecord { @@ -362,14 +362,14 @@ NSS Tools ssltap .. rubric:: Command :name: command_2 - .. code:: notranslate + .. code:: ssltap.exe -s -p 444 interzone.mcom.com:443 > s.txt .. rubric:: Output :name: output_2 - .. code:: notranslate + .. code:: Connected to interzone.mcom.com:443 --> [ @@ -511,14 +511,14 @@ NSS Tools ssltap .. rubric:: Command :name: command_3 - .. code:: notranslate + .. code:: ssltap.exe -h -p 444 interzone.mcom.com:443 > h.txt .. rubric:: Output :name: output_3 - .. code:: notranslate + .. code:: Connected to interzone.mcom.com:443 --> [ @@ -558,14 +558,14 @@ NSS Tools ssltap .. rubric:: Command :name: command_4 - .. code:: notranslate + .. code:: ssltap.exe -hs -p 444 interzone.mcom.com:443 > hs.txt .. rubric:: Output :name: output_4 - .. code:: notranslate + .. code:: Connected to interzone.mcom.com:443 --> [ |