First.
[yaz-ziffy.git] / README.old
1                                                                  -*-text-*-
2 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
3 ziffy, a promiscuous Z39.50 APDU sniffer
4
5 Copyright (c) 1998-2001 R. Carbone <rocco@ntop.org>
6
7 This file includes:
8
9     * General information
10     * Licensing
11     * Requirements
12     * Platforms
13     * Installation
14     * References
15
16 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
17
18 * General information
19
20   ziffy is a promiscuous Z39.50 APDU sniffer, like the popular tcpdump.
21   ziffy can capture and show all Z39.50 traffic on your LAN segment.
22
23   To perform its task ziffy needs at least two extra packages providing the
24   following functionalities:
25
26   (a) a portable framework for low-level network capturing facility
27   (b) BER decoding, printing and freeing routines
28
29
30   I compiled and run ziffy on my `explosive' linux intel based box with:
31
32   (a) libpcap 0.4a6 API, Copyright (c) 1993, 1994, 1995, 1996, 1997
33       by The Regents of the University of California
34
35
36   (b) X/ASN.1 Toolkit 1.0.0, Copyright (c) 1989-1998 by Finsiel S.p.A.
37   (c) YAZ Toolkit 1.7 API, Copyright (c) 1995-2001 by Index Data
38   (d) SNACC Toolkit 1.3 API, Copyright (c) 1991, 1993 by Michael Sample and UCB
39                              Copyright (c) 1994 1995 by Robert Joop and GMD Fokus
40
41
42
43 * Licensing
44
45   The ziffy program is released under the terms of the GNU GPL, read the file
46   COPYING for more information.
47
48
49 * Requirements
50
51   ziffy depends on a couple of extra packages for working properly:
52
53        - libpcap, the Packet Capture Library. It can be found at:
54
55          ftp://ftp.ee.lbl.gov/libpcap.tar.Z
56
57
58        at least one of:
59
60        - X/ASN.1 Toolkit from Finsiel S.p.A. 
61          contact us at zeta@tlcpi.finsiel.it if you need more information
62
63
64        - YAZ Toolkit, the so popular "Yet Another Z39.50 Toolkit" from Index Data.
65
66          You can find the YAZ Toolkit in:
67
68          ftp://ftp.indexdata.dk/pub/yaz/yaz-1.7.tar.gz
69
70          for more information about YAZ please visit:
71          http://www.indexdata.dk
72
73
74        - SNACC Toolkit, the "Sample Neufeld ASN.1 to C Compiler".
75
76          You can find the most recent (1.3) version of SNACC at:
77
78          ftp://ftp.fokus.gmd.de/pub/freeware/snacc/snacc-1.3.tar.gz
79
80          [
81                 old version 1.1, but commonly used, is in:
82               ftp://ftp.cs.ucb.ca/pub/local/src/snacc/snacc-1.1.tar.Z
83          ]
84
85          for more information visit SNACC home page:
86          http://www.fokus.gmd.de/ovma/freeware/snacc/entry.html
87
88
89 <PLEASE>
90        If you know of other freeware ASN.1 Toolkits, please drop me a note.
91        I will try to include them in all future versions of ziffy.
92 </PLEASE>
93
94
95
96 * Platforms
97
98   Sun Solaris 2.5.1 and/or 2.6
99   ix?86 Linux 2.0.X  (bug on it! be patient until I have time to fix it!)
100
101
102 * Installation
103
104         o To compile ziffy, you need to build and install libpcap and the
105           YAZ Toolkit or SNACC Toolkit first, or both at your choice
106
107         o Run "./configure" if you have libpcap and SNACC/YAZ Toolkit on standard 
108           places. Otherwise, to build from source distributions, run:
109
110           ./configure --with-pcap-dir=your_libpcap_location 
111               --with-yaz-dir=your_yaz_location --with-snacc-dir=your_snacc_location
112
113           "configure" will determine your system attributes and generate
114           an appropriate Makefile from Makefile.in.
115
116         o Run "make".  If everything is ok, you should have a binary
117           called "ziffy".
118
119         o Run "make install". everything will go to the right places.
120
121
122 * References
123
124   Importants RFC's you should read to fully understand what we are talking 
125   about are:
126
127  [] RFC 1729: Using the Z39.50 Information Retrieval Protocol
128               in the Internet Environment
129
130
131
132 <PLEASE>
133         Please send me patches for any modifications you need to compile,
134         install and run the program.
135 </PLEASE>