/[crypticl]/obol/doc/README
ViewVC logotype

Contents of /obol/doc/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations)
Sun Oct 2 14:16:10 2005 UTC (8 years, 6 months ago) by tskogan
Branch: MAIN
CVS Tags: V_0_1_1, V_0_1_2_RELEASE, V_0_1_2, HEAD
Changes since 1.2: +17 -1 lines
Describing how to run Needham-Schroeder.
1 INTRODUCTION
2 Obol is a special purpose programming language for implementing security
3 protocols of the kind used in SSL, SSH and Kerberos. This module implements
4 Obol. The implementation consists of a combined runtime and interpreter,
5 hereafter called Lobo. It is distributed under a MIT-style license (see the
6 LICENSE file).
7
8 The implementation depends on the Crypticl library, a cryptographic library
9 written in Common Lisp.
10
11
12 WEBSITE
13 http://common-lisp.net/project/crypticl/
14
15
16 INSTALL
17 The library can be loaded by loading the file "load.lisp". This file will load
18 the library and run unit tests. It requires the crypticl library to be
19 available. Change the path in "load.lisp" to point to the location of the
20 crypto library.
21
22 Lobo has been tested on Allegro 6.2 running on Windows XP. The code requires
23 Allegro and will not run on other Common Lisp distributions due to the use of
24 Allegro specific sockets and synchronization mechanisms (locks). To load and
25 test the system:
26
27 cl-user(1): (load "load.lisp")
28 cl-user(2): (in-package lobo)
29 lobo(3): (lobo)
30
31 This will start the Obol runtime. Start an Obol prompt by:
32 lobo(4): (obol)
33
34 You can load and run a whole Obol program by using load-script:
35 obol[1]>(load-script "prog/test.obol")
36
37 To test a more realistic example, try the Needham-Schroeder protocol
38 implementation found in prog/needham-schroeder-*.obol. Start a Lobo runtime
39 on three different machines, get an obol prompt by executing (obol) and
40 run the protocol step by step for each protocol actor in the three repls (one
41 Obol program for each actor A, B and S). You'll have to replace the default
42 local channel addresses by real network addresses in the Obol programs.
43 Alternatively you can run the protocol with all three actors in the same
44 Lobo runtime. This will be easier if you use the telnet server built into
45 the runtime. Open three telnet connections (default port 9023) and start a new
46 Obol script in each. Run the protocl as above.
47
48 N.B. If you run on Windows and want to use telnet from within emacs, install
49 cygwin and use cygwin's telnet.exe since Window's telnet doesn't agree with
50 emacs's telnet.el. Modify the telnet command used by emacs as described at
51 http://www.khngai.com/emacs/cygwin.php.
52
53
54 DOCUMENTATION
55 Obol and the ideas behind the language are described in a master thesis in the
56 file thesis.pdf. FOr examples of Obol code look in the prog directory.
57
58
59 CHANGELOG
60 See the file ChangeLog for the project change log.
61
62
63 CREDITS
64 Tage Stabell-Kulø (original design of Obol and more)
65 Frode V. Fjeld
66 Per Harald Myrvang (original design of Obol)
67
68
69 AUTHOR
70 Tåle Skogan tasko@frisurf.no
71
72
73

  ViewVC Help
Powered by ViewVC 1.1.5