1*d13090a4Sangelos# $OpenBSD: README,v 1.10 2000/09/26 23:28:45 angelos Exp $ 2983e9580Sangelos 3*d13090a4SangelosThis is release 2.3 of the KeyNote trust management library reference 49186b70cSangelosimplementation (in case you are wondering, there was never an official 1.0 59186b70cSangelosrelease). 6983e9580Sangelos 79186b70cSangelosFor details on the KeyNote spec, read RFC 2704, included in this distribution 89186b70cSangelos(in the doc/ directory). 9983e9580Sangelos 109186b70cSangelosTo build the distribution, just type "./configure" and then "make" or 119186b70cSangelos"make crypt". To test the distribution, type "make test". The query should 129186b70cSangelosevaluate to "true" (look at the last line of output). To build without 139186b70cSangeloscrypto support, use "make nocrypto" instead (you still need to run 149186b70cSangelos"configure"). If you have built crypto support, "make test-sig" will run 159186b70cSangelossome more tests on the cryptographic algorithms. 16983e9580Sangelos 17805e681cSangelosA sample application is provided in sample-app.c. To build it, use 18805e681cSangelos"make test-sample". 19805e681cSangelos 20983e9580SangelosCompile tips: 21983e9580Sangelos- You need the SSLeay/OpenSSL library if you compile with crypto 22088d08c7Sangelos (default), version 0.8.1b or later. OpenSSL can be found at: 231c338448Sangelos http://www.openssl.org/ 24983e9580Sangelos 25d3eba4dbSangelosThe Makefile creates the libkeynote.a library and the keynote program. 26d3eba4dbSangelos*** Notice that the 4 programs of previous releases have been folded into one 27d3eba4dbSangelos 28df03c035SangelosThere is a man page for the library calls (keynote.3) and one for the command 29df03c035Sangelosline tool (keynote.1), in the man/ directory. There is also a man page 3004828597Sangelosabout KeyNote itself (keynote.4) and one about assertion syntax 3104828597Sangelos(keynote.5) which contain some text from the spec. 32983e9580Sangelos 33983e9580SangelosTo view them, use: 34983e9580Sangelos 35d3eba4dbSangelos nroff -mandoc keynote.1 | more 36983e9580Sangelos nroff -mandoc keynote.3 | more 37983e9580Sangelos nroff -mandoc keynote.4 | more 3804828597Sangelos nroff -mandoc keynote.5 | more 39983e9580Sangelos 40983e9580SangelosAlternatively, you can just install them in your manpath. If your 41983e9580Sangelosnroff does not support the -mandoc flag, use -man instead. For those 42983e9580Sangelossystems that do not have nroff, the text version of the man pages are 431c338448Sangelosprovided as well (the files with .cat? suffixes in the same directory). 44983e9580Sangelos 45d3eba4dbSangelosThe "keynote verify" function can be used to verify a request, given a 46983e9580Sangelosset of assertions and an environment file. The directory testsuite/ 47d3eba4dbSangeloshas some examples assertions. The "keynote keygen" function can 48d3eba4dbSangelosbe used to generate keys. The "keynote sign" and "keynote sigver" can be 49983e9580Sangelosused to sign assertions, and verify signed assertions respectively. 50983e9580Sangelos 51983e9580SangelosThe file base64.c was taken from the OpenBSD libc and was slightly 52983e9580Sangelosmodified. 53983e9580Sangelos 54983e9580SangelosRead the TODO file to see what's missing (and eventually coming). 55983e9580Sangelos 56983e9580SangelosWhen in doubt on how to use a library call (despite the man pages), 57983e9580Sangelosconsult the implementation of the various utilities. 58983e9580Sangelos 59983e9580SangelosFor any questions, comments, bug reports, praise, or anything else, 60983e9580Sangeloscontact us at keynote@research.att.com 61983e9580Sangelos 62983e9580SangelosThere is also a users mailing list at keynote-users@nsa.research.att.com 63983e9580SangelosTo subscribe, send a message to majordomo@nsa.research.att.com with the word 64983e9580Sangelos"subscribe keynote-users" (without the quotes) in the message body. 65983e9580Sangelos 66983e9580SangelosFinally, there is a web page for KeyNote at 67983e9580Sangelos http://www.cis.upenn.edu/~keynote 68983e9580Sangelos 69983e9580SangelosAngelos D. Keromytis 70