aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api.tex
Commit message (Collapse)AuthorAgeFilesLines
* Convert most of the documentation to reStructured Text, addinglloyd2011-04-041-2959/+0
| | | | | | | | | | | | | | | | | | | a makefile to build it with Sphinx (http://sphinx.pocoo.org/). Previously credits.txt listed public domain code sources; instead directly credit the authors in the relevant files and delete that file. Drop the draft FIPS 140 security policy; I can't imagine FIPS 140 validation will ever happen, and if it does, I don't want anything to do with it. Also drop the internals doc, which was so out of date (and incomplete) as to be worthless. Move the tutorials and InSiTo pdfs into old/ for the time being, until anything relevant from them can be filtered out and converted into RST.
* Remove some old scripts. Move the PGP key to a txt file. Documentlloyd2011-03-241-1/+1
| | | | adding back the keylength query functions.
* Syntax fix1.9.11lloyd2010-11-291-1/+1
|
* Remove BufferedComputation::OUTPUT_LENGTHlloyd2010-10-291-18/+24
|
* Update API doclloyd2010-10-131-2/+2
|
* Rename S2K to PBKDF, because that is by far the most common name - S2Klloyd2010-07-091-8/+8
| | | | | | | | | | | | | really is only used by OpenPGP, and largely it was named S2K here because the OpenPGP S2K was implemented years before the ones in PKCS #5. We have a typedef of PBKDF to S2K, and an inlined get_s2k that calls get_pbkdf for source compatability. There doesn't seem to be any reason to have a forward for the renamed s2k.h header - to actually use a PBKDF, you'd have to either include lookup.h and call get_s2k / get_pbkdf, or else include an algorithm-specific header and use it directly. In either case, including s2k.h is neither necessary nor sufficient.
* More API ref updateslloyd2010-06-151-196/+194
|
* Move reading list to the start, want people to see thislloyd2010-06-151-44/+46
|
* Cleanups, remove dead wordslloyd2010-06-151-191/+204
|
* Update docs WRT PKCS8/X509 funcslloyd2010-06-151-119/+90
|
* More ref manual changeslloyd2010-06-141-179/+175
|
* Some reference manual updates. Still needs a lot of work.lloyd2010-06-141-298/+97
|
* Remove FORK-256; it's obscure and has been definitively broken.lloyd2010-05-251-1/+1
| | | | | More commentary posted to the list: http://lists.randombit.net/pipermail/botan-devel/2010-May/001123.html
* Further passhash changes before release and things have to belloyd2010-02-051-1/+79
| | | | | | | | | | | | | | finalized. Move header to passhash9.h and rename the functions to be passhash9 specific ({generator,check}_passhash9) Add an algorithm identifer field. Currently only id 0 is defined, for HMAC(SHA-1), but this opens up for using HMAC(SHA-512) or HMAC(SHA-3) or CMAC(Blowfish) or whatever in the future if necessary. Increase the salt size to 96 bits and the PRF output size to 192 bits. Document in api.tex
* Modify the S2K interface. Instead of being stateful in terms of the saltlloyd2010-02-011-44/+37
| | | | | | | | | | | and iteration count, force it to be passed to each call to derive_key. So remove current_salt, set_iterations, new_random_salt, and change_salt functions from S2K interface. Update examples and test application to match. While I was in there, change the passhash example to use 64 bit salts and 128 bit PBKDF2 outputs.
* Document rng& argument to PKCS8::load_keylloyd2009-10-131-2/+11
|
* Apply some grammatical fixes to api.tex contributed by Charles Brockmanlloyd2009-07-211-90/+90
| | | | in ticket #38
* Don't recommend SHA-1 for new applications.lloyd2009-07-081-30/+33
| | | | Also change some examples using SHA-1 to use SHA-256 instead.
* Apply a set of patches by Charles Brockman <[email protected]> fixinglloyd2009-02-111-20/+20
| | | | | | a number of bugs in the documentation, mostly typos, grammatical errors, poorly worded sentences, and idioms likely to be confusing to non-English speakers.
* Relicense api.tex from the Creative Commons Attribution-Share Alike licenselloyd2008-12-141-5/+1
| | | | | | | | | | | | to the regular BSD license Botan is distributed under. Seems silly to have the one single file under a different (and more restrictive) license than everything else. As I am the only copyright holder I believe it is within my rights to do this. The only other contributor to api.tex I can think of is Ken Perano of Sandia Labs, who sent me several patches to api.tex that fixed minor grammatical issues, but which (AFAIK (IANAL)) were too small/trivial to be copyrightable.
* s/modinfo.txt/info.txt/glloyd2008-11-301-2/+2
|
* Update the manual a bit, though really mostly this was deleting thingslloyd2008-11-171-643/+128
| | | | | | | that were inaccurate or no longer relevant. For instance the documentation on how to remove algorithms gave the painful nasty manual way that was the only method in Botan 1.6, however in 1.7/1.8 it is trivial to disable algorithms from the build using --disable-module.
* Move rng.{cpp,h} from core to rng/ topdirlloyd2008-10-261-1/+1
| | | | | | | | | | | | | | Add a new class AutoSeeded_RNG that is a RandomNumberGenerator that wraps up the logic formerly in RandomNumberGenerator::make_rng. make_rng in fact now just returns a new AutoSeeded_RNG object. AutoSeeded_RNG is a bit more convenient because - No need to use auto_ptr - No need to dereference (same syntax everywhere - it's an underestimated advantage imo) Also move the code from timer/timer_base to timer/
* Add a little more detail to RSA example. Reword some intro text.lloyd2008-09-081-29/+39
|
* Make the contents of Botan_types namespace be just using declarations,lloyd2008-06-071-1/+1
| | | | instead of introducing new typedefs.
* Remove section on pulses - removedlloyd2008-04-241-44/+0
|
* Change the copyrights in all files in the Botan tree to directly reflectlloyd2008-04-101-3/+3
| | | | | | the actual copyright holders. For rationale, see my post to botan-devel on April 9, subject 'Changing license to directly reflect contributors' (http://www.randombit.net/pipermail/botan-devel/2008-April/000527.html)
* Wrap to 80 columnslloyd2008-01-241-7/+7
|
* Remove the ability to load an external configuration file. Applicationslloyd2007-11-141-105/+0
| | | | | | | | | | | needing this functionality probably already have a preexisting configuration system that they would rather use. Also remove the documentation about this feature, and the example configuration (which was pretty out of date, anyway). RFC on this change sent to the mailing list on 11-13-2007, no responses after 24 hours. It seems quite likely this code is not in use anywhere.
* Typo (s/holdin/holding/)lloyd2007-08-011-6/+7
|
* Some minor documentation updates and grammar fixes.lloyd2007-03-061-69/+82
|
* Remove the CMS section of the documentation.lloyd2007-03-041-415/+393
| | | | | Reorganize a number of the later sections into a single section titled 'Algorithms'
* Rewrite and reorganize several of the early sections. The API documentlloyd2007-03-041-962/+985
| | | | | | | now moves directly from the intro material to Pipe/Filter, pushing the low-level API to the last half of the manual. The Pipe section also now starts with a series of simple examples that try to introduce only one or two new ideas at any one time.
* Documentation updates (Config and UI::pulse)lloyd2006-12-141-28/+34
|
* Various small updates to the API doc, mostly in the section about writinglloyd2006-10-111-126/+123
| | | | modules.
* Increment the date, since there have been some changes since Julylloyd2006-09-301-1/+1
|
* Add a basic example of using the bare block cipher object.lloyd2006-09-261-30/+48
| | | | | Make it clear early on in the library initialization section that most users need nothing more than to create an object and go.
* Update the section of the API doc that talks about library initializationlloyd2006-09-271-22/+46
|
* Some API doc updates, mostly in the first few sections. Document the newlloyd2006-07-131-49/+51
| | | | | | | initializer options and techniques, reword some things for clarity, note the availability of an SSH library, and remove the remark that accessing the global state before initialization may crash, since this is no longer the case.
* Delete trailing whitespace in some documentation files.lloyd2006-05-301-1/+1
|
* Initial checkin1.5.6lloyd2006-05-181-0/+3687
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-23 10:41:26 +0000