1IPSEC_AUTO(8) Executable programs IPSEC_AUTO(8)
2
6 ipsec_auto - control automatically-keyed IPsec connections
7
9 ipsec auto [--showonly] [--asynchronous]
10 [--config configfile] [--verbose] operation connection
11 ipsec auto [--showonly] [--asynchronous]
14 [--config configfile] [--verbose] operation connection
15
18 ipsec auto { --add | --delete | --replace | --start } connection
19 ipsec auto { --up | --down } connection
21 ipsec auto { --route | --unroute | --ondemand } connection
23 ipsec auto { --status | --ready }
25 ipsec auto [--utc] [--listall | --rereadall] [--rereadsecrets]
27 [--listcerts] [--listpubkeys] [--checkpubkeys] [--listcacerts]
28 [--listcrls | --rereadcrls] [--listgroups | --rereadgroups]
29 [--purgeocsp]
30
32 Auto manipulates automatically-keyed Libreswan IPsec connections,
33 setting them up and shutting them down based on the information in the
34 IPsec configuration file. In the normal usage, connection is the name
35 of a connection specification in the configuration file; operation is
36 --add, --delete, --replace, --start, --up, --down, --route, --unroute,
37 or --ondemand. The --ready, --rereadsecrets, --rereadgroups, and
38 --statusoperations do not take a connection name. Auto generates
39 suitable commands and feeds them to a shell for execution.
40 The --add operation adds a connection specification to the internal
42 database within pluto; it will fail if pluto already has a
43 specification by that name. The --delete operation deletes a connection
44 specification from pluto's internal database (also tearing down any
45 connections based on it); The --replace operation is equivalent to
46 --delete (if there is already a loaded connection by the given name)
47 followed by --add, and is a convenience for updating pluto's internal
48 specification to match an external one. (Note that a --rereadsecrets
49 may also be needed.) The --start operation is equivalent to running
50 first with --add and then with --up, causing same effect as connection
51 configuration option auto=start. The --rereadgroups operation causes
52 any changes to the policy group files to take effect (this is currently
53 a synonym for --ready, but that may change). None of the other
54 operations alters the internal database.
55 The --up operation asks pluto to establish a connection based on an
57 entry in its internal database. The --down operation tells pluto to
58 tear down such a connection.
59 Normally, pluto establishes a route to the destination specified for a
61 connection as part of the --up operation. However, the route (for
62 KLIPS) and packet capture (KLIPS and NETKEY) can be established with
63 the --route operation. Until and unless an actual connection is
64 established, this discards any packets sent there, which may be
65 preferable to having them sent elsewhere based on a more general route
66 (e.g., a default route).
67 Normally, pluto's route (KLIPS) or packet capture (NETKEY) to a
69 destination remains in place when a --down operation is used to take
70 the connection down (or if connection setup, or later automatic
71 rekeying, fails). This permits establishing a new connection (perhaps
72 using a different specification; the route is altered as necessary)
73 without having a “window” in which packets might go elsewhere based on
74 a more general route. Such a route can be removed using the --unroute
75 operation (and is implicitly removed by --delete).
76 The --ondemand operation is equivalent to running first with --add and
78 then with --route, causing same effect as connection configuration
79 option auto=ondemand.
80 The --ready operation tells pluto to listen for connection-setup
82 requests from other hosts. Doing an --up operation before doing --ready
83 on both ends is futile and will not work, although this is now
84 automated as part of IPsec startup and should not normally be an issue.
85 The --status operation asks pluto for current connection status. The
87 output format is ad-hoc and likely to change.
88 The --rereadsecrets operation tells pluto to re-read the
90 /etc/ipsec.secrets secret-keys file, which it normally reads only at
91 startup time. (This is currently a synonym for --ready, but that may
92 change.)
93 The --rereadsecrets operation tells pluto to re-read the
95 /etc/ipsec.secrets secret-keys file, which it normally reads only at
96 startup time. (This is currently a synonym for --ready, but that may
97 change.)
98 The --rereadcrls operation reads all certificate revocation list (CRL)
100 files contained in the /etc/ipsec.d/crls directory and adds them to
101 pluto's list of CRLs. Note CRLs can and should be stored inside NSS
102 instead of in the /etc/ipsec.d/crls directory which will result in
103 automatic updates. This option will be obsoleted in the near future.
104 The --rereadall operation is equivalent to the execution of
106 --rereadsecrets and --rereadcrls.
107 The --listpubkeys operation lists all RSA public keys either received
109 from peers via the IKE protocol embedded in authenticated certificate
110 payloads or loaded locally using the rightcert / leftcert or rightr-
111 sasigkey / leftrsasigkey parameters in ipsec.conf(5).
112 The --listcerts operation lists all X.509 certificates loaded locally
114 using the rightcert and leftcert parameters in ipsec.conf(5). To see
115 all certificates in the NSS database, use certutil -d /etc/ipsec.d -L.
116 The --checkpubkeys operation lists all loaded X.509 certificates that
118 are about to expire or have expired.
119 The --listcacerts operation lists all X.509 CA certificates contained
121 in the NSS database.
122 The --listgroups operation lists all groups that are either used in
124 connection definitions in ipsec.conf(5) or are embedded in loaded X.509
125 attributes certificates.
126 The --listcrls operation lists all Certificate Revocation Lists (CRLs)
128 either loaded locally from the /etc/ipsec.d/crls directory or fetched
129 dynamically from an HTTP or LDAP server.
130 The --listall operation is equivalent to the execution of
132 --listpubkeys, --listcerts, --listcacerts, --listgroups, --listcrls.
133 The --purgeocsp operation displays --listall and purges the NSS OCSP
135 cache.
136 The --showonly option causes auto to show the commands it would run, on
138 standard output, and not run them.
139 The --asynchronous option, applicable only to the up operation, tells
141 pluto to attempt to establish the connection, but does not delay to
142 report results. This is especially useful to start multiple connections
143 in parallel when network links are slow.
144 The --verbose option instructs auto to pass through all output from
146 ipsec_whack(8), including log output that is normally filtered out as
147 uninteresting.
148 The --config option specifies a non-standard location for the IPsec
150 configuration file (default /etc/ipsec.conf).
151 See ipsec.conf(5) for details of the configuration file.
153
155 /etc/ipsec.conf default IPSEC configuration file
156 /etc/ipsec.d X.509 and Opportunistic Encryption files
157 /var/run/pluto/pluto.ctl Pluto command socket
158
161 ipsec.conf(5), ipsec(8), ipsec_pluto(8), ipsec_whack(8)
162
164 Originally written for the FreeS/WAN project <http://www.freeswan.org>
165 by Henry Spencer.
166
168 Although an --up operation does connection setup on both ends, --down
169 tears only one end of the connection down (although the orphaned end
170 will eventually time out).
171 There is no support for passthrough connections.
173 A connection description that uses %defaultroute for one of its nexthop
175 parameters but not the other may be falsely rejected as erroneous in
176 some circumstances.
177 The exit status of --showonly does not always reflect errors discovered
179 during processing of the request. (This is fine for human inspection,
180 but not so good for use in scripts.)
181
183 Paul Wouters
184 placeholder to suppress warning
185libreswan 02/01/2019 IPSEC_AUTO(8)