Project

General

Profile

ipsec » History » Version 4

Martin Willi, 29.09.2007 15:41
most commands are implemented by calls to ipsec whack and ipsec stroke

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 3 Martin Willi
   calls [wiki:IpsecStarter ipsec starter] which in turn parses [wiki:IpsecConf ipsec.conf] and starts
13 3 Martin Willi
   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 4 Martin Willi
   [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
36 1 Martin Willi
37 1 Martin Willi
'''ipsec down  ''<name>'' '''
38 4 Martin Willi
   tells the responsible IKE daemon to terminate connection ''<name>''. Implemented by calling the 
39 4 Martin Willi
   [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
40 1 Martin Willi
41 1 Martin Willi
'''ipsec route  ''<name>'' '''
42 3 Martin Willi
   tells the responsible IKE daemon to insert an IPsec policy in the kernel for connection ''<name>''.
43 1 Martin Willi
   The first payload packet matching the IPsec policy will automatically trigger an IKE connection setup.
44 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
45 2 Martin Willi
46 3 Martin Willi
'''ipsec unroute  ''<name>'' '''
47 4 Martin Willi
   remove the IPsec policy in the kernel for connection ''<name>''. Implemented by calling the 
48 4 Martin Willi
   [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
49 2 Martin Willi
 
50 3 Martin Willi
'''ipsec status [ ''<name>'' ] '''
51 1 Martin Willi
   returns concise status information either on connection ''<name>'' or if the argument is lacking,
52 4 Martin Willi
   on all connections. Implemented by calling the [wiki:IpsecWhack ipsec whack] and
53 4 Martin Willi
   [wiki:IpsecStroke ipsec stroke] commands.
54 3 Martin Willi
55 2 Martin Willi
'''ipsec statusall [ ''<name>'' ] '''
56 3 Martin Willi
   returns detailed status information either on connection ''<name>'' or if the argument is lacking,
57 4 Martin Willi
   on all connections. Implemented by calling the [wiki:IpsecWhack ipsec whack] and
58 4 Martin Willi
   [wiki:IpsecStroke ipsec stroke] commands.
59 2 Martin Willi
60 2 Martin Willi
== Info Commands ==
61 2 Martin Willi
62 2 Martin Willi
'''ipsec version'''
63 2 Martin Willi
64 2 Martin Willi
'''ipsec copyright'''
65 2 Martin Willi
66 2 Martin Willi
'''ipsec --versioncode'''
67 2 Martin Willi
68 2 Martin Willi
'''ipsec --directory'''
69 1 Martin Willi
70 2 Martin Willi
'''ipsec --confdir'''
71 2 Martin Willi
  
72 1 Martin Willi
== List Commands ==
73 1 Martin Willi
74 1 Martin Willi
'''ipsec listaacerts [ --utc ]'''
75 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
76 2 Martin Willi
77 2 Martin Willi
'''ipsec listacerts [ --utc ]'''
78 4 Martin Willi
  Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
79 2 Martin Willi
80 2 Martin Willi
'''ipsec listalgs'''
81 4 Martin Willi
   lists all registered IKE and ESP encryption and authentication algorithms as well as the supported
82 4 Martin Willi
   Diffie-Hellman groups. Supported by the IKEv1 pluto daemon only. Implemented by calling the
83 4 Martin Willi
   [wiki:IpsecWhack ipsec whack] command.
84 2 Martin Willi
85 2 Martin Willi
'''ipsec listcacerts [ --utc ]'''
86 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
87 2 Martin Willi
88 2 Martin Willi
'''ipsec listcainfos [ --utc ]'''
89 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
90 2 Martin Willi
91 2 Martin Willi
'''ipsec listcards [ --utc ]'''
92 4 Martin Willi
   lists all certificates found on attached smart cards. Supported by the IKEv1 pluto daemon only.
93 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] command.
94 2 Martin Willi
95 1 Martin Willi
'''ipsec listcrls [ --utc ]'''
96 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
97 2 Martin Willi
98 1 Martin Willi
'''ipsec listcerts [ --utc ]'''
99 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
100 1 Martin Willi
101 2 Martin Willi
'''ipsec listgroups [ --utc ]'''
102 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
103 1 Martin Willi
104 2 Martin Willi
'''ipsec listocsp [ --utc ]'''
105 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
106 2 Martin Willi
107 2 Martin Willi
'''ipsec listocspcerts [ --utc ]'''
108 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
109 2 Martin Willi
110 2 Martin Willi
'''ipsec listpubkeys [ --utc ]'''
111 4 Martin Willi
   lists the cached RSA public keys. Supported by the IKEv1 pluto daemon only. Implemented by calling the
112 4 Martin Willi
   [wiki:IpsecWhack ipsec whack] command.
113 2 Martin Willi
114 1 Martin Willi
'''ipsec listall [ --utc ]'''
115 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
116 2 Martin Willi
117 1 Martin Willi
== Reread Commands ==
118 2 Martin Willi
119 1 Martin Willi
'''ipsec rereadaacerts'''
120 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
121 2 Martin Willi
122 1 Martin Willi
'''ipsec rereadacerts'''
123 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
124 2 Martin Willi
125 2 Martin Willi
'''ipsec rereadcacerts'''
126 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
127 2 Martin Willi
128 1 Martin Willi
'''ipsec rereadcrls'''
129 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
130 2 Martin Willi
131 2 Martin Willi
'''ipsec rereadocspcerts'''
132 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
133 4 Martin Willi
 
134 2 Martin Willi
'''ipsec rereadsecrets'''
135 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
136 2 Martin Willi
137 2 Martin Willi
'''ipsec secrets'''
138 1 Martin Willi
   is equivalent to '''ipsec rereadsecrets'''.
139 1 Martin Willi
140 2 Martin Willi
'''ipsec rereadall'''
141 4 Martin Willi
  Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
142 1 Martin Willi
143 1 Martin Willi
== Purge Commands ==
144 2 Martin Willi
145 2 Martin Willi
'''ipsec purgeocsp'''
146 4 Martin Willi
   Implemented by calling the [wiki:IpsecWhack ipsec whack] and [wiki:IpsecStroke ipsec stroke] commands.
147 2 Martin Willi
148 2 Martin Willi
== PKCS11 Proxy Commands ==
149 2 Martin Willi
150 2 Martin Willi
'''ipsec scencrypt'''
151 4 Martin Willi
   Supported by the IKEv1 pluto daemon only. Implemented by calling the [wiki:IpsecWhack ipsec whack]
152 4 Martin Willi
   command.
153 2 Martin Willi
154 1 Martin Willi
'''ipsec scdecrypt'''
155 4 Martin Willi
   Supported by the IKEv1 pluto daemon only. Implemented by calling the [wiki:IpsecWhack ipsec whack]
156 4 Martin Willi
   command.