1RACOONCTL(8)              BSD System Manager's Manual             RACOONCTL(8)
2

NAME

4     racoonctl — racoon administrative control tool
5

SYNOPSIS

7     racoonctl reload-config
8     racoonctl show-schedule
9     racoonctl [-l [-l]] show-sa [isakmp|esp|ah|ipsec]
10     racoonctl flush-sa [isakmp|esp|ah|ipsec]
11     racoonctl delete-sa saopts
12     racoonctl establish-sa [-u identity] saopts
13     racoonctl vpn-connect [-u -identity] vpn_gateway
14     racoonctl vpn-disconnect vpn_gateway
15     racoonctl show-event [-l]
16     racoonctl logout-user login
17

DESCRIPTION

19     racoonctl is used to control racoon(8) operation, if ipsec-tools was con‐
20     figured with adminport support.  Communication between racoonctl and
21     racoon(8) is done through a UNIX socket.  By changing the default mode
22     and ownership of the socket, you can allow non-root users to alter
23     racoon(8) behavior, so do that with caution.
24
25     The following commands are available:
26
27     reload-config
28             This should cause racoon(8) to reload its configuration file.
29
30     show-schedule
31             Unknown command.
32
33     show-sa [isakmp|esp|ah|ipsec]
34             Dump the SA: All the SAs if no SA class is provided, or either
35             ISAKMP SAs, IPsec ESP SAs, IPsec AH SAs, or all IPsec SAs.  Use
36             -l to increase verbosity.
37
38     flush-sa [isakmp|esp|ah|ipsec]
39             is used to flush all SAs if no SA class is provided, or a class
40             of SAs, either ISAKMP SAs, IPsec ESP SAs, IPsec AH SAs, or all
41             IPsec SAs.
42
43     establish-sa [-u username] saopts
44             Establish an SA, either an ISAKMP SA, IPsec ESP SA, or IPsec AH
45             SA.  The optional -u username can be used when establishing an
46             ISAKMP SA while hybrid auth is in use.  racoonctl will prompt you
47             for the password associated with username and these credentials
48             will be used in the Xauth exchange.
49
50             saopts has the following format:
51
52             isakmp {inet|inet6} src dst
53
54             {esp|ah} {inet|inet6} src/prefixlen/port dst/prefixlen/port
55               {icmp|tcp|udp|any}
56
57     vpn-connect [-u username] vpn_gateway
58             This is a particular case of the previous command.  It will
59             establish an ISAKMP SA with vpn_gateway.
60
61     delete-sa saopts
62             Delete an SA, either an ISAKMP SA, IPsec ESP SA, or IPsec AH SA.
63
64     vpn-disconnect vpn_gateway
65             This is a particular case of the previous command.  It will kill
66             all SAs associated with vpn_gateway.
67
68     show-event [-l]
69             Dump all events reported by racoon(8), then quit.  The -l flag
70             causes racoonctl to not stop once all the events have been read,
71             but rather to loop awaiting and reporting new events.
72
73     logout-user login
74             Delete all SA established on behalf of the Xauth user login.
75
76     Command shortcuts are available:
77           rc   reload-config
78           ss   show-sa
79           sc   show-schedule
80           fs   flush-sa
81           ds   delete-sa
82           es   establish-sa
83           vc   vpn-connect
84           vd   vpn-disconnect
85           se   show-event
86           lu   logout-user
87

RETURN VALUES

89     The command should exit with 0 on success, and non-zero on errors.
90

FILES

92     /var/racoon/racoon.sock or
93     /var/run/racoon.sock            racoon(8) control socket.
94

SEE ALSO

96     ipsec(4), racoon(8)
97

HISTORY

99     Once was kmpstat in the KAME project.  It turned into racoonctl but
100     remained undocumented for a while.  Emmanuel Dreyfus <manu@NetBSD.org>
101     wrote this man page.
102
103BSD                            November 16, 2004                           BSD