{"action":"opened","issue":{"url":"https://api.github.com/repos/randombit/botan/issues/694","repository_url":"https://api.github.com/repos/randombit/botan","labels_url":"https://api.github.com/repos/randombit/botan/issues/694/labels{/name}","comments_url":"https://api.github.com/repos/randombit/botan/issues/694/comments","events_url":"https://api.github.com/repos/randombit/botan/issues/694/events","html_url":"https://github.com/randombit/botan/issues/694","id":186139357,"number":694,"title":"Improving the handbook","user":{"login":"cordney","id":8866185,"avatar_url":"https://avatars.githubusercontent.com/u/8866185?v=3","gravatar_id":"","url":"https://api.github.com/users/cordney","html_url":"https://github.com/cordney","followers_url":"https://api.github.com/users/cordney/followers","following_url":"https://api.github.com/users/cordney/following{/other_user}","gists_url":"https://api.github.com/users/cordney/gists{/gist_id}","starred_url":"https://api.github.com/users/cordney/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cordney/subscriptions","organizations_url":"https://api.github.com/users/cordney/orgs","repos_url":"https://api.github.com/users/cordney/repos","events_url":"https://api.github.com/users/cordney/events{/privacy}","received_events_url":"https://api.github.com/users/cordney/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-10-30T14:23:53Z","updated_at":"2016-10-30T14:23:53Z","closed_at":null,"body":"We'd like to improve the handbook. It is currently partly incomplete and outdated and also missing complete topics, such as stream ciphers or PKCS#11. We'd also like to include reordering handbook pages, for example \"The Low-Level Interface\" should be moved up, probably coming right after \"Memory container\".\r\n\r\nIn general, we would like to follow the current structure of each handbook topic, which seems to be:\r\n\r\n1) Basic information on the algorithm/protocol/whatever covered, e.g., MACs\r\n2) Generic interface in Botan, e.g., `Botan::MessageAuthenticationCode`\r\n3) One chapter for each algorithm contained in Botan, e.g., CBC-MAC, CMAC, GMAC, HMAC, ...\r\n4) Example code, e.g., calculating an HMAC tag on a message and then verifying the tag\r\n\r\nI must admit I really like the [Crypto++ wiki](https://cryptopp.com/wiki/Special:AllPages), where there is a page for almost every algorithm/protocol/whatever, with example code explained and even as a downloadable zip.\r\n\r\nIn addition to the topics already covered (that need to be checked for being up-to-date with the code and more info + example code added maybe), we think the following topics would be useful:\r\n\r\n* Block Ciphers\r\n* MACs\r\n* Hash Functions\r\n* Stream Ciphers\r\n* Providers\r\n* PKCS11\r\n* The CLI\r\n* The test suite\r\n\r\nWhat do you think?"}}
{"actor":{"display_login":"cordney"}}