Project

General

Profile

ipsec » History » Version 8

Martin Willi, 29.09.2007 17:21
added whack and stroke details to the list, reread, and purge commands

1 1 Martin Willi
= ipsec =
2 2 Martin Willi
3 2 Martin Willi
'''ipsec''' is actually an umbrella command comprising a collection of individual sub commands of the form 
4 2 Martin Willi
5 3 Martin Willi
  '''ipsec ''<command>'' [ ''<argument>'' ]  [ ''<options>'' ]'''
6 2 Martin Willi
7 2 Martin Willi
that can be used to control and monitor IPsec connections as well as the IKE daemons.
8 2 Martin Willi
9 2 Martin Willi
== Control Commands ==
10 2 Martin Willi
11 1 Martin Willi
'''ipsec start [ ''<starter options>'' ]'''
12 6 Martin Willi
   calls [wiki:IpsecStarter ipsec starter] [ ''<starter options>'' ] which in turn parses
13 6 Martin Willi
   [wiki:IpsecConf ipsec.conf] and starts the IKEv1 pluto and IKEv2 charon daemons.
14 2 Martin Willi
15 1 Martin Willi
'''ipsec stop'''
16 3 Martin Willi
   terminates all IPsec connection and stops the IKEv1 pluto and IKEv2 charon daemons by sending
17 3 Martin Willi
   a ''TERM'' signal to [wiki:IpsecStarter ipsec starter].
18 1 Martin Willi
19 1 Martin Willi
'''ipsec restart [ ''<starter options>'' ]'''
20 3 Martin Willi
   is equivalent to '''ipsec stop''' followed by '''ipsec start [ ''<starter options>'' ]''' after a
21 3 Martin Willi
   guard period of 2 seconds.
22 1 Martin Willi
   
23 1 Martin Willi
'''ipsec update'''
24 3 Martin Willi
   sends a ''HUP'' signal to [wiki:IpsecStarter ipsec starter] which in turn determines any changes
25 4 Martin Willi
   in [wiki:IpsecConf ipsec.conf] and updates the configuration on the running IKEv1 pluto and IKEv2 
26 3 Martin Willi
   charon daemons, correspondingly.
27 1 Martin Willi
28 1 Martin Willi
'''ipsec reload'''
29 3 Martin Willi
   sends a ''USR1'' signal to [wiki:IpsecStarter ipsec starter] which in turn reloads the
30 3 Martin Willi
   whole configuration on the running IKEv1 pluto and IKEv2 charon daemons based on the actual
31 3 Martin Willi
   [wiki:IpsecConf ipsec.conf].
32 1 Martin Willi
33 1 Martin Willi
'''ipsec up  ''<name>'' '''
34 4 Martin Willi
   tells the responsible IKE daemon to start up connection ''<name>''. Implemented by calling the 
35 5 Martin Willi
   [wiki:IpsecWhack ipsec whack] --name ''<name>'' --initiate and/or [wiki:IpsecStroke ipsec stroke]
36 5 Martin Willi
   up ''<name>'' commands.
37 1 Martin Willi
38 1 Martin Willi
'''ipsec down  ''<name>'' '''
39 1 Martin Willi
   tells the responsible IKE daemon to terminate connection ''<name>''. Implemented by calling the 
40 5 Martin Willi
   [wiki:IpsecWhack ipsec whack] --name ''<name>'' --terminate and/or [wiki:IpsecStroke ipsec stroke]
41 5 Martin Willi
   down ''<name>'' commands.
42 1 Martin Willi
43 1 Martin Willi
'''ipsec route  ''<name>'' '''
44 7 Martin Willi
   tells the responsible IKE daemon to insert an [wiki:IpsecPolicy IPsec policy] in the kernel for 
45 7 Martin Willi
   connection ''<name>''. The first payload packet matching the [wiki:IpsecPolicy IPsec policy]
46 7 Martin Willi
   will automatically trigger an IKE connection setup. Implemented by calling the
47 7 Martin Willi
   [wiki:IpsecWhack ipsec whack] --name ''<name>'' --route and/or
48 5 Martin Willi
   [wiki:IpsecStroke ipsec stroke] route ''<name>'' commands.
49 1 Martin Willi
50 4 Martin Willi
'''ipsec unroute  ''<name>'' '''
51 7 Martin Willi
   remove the [wiki:IpsecPolicy IPsec policy] in the kernel for connection ''<name>''. Implemented
52 7 Martin Willi
   by calling the [wiki:IpsecWhack ipsec whack] --name ''<name>'' --unroute and/or
53 7 Martin Willi
   [wiki:IpsecStroke ipsec stroke] unroute ''<name>'' commands.
54 1 Martin Willi
 
55 1 Martin Willi
'''ipsec status [ ''<name>'' ] '''
56 1 Martin Willi
   returns concise status information either on connection ''<name>'' or if the argument is lacking,
57 5 Martin Willi
   on all connections. Implemented by calling the [wiki:IpsecWhack ipsec whack] [ --name ''<name>'' ]
58 5 Martin Willi
   --status and/or [wiki:IpsecStroke ipsec stroke] status [ ''<name>'' ] commands.
59 2 Martin Willi
60 1 Martin Willi
'''ipsec statusall [ ''<name>'' ] '''
61 3 Martin Willi
   returns detailed status information either on connection ''<name>'' or if the argument is lacking,
62 5 Martin Willi
   on all connections. Implemented by calling the [wiki:IpsecWhack ipsec whack] [ --name ''<name>'' ]
63 5 Martin Willi
   statusall and/or [wiki:IpsecStroke ipsec stroke] statusall [ ''<name>'' ] commands.
64 1 Martin Willi
65 2 Martin Willi
== Info Commands ==
66 1 Martin Willi
67 1 Martin Willi
'''ipsec version'''
68 6 Martin Willi
   returns the ipsec version in the form of '''Linux strongSwan
69 6 Martin Willi
   U'''''<strongSwan userland version>'''''/K'''''<Linux kernel version>''
70 6 Martin Willi
   if strongSwan uses the native NETKEY IPsec stack of the Linux kernel it is running on.
71 6 Martin Willi
  
72 1 Martin Willi
73 1 Martin Willi
'''ipsec copyright'''
74 1 Martin Willi
   returns the copyright information.
75 1 Martin Willi
76 5 Martin Willi
'''ipsec --confdir'''
77 6 Martin Willi
   returns the ''SYSCONFDIR'' directory as defined by the [wiki:InstallationDocumentation ./configure]
78 6 Martin Willi
   options.
79 1 Martin Willi
80 2 Martin Willi
'''ipsec --directory'''
81 6 Martin Willi
   returns the ''LIBEXECDIR'' directory as defined by the [wiki:InstallationDocumentation ./configure]
82 6 Martin Willi
   options.
83 5 Martin Willi
84 1 Martin Willi
'''ipsec --help'''
85 1 Martin Willi
   returns the usage information for the ipsec command.
86 1 Martin Willi
87 5 Martin Willi
'''ipsec --versioncode'''
88 6 Martin Willi
   returns the ipsec version number in the form of
89 6 Martin Willi
   ''''U'''''<strongSwan userland version>'''''/K'''''<Linux kernel version>''
90 6 Martin Willi
   if strongSwan uses the native NETKEY IPsec stack of the Linux kernel it is running on.
91 5 Martin Willi
92 1 Martin Willi
== List Commands ==
93 1 Martin Willi
94 1 Martin Willi
'''ipsec listaacerts [ --utc ]'''
95 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listaacerts and/or
96 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listaacerts commands.
97 1 Martin Willi
98 1 Martin Willi
'''ipsec listacerts [ --utc ]'''
99 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listacerts and/or
100 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listacerts commands.
101 1 Martin Willi
102 2 Martin Willi
'''ipsec listalgs'''
103 8 Martin Willi
   returns a list of all supported IKE encryption and hash algorithms, the available Diffie-Hellman groups,
104 8 Martin Willi
   as well as all ESP encryption and authentication algorithms registered via the Linux kernel's Crypto API.
105 8 Martin Willi
   Supported by the IKEv1 pluto daemon only. Implemented by calling the [wiki:IpsecWhack ipsec whack]
106 8 Martin Willi
   --listalgs command.
107 1 Martin Willi
108 2 Martin Willi
'''ipsec listcacerts [ --utc ]'''
109 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listcacerts and/or
110 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listcacerts commands.
111 2 Martin Willi
112 1 Martin Willi
'''ipsec listcainfos [ --utc ]'''
113 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listcainfos and/or
114 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listcainfos commands.
115 1 Martin Willi
116 1 Martin Willi
'''ipsec listcards [ --utc ]'''
117 4 Martin Willi
   lists all certificates found on attached smart cards. Supported by the IKEv1 pluto daemon only.
118 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listcards command.
119 1 Martin Willi
120 2 Martin Willi
'''ipsec listcrls [ --utc ]'''
121 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listcrls and/or
122 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listcrls commands.
123 1 Martin Willi
124 1 Martin Willi
'''ipsec listcerts [ --utc ]'''
125 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listcerts and/or
126 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listcerts commands.
127 1 Martin Willi
128 1 Martin Willi
'''ipsec listgroups [ --utc ]'''
129 8 Martin Willi
   Supported by the IKEv1 pluto daemon only. Implemented by calling the [wiki:IpsecWhack ipsec whack]
130 8 Martin Willi
   --listgroups command.
131 1 Martin Willi
132 4 Martin Willi
'''ipsec listocsp [ --utc ]'''
133 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listocps and/or
134 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listocsp commands.
135 1 Martin Willi
136 1 Martin Willi
'''ipsec listocspcerts [ --utc ]'''
137 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listocspcerts and/or
138 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listocspcerts commands.
139 1 Martin Willi
140 4 Martin Willi
'''ipsec listpubkeys [ --utc ]'''
141 8 Martin Willi
   returns  a  list  of  RSA  public keys that were either loaded in raw key format or extracted from
142 8 Martin Willi
   X.509 and|or OpenPGP certificates. Supported by the IKEv1 pluto daemon only.
143 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listpubkeys command.
144 1 Martin Willi
145 1 Martin Willi
'''ipsec listall [ --utc ]'''
146 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --listall and/or
147 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] listall commands.
148 1 Martin Willi
149 2 Martin Willi
== Reread Commands ==
150 1 Martin Willi
151 1 Martin Willi
'''ipsec rereadaacerts'''
152 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --readaacerts and/or
153 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadaacerts commands.
154 4 Martin Willi
155 2 Martin Willi
'''ipsec rereadacerts'''
156 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --rereadacerts and/or
157 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadacerts commands.
158 1 Martin Willi
159 4 Martin Willi
'''ipsec rereadcacerts'''
160 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --rereadcacerts and/or
161 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadcacerts commands.
162 1 Martin Willi
163 2 Martin Willi
'''ipsec rereadcrls'''
164 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --rereadcrls and/or
165 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadcrls commands.
166 1 Martin Willi
167 1 Martin Willi
'''ipsec rereadocspcerts'''
168 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --rereadocspcerts and/or
169 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadocspcerts commands.
170 1 Martin Willi
 
171 2 Martin Willi
'''ipsec rereadsecrets'''
172 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --rereadsecrets and/or
173 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadsecrets commands.
174 2 Martin Willi
175 4 Martin Willi
'''ipsec secrets'''
176 2 Martin Willi
   is equivalent to '''ipsec rereadsecrets'''.
177 2 Martin Willi
178 1 Martin Willi
'''ipsec rereadall'''
179 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --rereadall and/or
180 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] rereadall commands.
181 4 Martin Willi
182 1 Martin Willi
== Purge Commands ==
183 1 Martin Willi
184 2 Martin Willi
'''ipsec purgeocsp'''
185 8 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] --purgeocsp and/or
186 8 Martin Willi
   [wiki:IpsecStroke ipsec stroke] purgeocsp commands.
187 2 Martin Willi
188 2 Martin Willi
== PKCS11 Proxy Commands ==
189 2 Martin Willi
190 2 Martin Willi
'''ipsec scencrypt'''
191 4 Martin Willi
   Supported by the IKEv1 pluto daemon only. Implemented by calling the [wiki:IpsecWhack ipsec whack]
192 8 Martin Willi
   --scencrypt command.
193 2 Martin Willi
194 1 Martin Willi
'''ipsec scdecrypt'''
195 4 Martin Willi
   Supported by the IKEv1 pluto daemon only. Implemented by calling the [wiki:IpsecWhack ipsec whack]
196 8 Martin Willi
   --scdecrypt command.