Project

General

Profile

strongSwan smart card configuration HOWTO » History » Version 142

Jean-Michel Pouré, 16.01.2010 17:49

1 77 Jean-Michel Pouré
h1. strongSwan Smartcard configuration HOWTO
2 1 Jean-Michel Pouré
3 68 Jean-Michel Pouré
{{>toc}}
4 68 Jean-Michel Pouré
5 56 Jean-Michel Pouré
!strongswan-smartcard.png!
6 67 Jean-Michel Pouré
7 110 Jean-Michel Pouré
Smartcards are a mature technology which avoid your PKIs from being stolen by a theft. 
8 81 Jean-Michel Pouré
strongSwan relies on "OpenSC":http://www.opensc-project.org to query the smartcard according to PKCS#11 RSA standard.
9 1 Jean-Michel Pouré
In this HOWTO, we give minimal information how to use a reader, initialize cards and use strongSwan.
10 1 Jean-Michel Pouré
11 138 Jean-Michel Pouré
h2. Compatible hardware
12 45 Jean-Michel Pouré
13 142 Jean-Michel Pouré
You need a USB smartcard reader and a blank smart card, preferably with support of 2048 bits RSA key.
14 78 Jean-Michel Pouré
15 92 Jean-Michel Pouré
h3. Compatible card readers
16 60 Jean-Michel Pouré
17 94 Jean-Michel Pouré
"OpenSC":http://www.opensc-project.org supports "CCID":http://www.opensc-project.org/openct/wiki/ccid compatible readers using "pcsclite":http://pcsclite.alioth.debian.org libraries. 
18 94 Jean-Michel Pouré
Recent usb readers most likely implement the CCID specification and therefore should work. 
19 86 Jean-Michel Pouré
20 88 Jean-Michel Pouré
You may refer to the "matrix of supported smartcard readers":http://pcsclite.alioth.debian.org/section.html published by pcsclite project.
21 45 Jean-Michel Pouré
22 36 Jean-Michel Pouré
These Ominikey readers are quite popular:
23 90 Jean-Michel Pouré
* Second hand Omnikey 3121 CardMan USB smartcard readers can be found on eBay for less than 10€. These are good units for testing a setup.
24 117 Jean-Michel Pouré
* Smartcard readers with an integrated PIN pad offer an increased security level because the PIN entry cannot be sniffed on the host computer e.g. by a surrepticiously installed key logger. The Omnikey 3821 secure smartcard reader with LCD display and keypad for secure PIN entry may be a good choice.
25 1 Jean-Michel Pouré
26 83 Jean-Michel Pouré
h3. Compatible smartcards
27 83 Jean-Michel Pouré
28 96 Jean-Michel Pouré
You may use blank cards with support of 1024/2048 RSA to store credentials:
29 131 Jean-Michel Pouré
* *Feitian PKI card*. The author of this HOWTO received an evaluation kit. Feitian PKI cards work great and are fully supported by OpenSC svn version.
30 118 Jean-Michel Pouré
* Cryptoflex E-Gate 32k were the best choice (but no longer available).
31 120 Jean-Michel Pouré
* STARCOS SPK 2.4 cards are compatible, but cannot be erased, therefore any error may be fatal. You may buy developer versions which can be erased.
32 1 Jean-Michel Pouré
* Siemens Card OS 4.3 B may be a good choice, but opensc does not know how to initialize them. You have to bank them using Windows software.
33 131 Jean-Michel Pouré
* ACOS5 PKI cards are cheap, but unsupported. With a little work, OpenSC could support them.
34 96 Jean-Michel Pouré
35 140 Jean-Michel Pouré
We recommend bying a smartcard with support of 2048 RSA key, as recommended by NSA.
36 140 Jean-Michel Pouré
37 127 Jean-Michel Pouré
Avoid Java cards as they may need MUSCLE framework, which is still experimental.
38 127 Jean-Michel Pouré
Read the Acknowledgements section for more information on Java cards.
39 127 Jean-Michel Pouré
40 126 Jean-Michel Pouré
A list of compatible cards is listed "here":http://www.opensc-project.org/opensc/wiki#SmartCards.
41 125 Jean-Michel Pouré
42 1 Jean-Michel Pouré
You may also use read-only, pre-personalized read-only cards:
43 91 Jean-Michel Pouré
* eID cards. Many European countries offer them and don't need to buy extra cards for VPN use.
44 1 Jean-Michel Pouré
* [fix-me] Please provide us with names of providers.
45 1 Jean-Michel Pouré
46 91 Jean-Michel Pouré
Where to buy: in Europe, you may try:
47 45 Jean-Michel Pouré
* "Cryptoshop":http://www.cryptoshop.com sells STARCOS SPK 2.3 and Siemens Card OS 4.3 B cards.
48 120 Jean-Michel Pouré
* "Smartcardfocus":http://www.smartcardfocus.com sells STARCOS SPK 2.4.
49 115 Jean-Michel Pouré
50 115 Jean-Michel Pouré
Fix-me, please provide more IT shops. We are still looking for a 10€ compatible card.
51 1 Jean-Michel Pouré
52 138 Jean-Michel Pouré
h2. Preparation
53 139 Jean-Michel Pouré
54 138 Jean-Michel Pouré
h3. Smartcard reader
55 2 Jean-Michel Pouré
56 135 Jean-Michel Pouré
To install pcsc-tools with ccid support, under Debian based distributions:
57 32 Jean-Michel Pouré
<pre>
58 134 Jean-Michel Pouré
apt-get install pcsc-tools libccid
59 132 Jean-Michel Pouré
</pre>
60 132 Jean-Michel Pouré
61 134 Jean-Michel Pouré
strongSwan supports PKCS#11 RSA standard using "opensc":http://www.opensc-project.org libraries, which specifies how to store cryptographic information on devices. 
62 1 Jean-Michel Pouré
63 134 Jean-Michel Pouré
To install "opensc":http://www.opensc-project.org:
64 134 Jean-Michel Pouré
<pre>
65 134 Jean-Michel Pouré
sudo apt-get install opensc
66 134 Jean-Michel Pouré
</pre>
67 134 Jean-Michel Pouré
68 32 Jean-Michel Pouré
Open /etc/opensc/opensc.conf.
69 32 Jean-Michel Pouré
70 7 Jean-Michel Pouré
Edit this line to use only pcsc drivers:
71 1 Jean-Michel Pouré
<pre>
72 36 Jean-Michel Pouré
reader_drivers = pcsc;
73 2 Jean-Michel Pouré
</pre>
74 3 Jean-Michel Pouré
75 134 Jean-Michel Pouré
Do not install OpenCT package, as it is incompatible with OpenSC package. OpenSC supports OpenCT protocol using shared libraries.
76 4 Jean-Michel Pouré
77 22 Jean-Michel Pouré
Check that the card reader is correctly recognized by OpenSC:
78 22 Jean-Michel Pouré
<pre>
79 22 Jean-Michel Pouré
$ opensc-tool -l
80 22 Jean-Michel Pouré
Readers known about:
81 22 Jean-Michel Pouré
Nr.    Driver     Name
82 22 Jean-Michel Pouré
0      pcsc       OmniKey CardMan 3121 00 00
83 22 Jean-Michel Pouré
</pre>
84 22 Jean-Michel Pouré
85 23 Jean-Michel Pouré
At nr. 0 we have our recognized Omnikey CardMan 3121 reader. Let's insert our smart card in the reader (note that when buying the card you'll also receive the TRANSPORT KEY. Make sure that the transport key proposed by OpenSC matches the one you got in the mail. You will destroy the card by entering the wrong Key three times):
86 23 Jean-Michel Pouré
87 23 Jean-Michel Pouré
Let's double check that the card is recongized by printing its ATR:
88 1 Jean-Michel Pouré
89 1 Jean-Michel Pouré
<pre>
90 23 Jean-Michel Pouré
$ opensc-tool -r0 -a
91 137 Jean-Michel Pouré
3b:9f:95:81:31:fe:9f:00:65:46:53:05:30:06:71:df:00:00:00:81:61:10:c6
92 23 Jean-Michel Pouré
</pre>
93 1 Jean-Michel Pouré
94 1 Jean-Michel Pouré
We can also check the name of the card with the -n switch (we can omit the -r0 since we only have one reader connected):
95 1 Jean-Michel Pouré
96 1 Jean-Michel Pouré
<pre>
97 1 Jean-Michel Pouré
$ opensc-tool -n
98 136 Jean-Michel Pouré
Using reader with a card: OmniKey CardMan 3121 00 00
99 136 Jean-Michel Pouré
entersafe
100 23 Jean-Michel Pouré
</pre>
101 23 Jean-Michel Pouré
102 136 Jean-Michel Pouré
At this point we know both the card and reader are fully recognized and functional, and we can proceed to erase the card: (You will be asked for the transport key you got in your mail)
103 136 Jean-Michel Pouré
104 136 Jean-Michel Pouré
h3. Certification Authority
105 136 Jean-Michel Pouré
106 136 Jean-Michel Pouré
We recommend using a [[CAmanagementGUIs|certificate GUI]] to set-up your CA. One important thing to keep in mind is that, you shouldn't create private keys with a length not supported by your smart card (check the specs to be sure). Keys with a maximum length is 2048 bits are known to work.
107 136 Jean-Michel Pouré
108 136 Jean-Michel Pouré
Make a backup of your keys/certificates on a CD-ROM and store it in a safe place.
109 136 Jean-Michel Pouré
110 71 Jean-Michel Pouré
h3. Configuring a smartcard with pkcsc15-init
111 71 Jean-Michel Pouré
112 71 Jean-Michel Pouré
strongSwan's smartcard solution is based on the PKCS#15 "Cryptographic Token Information Format Standard" fully supported by OpenSC library functions. Using the command
113 71 Jean-Michel Pouré
114 71 Jean-Michel Pouré
<pre>
115 71 Jean-Michel Pouré
    pkcs15-init --erase-card --create-pkcs15
116 71 Jean-Michel Pouré
</pre>
117 71 Jean-Michel Pouré
118 71 Jean-Michel Pouré
a fresh PKCS#15 file structure is created on a smartcard or cryptotoken. With the next command
119 71 Jean-Michel Pouré
120 71 Jean-Michel Pouré
<pre>
121 130 Jean-Michel Pouré
    pkcs15-init --auth-id 1 --store-pin --pin "1234" \
122 130 Jean-Michel Pouré
                --puk "4321" --label "my PIN"
123 71 Jean-Michel Pouré
</pre>
124 71 Jean-Michel Pouré
125 71 Jean-Michel Pouré
a secret PIN code with auth-id 1 is stored in an unretrievable location on the smart card. The PIN will protect the RSA signing operation. If the PIN is entered incorrectly more than three times then the smartcard will be locked and the PUK code can be used to unlock the card again.
126 71 Jean-Michel Pouré
127 71 Jean-Michel Pouré
Next the RSA private key is transferred to the smartcard
128 71 Jean-Michel Pouré
129 71 Jean-Michel Pouré
<pre>
130 71 Jean-Michel Pouré
    pkcs15-init --auth-id 1 --store-private-key myKey.pem
131 71 Jean-Michel Pouré
               [--id 45]
132 71 Jean-Michel Pouré
</pre>
133 71 Jean-Michel Pouré
134 71 Jean-Michel Pouré
By default the PKCS#15 smartcard record will be assigned the ID 45. Using the --id option, multiple key records can be stored on a smartcard.
135 71 Jean-Michel Pouré
136 71 Jean-Michel Pouré
At last we load the matching X.509 certificate onto the smartcard
137 71 Jean-Michel Pouré
138 71 Jean-Michel Pouré
<pre>
139 71 Jean-Michel Pouré
    pkcs15-init --auth-id 1 --store-certificate myCert.pem
140 71 Jean-Michel Pouré
               [--id 45]
141 71 Jean-Michel Pouré
</pre>
142 71 Jean-Michel Pouré
143 71 Jean-Michel Pouré
The pkcs15-tool can now be used to verify the contents of the smartcard.
144 71 Jean-Michel Pouré
145 71 Jean-Michel Pouré
<pre>
146 71 Jean-Michel Pouré
    pkcs15-tool --list-pins --list-keys --list-certificates
147 1 Jean-Michel Pouré
</pre>
148 1 Jean-Michel Pouré
149 66 Jean-Michel Pouré
h2. strongSwan management
150 1 Jean-Michel Pouré
151 79 Jean-Michel Pouré
h3. Configuring peers
152 66 Jean-Michel Pouré
153 65 Jean-Michel Pouré
To enable smart card support in strongSwan, you may need to compile from sources:
154 65 Jean-Michel Pouré
<pre>
155 65 Jean-Michel Pouré
./configure <add your options there> \
156 65 Jean-Michel Pouré
--enable-smartcard
157 65 Jean-Michel Pouré
make
158 1 Jean-Michel Pouré
sudo make install
159 66 Jean-Michel Pouré
</pre>
160 66 Jean-Michel Pouré
161 66 Jean-Michel Pouré
Defining a smartcard-based connection in ipsec.conf is easy:
162 66 Jean-Michel Pouré
163 66 Jean-Michel Pouré
<pre>
164 66 Jean-Michel Pouré
    conn sun
165 66 Jean-Michel Pouré
         right=192.168.0.2
166 66 Jean-Michel Pouré
         rightid=@sun.strongswan.org
167 66 Jean-Michel Pouré
         left=%defaultroute
168 66 Jean-Michel Pouré
         leftcert=%smartcard
169 66 Jean-Michel Pouré
         auto=add
170 66 Jean-Michel Pouré
</pre>
171 66 Jean-Michel Pouré
172 66 Jean-Michel Pouré
In most cases there is a single smartcard reader or cryptotoken and only one RSA private key safely stored on the crypto device. Thus usually the entry
173 66 Jean-Michel Pouré
174 66 Jean-Michel Pouré
<pre>
175 66 Jean-Michel Pouré
    leftcert=%smartcard
176 66 Jean-Michel Pouré
</pre>
177 66 Jean-Michel Pouré
178 66 Jean-Michel Pouré
which stands for the full notation
179 66 Jean-Michel Pouré
180 66 Jean-Michel Pouré
<pre>
181 66 Jean-Michel Pouré
    leftcert=%smartcard#1
182 66 Jean-Michel Pouré
</pre>
183 66 Jean-Michel Pouré
184 66 Jean-Michel Pouré
is sufficient where the first certificate/private key object enumerated by PKCS#11 module is used. If several certificate/private key objects are present then the nth object can be selected using
185 66 Jean-Michel Pouré
186 66 Jean-Michel Pouré
<pre>
187 66 Jean-Michel Pouré
    leftcert=%smartcard#<n>
188 66 Jean-Michel Pouré
</pre>
189 66 Jean-Michel Pouré
190 66 Jean-Michel Pouré
The command
191 66 Jean-Michel Pouré
192 66 Jean-Michel Pouré
<pre>
193 66 Jean-Michel Pouré
    ipsec listcards
194 66 Jean-Michel Pouré
</pre>
195 66 Jean-Michel Pouré
196 66 Jean-Michel Pouré
gives an overview over all certifcate objects made available by the PKCS#11 module. CA certificates are automatically available as trust anchors without the need to copy them into the /etc/ipsec.d/cacerts/ directory first.
197 66 Jean-Michel Pouré
198 66 Jean-Michel Pouré
As an alternative the certificate ID and/or the slot number defined by the PKCS#11 standard can be specified using the notation
199 66 Jean-Michel Pouré
200 66 Jean-Michel Pouré
<pre>
201 66 Jean-Michel Pouré
    leftcert=%smartcard<slot nr>:<key id in hex format>
202 66 Jean-Michel Pouré
</pre>
203 66 Jean-Michel Pouré
204 66 Jean-Michel Pouré
Thus
205 66 Jean-Michel Pouré
206 66 Jean-Michel Pouré
<pre>
207 66 Jean-Michel Pouré
    leftcert=%smartcard:50
208 66 Jean-Michel Pouré
</pre>
209 66 Jean-Michel Pouré
210 66 Jean-Michel Pouré
will look in all available slots for ID 0x50 starting with the first slot (usually slot 0) whereas
211 66 Jean-Michel Pouré
212 66 Jean-Michel Pouré
<pre>
213 66 Jean-Michel Pouré
    leftcert=%smartcard4:50
214 66 Jean-Michel Pouré
</pre>
215 66 Jean-Michel Pouré
216 66 Jean-Michel Pouré
will directly check slot 4 (which is usually the first slot on the second reader/token when using the OpenSC library) for a key with ID 0x50.
217 66 Jean-Michel Pouré
218 66 Jean-Michel Pouré
h3. Entering the PIN code
219 66 Jean-Michel Pouré
220 66 Jean-Michel Pouré
Since the smartcard signing operation needed to sign the hash with the RSA private key during IKE Main Mode is protected by a PIN code, the secret PIN must be made available to Pluto.
221 66 Jean-Michel Pouré
222 66 Jean-Michel Pouré
For gateways that must be able to start IPsec tunnels automatically in unattended mode after a reboot, the secret PIN can be stored statically in ipsec.secrets
223 66 Jean-Michel Pouré
224 66 Jean-Michel Pouré
<pre>
225 66 Jean-Michel Pouré
    : PIN %smartcard "12345678"
226 66 Jean-Michel Pouré
</pre>
227 66 Jean-Michel Pouré
228 66 Jean-Michel Pouré
or with the general notation
229 66 Jean-Michel Pouré
230 66 Jean-Michel Pouré
<pre>
231 66 Jean-Michel Pouré
    : PIN %smartcard<nr> "<PIN code>"
232 66 Jean-Michel Pouré
</pre>
233 66 Jean-Michel Pouré
234 66 Jean-Michel Pouré
or alternatively
235 66 Jean-Michel Pouré
236 66 Jean-Michel Pouré
<pre>
237 66 Jean-Michel Pouré
    : PIN %smartcard<slot nr>:<key id> "<PIN code>"
238 66 Jean-Michel Pouré
</pre>
239 66 Jean-Michel Pouré
240 66 Jean-Michel Pouré
On a personal notebook computer that could get stolen, you wouldn't want to store your PIN in ipsec.secrets.
241 66 Jean-Michel Pouré
242 66 Jean-Michel Pouré
Thus the alternative form
243 66 Jean-Michel Pouré
244 66 Jean-Michel Pouré
<pre>
245 66 Jean-Michel Pouré
    : PIN %smartcard %prompt
246 66 Jean-Michel Pouré
</pre>
247 66 Jean-Michel Pouré
248 66 Jean-Michel Pouré
will prompt you for the PIN when you start up the first IPsec connection using the command
249 66 Jean-Michel Pouré
250 66 Jean-Michel Pouré
<pre>
251 66 Jean-Michel Pouré
    ipsec up sun
252 66 Jean-Michel Pouré
</pre>
253 66 Jean-Michel Pouré
254 66 Jean-Michel Pouré
The ipsec up command calls the whack function which in turn communicates with Pluto over a socket. Since the whack function call is executed from a command window, Pluto can prompt you for the PIN over this socket connection. Unfortunately roadwarrior connections which just wait passively for peers cannot be initiated via the command window:
255 66 Jean-Michel Pouré
256 66 Jean-Michel Pouré
<pre>
257 66 Jean-Michel Pouré
    conn rw
258 66 Jean-Michel Pouré
         right=%any
259 66 Jean-Michel Pouré
         rightrsasigkey=%cert
260 66 Jean-Michel Pouré
         left=%defaultroute
261 66 Jean-Michel Pouré
         leftcert=%smartcard1:50
262 66 Jean-Michel Pouré
         auto=add
263 66 Jean-Michel Pouré
</pre>
264 66 Jean-Michel Pouré
265 66 Jean-Michel Pouré
But if there is a corresponding entry
266 66 Jean-Michel Pouré
267 66 Jean-Michel Pouré
<pre>
268 66 Jean-Michel Pouré
    : PIN %smartcard1:50 %prompt
269 66 Jean-Michel Pouré
</pre>
270 66 Jean-Michel Pouré
271 66 Jean-Michel Pouré
in ipsec.secrets, then the standard command
272 66 Jean-Michel Pouré
273 66 Jean-Michel Pouré
<pre>
274 66 Jean-Michel Pouré
    ipsec rereadsecrets
275 66 Jean-Michel Pouré
</pre>
276 66 Jean-Michel Pouré
277 66 Jean-Michel Pouré
or the alias
278 66 Jean-Michel Pouré
279 66 Jean-Michel Pouré
<pre>
280 66 Jean-Michel Pouré
    ipsec secrets
281 66 Jean-Michel Pouré
</pre>
282 66 Jean-Michel Pouré
283 66 Jean-Michel Pouré
can be used to enter the PIN code for this connection interactively. The command
284 66 Jean-Michel Pouré
285 66 Jean-Michel Pouré
<pre>
286 66 Jean-Michel Pouré
    ipsec listcards
287 66 Jean-Michel Pouré
</pre>
288 66 Jean-Michel Pouré
289 66 Jean-Michel Pouré
can be executed at any time to check the current status of the PIN code[s].
290 66 Jean-Michel Pouré
 
291 66 Jean-Michel Pouré
h3. PIN-pad equipped smartcard readers
292 66 Jean-Michel Pouré
293 66 Jean-Michel Pouré
Smartcard readers with an integrated PIN pad offer an increased security level because the PIN entry cannot be sniffed on the host computer e.g. by a surrepticiously installed key logger. In order to tell pluto not to prompt for the PIN on the host itself, the entry
294 66 Jean-Michel Pouré
295 66 Jean-Michel Pouré
<pre>
296 66 Jean-Michel Pouré
    : PIN %smartcard:50 %pinpad
297 66 Jean-Michel Pouré
</pre>
298 66 Jean-Michel Pouré
299 66 Jean-Michel Pouré
can be used in ipsec.secrets. Because the key pad does not cache the PIN in the smartcard reader, it must be entered for every PKCS #11 session login. By default pluto does a session logout after every RSA signature. In order to avoid the repeated entry of the PIN code during the periodic IKE main mode rekeyings, the following parameter can be set in the config setup section of ipsec.conf:
300 66 Jean-Michel Pouré
301 66 Jean-Michel Pouré
<pre>
302 66 Jean-Michel Pouré
    config setup
303 66 Jean-Michel Pouré
        pkcs11keepstate=yes
304 66 Jean-Michel Pouré
</pre>
305 66 Jean-Michel Pouré
306 65 Jean-Michel Pouré
The default setting is pkcs11keepstate=no.
307 1 Jean-Michel Pouré
308 128 Jean-Michel Pouré
h2. Acknowledgements and other resources
309 1 Jean-Michel Pouré
310 127 Jean-Michel Pouré
* This article was adapted by "Smartcard HOWTO":http://michele.pupazzo.org/docs/smart-cards-openvpn.html written by Michele Baldessari. Permission granted by Michele Baldessari to reproduce the text on strongSwan wiki. strongSwan configuration is taken from strongSwan manual.
311 127 Jean-Michel Pouré
* Bold users: some Java cards may be supported, using the Muscle experimental framework.
312 127 Jean-Michel Pouré
You may read this interesting HOWTO: "How to get smartcards or crypto-tokens running on Debian Linux and Windows":http://blog.runtux.com/2009/12/05/150