aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlloyd <[email protected]>2011-04-06 12:11:56 +0000
committerlloyd <[email protected]>2011-04-06 12:11:56 +0000
commitd0777c4db5f465a237d6a1113961ee0dbb5d392f (patch)
treeec0477a60b42b0b7c96fb2405cd013f29281bfe7
parentc9cbc40b2852c14ed4432d71561f4e877900e534 (diff)
Fix syntax highlighting
-rw-r--r--doc/conf.py2
-rw-r--r--doc/filters.txt14
-rw-r--r--doc/x509.txt12
3 files changed, 15 insertions, 13 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 65c4c62ed..f1c6ebee4 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -91,6 +91,8 @@ exclude_patterns = ['_build']
# output. They are ignored by default.
#show_authors = False
+highlight_language = 'cpp'
+
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
diff --git a/doc/filters.txt b/doc/filters.txt
index 8ce396371..b5ce3333b 100644
--- a/doc/filters.txt
+++ b/doc/filters.txt
@@ -180,10 +180,10 @@ a case where that is useful::
// have std::string ciphertext, auth_code, key, iv, mac_key;
Pipe pipe(new Base64_Decoder,
- get_cipher(``AES-128'', key, iv, DECRYPTION),
+ get_cipher("AES-128", key, iv, DECRYPTION),
new Fork(
0
- new MAC_Filter(``HMAC(SHA-1)'', mac_key)
+ new MAC_Filter("HMAC(SHA-1)", mac_key)
)
);
@@ -274,7 +274,7 @@ no explicit output operation; the writing of ``out.txt`` is
implicit::
DataSource_Stream in("in.txt");
- Pipe pipe(new CBC_Encryption("AES-128", "PKCS7", key, iv),
+ Pipe pipe(get_cipher("AES-128/CTR-BE", key, iv),
new DataSink_Stream("out.txt"));
pipe.process_msg(in);
@@ -513,10 +513,10 @@ must call ``set_key`` *before* calling ``set_iv``.
Here's a example::
- Keyed_Filter *cast, *hmac;
+ Keyed_Filter *aes, *hmac;
Pipe pipe(new Base64_Decoder,
// Note the assignments to the cast and hmac variables
- cast = new CBC_Decryption("CAST-128", "PKCS7", cast_key, iv),
+ aes = get_cipher("AES-128/CBC", aes_key, iv),
new Fork(
0, // Read the section 'Fork' to understand this
new Chain(
@@ -529,8 +529,8 @@ Here's a example::
// use pipe for a while, decrypt some stuff, derive new keys and IVs
pipe.end_msg();
- cast->set_key(cast_key2);
- cast->set_iv(iv2);
+ aes->set_key(aes_key2);
+ aes->set_iv(iv2);
hmac->set_key(mac_key2);
pipe.start_msg();
diff --git a/doc/x509.txt b/doc/x509.txt
index 64189ed0d..027548b16 100644
--- a/doc/x509.txt
+++ b/doc/x509.txt
@@ -362,9 +362,9 @@ which can be found in ``x509_ca.h``. A CA always needs its own
certificate, which can either be a self-signed certificate (see below
on how to create one) or one issued by another CA (see the section on
PKCS #10 requests). Creating a CA object is done by the following
-constructor::
+constructor:
- X509_CA(const X509_Certificate& cert, const Private_Key& key);
+.. cpp:function:: X509_CA(const X509_Certificate& cert, const Private_Key& key)
The private key is the private key corresponding to the public key in the
CA's certificate.
@@ -375,9 +375,9 @@ Botan). These are decoded in a similar manner to
certificates/CRLs/etc. A request is vetted by humans (who somehow
verify that the name in the request corresponds to the name of the
entity who requested it), and then signed by a CA key, generating a
-new certificate::
+new certificate:
- X509_Certificate sign_request(const PKCS10_Request&) const;
+.. cpp:function:: X509_Certificate sign_request(const PKCS10_Request& req) const
Generating CRLs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -390,7 +390,7 @@ available at all times.
Of course, you might be wondering what to do if no certificates have
been revoked. Never fear; empty CRLs, which revoke nothing at all, can
-be issued. To generate a new, empty CRL, just call
+be issued. To generate a new, empty CRL, just call
.. cpp:function:: X509_CRL X509_CA::new_crl(u32bit seconds_to_expiration = 0)
@@ -431,7 +431,7 @@ Self-Signed Certificates
Generating a new self-signed certificate can often be useful, for
example when setting up a new root CA, or for use in email
-applications. The library provides a utility function for this::
+applications. The library provides a utility function for this:
.. cpp:function:: X509_Certificate create_self_signed_cert(const X509_Cert_Options& opts, const Private_Key& key)