diff options
-rw-r--r-- | doc/relnotes/contents.rst | 2 | ||||
-rw-r--r-- | doc/website/contents.rst | 5 | ||||
-rw-r--r-- | doc/website/download.rst | 34 | ||||
-rw-r--r-- | doc/website/index.rst | 9 | ||||
-rw-r--r-- | doc/website/manual.rst | 10 | ||||
-rw-r--r-- | src/build-data/botan.doxy.in | 1 | ||||
-rw-r--r-- | src/build-data/makefile/gmake.in | 2 | ||||
-rw-r--r-- | src/lib/algo_base/transform.h | 1 | ||||
-rwxr-xr-x | src/scripts/tls_suite_info.py | 30 |
9 files changed, 50 insertions, 44 deletions
diff --git a/doc/relnotes/contents.rst b/doc/relnotes/contents.rst index 15f3ff948..73a3d270d 100644 --- a/doc/relnotes/contents.rst +++ b/doc/relnotes/contents.rst @@ -1,5 +1,5 @@ -Contents +Release Notes ======================================== .. toctree:: diff --git a/doc/website/contents.rst b/doc/website/contents.rst index 55c302d01..56454e990 100644 --- a/doc/website/contents.rst +++ b/doc/website/contents.rst @@ -7,9 +7,10 @@ Contents index license faq + manual download + vcs pgpkey credits users - vcs - relnotes/index + relnotes/contents diff --git a/doc/website/download.rst b/doc/website/download.rst index 733a5c316..62fbc77fe 100644 --- a/doc/website/download.rst +++ b/doc/website/download.rst @@ -11,22 +11,6 @@ Unsure which release you want? Check the :ref:`FAQ <devel_vs_stable>`. If you are planning on developing an application using TLS, using the latest 1.11 release instead of 1.10 is highly recommended. -Current Stable Series (1.10) ----------------------------------------- - -The latest stable branch release is :doc:`relnotes/1_10_7`: -:tgz:`1.10.7` (:tgz_sig:`sig <1.10.7>`), -:tbz:`1.10.7` (:tbz_sig:`sig <1.10.7>`) - -Windows Installer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Windows installers for use with Visual C++ 2010 -:installer_x86_32:`1.10.5` (:installer_sig_x86_32:`sig <1.10.5>`) -and -:installer_x86_64:`1.10.5` (:installer_sig_x86_64:`sig <1.10.5>`) -are also available. - Current Development Series (1.11) ---------------------------------------- @@ -42,4 +26,20 @@ creates regular snapshots of trunk, which are available `here Versions 1.11.0 and later require a mostly-compliant C++11 compiler such as Clang 3.1 or GCC 4.7. - + +Current Stable Series (1.10) +---------------------------------------- + +The latest stable branch release is :doc:`relnotes/1_10_7`: +:tgz:`1.10.7` (:tgz_sig:`sig <1.10.7>`), +:tbz:`1.10.7` (:tbz_sig:`sig <1.10.7>`) + +.. + Windows Installer + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Windows installers for use with Visual C++ 2010 + :installer_x86_32:`1.10.5` (:installer_sig_x86_32:`sig <1.10.5>`) + and + :installer_x86_64:`1.10.5` (:installer_sig_x86_64:`sig <1.10.5>`) + are also available. diff --git a/doc/website/index.rst b/doc/website/index.rst index 8fc5118c8..62d322c52 100644 --- a/doc/website/index.rst +++ b/doc/website/index.rst @@ -13,8 +13,9 @@ available. In addition to C++ you can use botan from Python or Perl (both included in tree), or with `Node.js <https://github.com/justinfreitag/node-botan>`_. -See the :doc:`faq` for a list of common questions and answers and -:doc:`download` for information about getting the latest release. +See the :doc:`faq` for a list of common questions and answers, +:doc:`download` for information about getting the latest release, +and :doc:`manual` for the documentation. If you need help or have questions, send a mail to the `development mailing list @@ -24,7 +25,3 @@ the library, and related topics are also welcome. If you find what you believe to be a bug, please file a ticket in `Bugzilla <http://bugs.randombit.net/>`_. -The `manual <http://botan.randombit.net/manual>`_ and -`Doxygen reference <http://botan.randombit.net/doxygen>`_ for -the most recent revision is available online. - diff --git a/doc/website/manual.rst b/doc/website/manual.rst new file mode 100644 index 000000000..4253561b4 --- /dev/null +++ b/doc/website/manual.rst @@ -0,0 +1,10 @@ + +Reference Manual +======================================== + +The documentation is all under ``doc`` in your source tree, stored as ``.rst`` +(RestructedText) files. They can be processed by Sphinx to produce HTML or +PDF output. + +The `manual </manual>`_ and `Doxygen reference </doxygen>`_ for the +latest development release is available online. diff --git a/src/build-data/botan.doxy.in b/src/build-data/botan.doxy.in index 49d18fe7c..4f37dde29 100644 --- a/src/build-data/botan.doxy.in +++ b/src/build-data/botan.doxy.in @@ -61,7 +61,6 @@ GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES -SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = #--------------------------------------------------------------------------- diff --git a/src/build-data/makefile/gmake.in b/src/build-data/makefile/gmake.in index 60520cd5f..40896a321 100644 --- a/src/build-data/makefile/gmake.in +++ b/src/build-data/makefile/gmake.in @@ -92,7 +92,7 @@ endif $(INSTALL_CMD_DATA) $(PKGCONFIG) $(PKGCONF_DIR) website: - rm -rf $(WEBSITE_SRC_DIR) + rm -rf $(WEBSITE_SRC_DIR) $(WEBSITE_DIR) mkdir -p $(WEBSITE_SRC_DIR) cp -r %{doc_dir}/*.rst %{doc_dir}/relnotes %{doc_dir}/website/*.rst $(WEBSITE_SRC_DIR) sphinx-build -q -c $(SPHINX_CONFIG) -b html $(WEBSITE_SRC_DIR) $(WEBSITE_DIR) diff --git a/src/lib/algo_base/transform.h b/src/lib/algo_base/transform.h index 2eec9d85b..5e59eb80c 100644 --- a/src/lib/algo_base/transform.h +++ b/src/lib/algo_base/transform.h @@ -39,6 +39,7 @@ class BOTAN_DLL Transformation : public SymmetricAlgorithm /** * Process some data. Input must be in size update_granularity() byte blocks. * @param blocks in/out paramter which will possibly be resized + * @param offset an offset into blocks to begin processing */ virtual void update(secure_vector<byte>& blocks, size_t offset = 0) = 0; diff --git a/src/scripts/tls_suite_info.py b/src/scripts/tls_suite_info.py index 079afd569..c28ad51d2 100755 --- a/src/scripts/tls_suite_info.py +++ b/src/scripts/tls_suite_info.py @@ -150,22 +150,20 @@ def process_command_line(args): parser = optparse.OptionParser() - parser.add_option('--include-srp-aead', action='store_true', default=False, - help='add custom SRP AEAD suites') - parser.add_option('--include-ocb', action='store_true', default=False, - help='add custom OCB AEAD suites') - parser.add_option('--include-eax', action='store_true', default=False, - help='add custom EAX AEAD suites') + parser.add_option('--with-srp-aead', action='store_true', default=False, + help='add experimental SRP AEAD suites') + parser.add_option('--with-ocb', action='store_true', default=False, + help='add experimental OCB AEAD suites') + parser.add_option('--with-eax', action='store_true', default=False, + help='add experimental EAX AEAD suites') parser.add_option('--save-download', action='store_true', default=True, help='save downloaded tls-parameters.txt') - parser.add_option('--write-direct', action='store_true', default=False, - help='save output directly to lib/tls/tls_suite_info.cpp') + parser.add_option('--output', help='save output to named file instead of stdout') return parser.parse_args(args) - def main(args = None): if args is None: args = sys.argv @@ -216,7 +214,7 @@ def main(args = None): define_custom_ciphersuite('DHE_DSS_WITH_RC4_128_SHA', '0066') # Expermental things - if options.include_ocb: + if options.with_ocb: define_custom_ciphersuite('ECDHE_ECDSA_WITH_AES_128_OCB_SHA256', 'FF80') define_custom_ciphersuite('ECDHE_ECDSA_WITH_AES_256_OCB_SHA384', 'FF81') define_custom_ciphersuite('ECDHE_RSA_WITH_AES_128_OCB_SHA256', 'FF82') @@ -225,25 +223,25 @@ def main(args = None): define_custom_ciphersuite('ECDHE_PSK_WITH_AES_128_OCB_SHA256', 'FF85') define_custom_ciphersuite('ECDHE_PSK_WITH_AES_256_OCB_SHA384', 'FF86') - if options.include_eax: + if options.with_eax: define_custom_ciphersuite('ECDHE_ECDSA_WITH_AES_128_EAX_SHA256', 'FF90') define_custom_ciphersuite('ECDHE_ECDSA_WITH_AES_256_EAX_SHA384', 'FF91') define_custom_ciphersuite('ECDHE_RSA_WITH_AES_128_EAX_SHA256', 'FF92') define_custom_ciphersuite('ECDHE_RSA_WITH_AES_256_EAX_SHA384', 'FF93') - if options.include_srp_aead: + if options.with_srp_aead: define_custom_ciphersuite('SRP_SHA_WITH_AES_256_GCM_SHA384', 'FFA0') define_custom_ciphersuite('SRP_SHA_RSA_WITH_AES_256_GCM_SHA384', 'FFA1') define_custom_ciphersuite('SRP_SHA_DSS_WITH_AES_256_GCM_SHA384', 'FFA2') define_custom_ciphersuite('SRP_SHA_ECDSA_WITH_AES_256_GCM_SHA384', 'FFA3') - if options.include_ocb: + if options.with_ocb: define_custom_ciphersuite('SRP_SHA_WITH_AES_256_OCB_SHA384', 'FFA4') define_custom_ciphersuite('SRP_SHA_RSA_WITH_AES_256_OCB_SHA384', 'FFA5') define_custom_ciphersuite('SRP_SHA_DSS_WITH_AES_256_OCB_SHA384', 'FFA6') define_custom_ciphersuite('SRP_SHA_ECDSA_WITH_AES_256_OCB_SHA384', 'FFA7') - if options.include_eax: + if options.with_eax: define_custom_ciphersuite('SRP_SHA_WITH_AES_256_EAX_SHA384', 'FFA8') define_custom_ciphersuite('SRP_SHA_RSA_WITH_AES_256_EAX_SHA384', 'FFA9') define_custom_ciphersuite('SRP_SHA_DSS_WITH_AES_256_EAX_SHA384', 'FFAA') @@ -292,8 +290,8 @@ Ciphersuite Ciphersuite::by_id(u16bit suite) } """ - if options.write_direct: - out = open('lib/tls/tls_suite_info.cpp', 'w') + if options.output != None: + out = open(options.output, 'w') out.write(suite_info) out.close() else: |