Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 88 lines (69 sloc) 3.912 kb
0cdcbdd Initial import.
Damien Stuart authored
1 This is the top-level directory for the C version of fwknop.
2
0467407 Updated README
Damien Stuart authored
3 Additional information and details can be found on the fwknop-c site at
0022ffa Added more source files. Split out libfwknop functions to a static l…
Damien Stuart authored
4 http://devmetrix.org/trac/fwknop-c.
5
55dd479 Initial Makefile and first cut at fwknop.h, the spa_random_number fun…
Damien Stuart authored
6
0467407 Updated README
Damien Stuart authored
7 INTRODUCTION
8 ============
9 This distribution will be a C-based implementation of Michael Rash's
a57baa2 @mrash minor doc updates
authored
10 Perl-based "fwknop" programs. For more information on fwknop and what
0467407 Updated README
Damien Stuart authored
11 it is all about, go to http://www.cipherdyne.org/fwknop.
1e7534d Added rijndael code, spa digest and message functions, and a shitload…
Damien Stuart authored
12
13
0467407 Updated README
Damien Stuart authored
14 CURRENT STATE
15 =============
5035cf0 Added .fwknoprc file creation and processing. This allows for saved …
Damien Stuart authored
16 At present, we have an implementation of the Firewall Knock Operator
17 library; `libfko', as well as the fwknop client and server applications.
18 The library provides the API and back-end functionality for managing the
19 Single Packet Authorization (SPA) data that the other fwknop components
20 employ. It also can be used by other programs that need SPA functonality
21 (see the `perl' directory for the FKO perl module as an example).
1e7534d Added rijndael code, spa digest and message functions, and a shitload…
Damien Stuart authored
22
5035cf0 Added .fwknoprc file creation and processing. This allows for saved …
Damien Stuart authored
23 This first version of the C implementation is planned to be compatible
24 with legacy Perl-based fwknop version 1.9.x. However, it was decided to
cab2ea9 @mrash bumped version to 2.0.1
authored
25 start the version number at 2.0 to differentiate it from the current
5035cf0 Added .fwknoprc file creation and processing. This allows for saved …
Damien Stuart authored
26 Perl implementation.
55dd479 Initial Makefile and first cut at fwknop.h, the spa_random_number fun…
Damien Stuart authored
27
28
5035cf0 Added .fwknoprc file creation and processing. This allows for saved …
Damien Stuart authored
29 BUILDING fwknop
0467407 Updated README
Damien Stuart authored
30 ===============
31 This distribution uses GNU autoconf for setting up the build. Please see
63b4da3 Mostly documentation file updates.
Damien Stuart authored
32 the `INSTALL' file for the general basics on using autoconf.
33
34 There are some "configure" options that are specific to fwknop. They are
35 (extracted from ./configure --help):
36
5035cf0 Added .fwknoprc file creation and processing. This allows for saved …
Damien Stuart authored
37 --disable-client Do not build the fwknop client component. The
38 default is to build the client.
39 --disable-server Do not build the fwknop server component. The
40 default is to build the server.
63b4da3 Mostly documentation file updates.
Damien Stuart authored
41 --with-gpgme support for gpg encryption using libgpgme
42 [default=check]
43 --with-gpgme-prefix=PFX prefix where GPGME is installed (optional)
44 --with-gpg=/path/to/gpg Specify path to the gpg executable that gpgme will
45 use [default=check path]
46 --with-iptables=/path/to/iptables
47 Specify path to the iptables executable
48 [default=check path]
49 --with-ipfw=/path/to/ipfw
50 Specify path to the ipfw executable [default=check
51 path]
52 --with-sh=/path/to/sh Specify path to the sh executable [default=check
53 path]
55dd479 Initial Makefile and first cut at fwknop.h, the spa_random_number fun…
Damien Stuart authored
54
55
5035cf0 Added .fwknoprc file creation and processing. This allows for saved …
Damien Stuart authored
56 NOTE to those who may be migrating from the Perl version of fwknop
57 ==================================================================
58 For those of you who are currently using the Perl version and plan to
59 migrate to this version, there are some things to be aware of:
60
61 - Not all of the features and functionality of the Perl-based
62 fwknop were ported to this implementation. We felt it important
63 to keep the C version as lean and lightweight as possible. Most
64 of the omitted feature/functions (like email alerts) can be
65 accomplished through other means (i.e. use an external script
66 to monitor log files and alert based on appropriate log messages).
67
68 - There are some diffences in the fwknop configuration and access
69 file directives and values. Some of these are fairly subtle. You
70 should pay careful attention to the documentation and comments in
71 those files.
72
73
0467407 Updated README
Damien Stuart authored
74 NOTE FOR DEVELOPERS
75 ===================
ac0bf15 @mrash minor wording update subversion -> git
authored
76 If you are pulling this distribution from git, you should run the
aff8832 @damienstuart Refactored configure.ac to use a custom macro for compiler flag checks.
damienstuart authored
77 "autogen.sh" script to generate the autoconf files. If you get errors about
78 missing directories or files, try running "autogen.sh" again. After that
79 you can run the "autoreconf -i" when you want to regenerate the configuration.
80 If, for some reason, autoreconf does not work for you, the "autogen.sh"
81 script should suffice.
55dd479 Initial Makefile and first cut at fwknop.h, the spa_random_number fun…
Damien Stuart authored
82
63b4da3 Mostly documentation file updates.
Damien Stuart authored
83 The fwknop and fwknopd man page nroff sources are included in their
84 respective directorys (client and server). These nroff files are derived
85 from the asciidoc sources in the 'docs' directory. See the README in docs
86 for details.
87
Something went wrong with that request. Please try again.