Project

General

Profile

strongSwan smart card configuration HOWTO » History » Version 138

Jean-Michel Pouré, 16.01.2010 17:46

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 109 Jean-Michel Pouré
You need a USB smartcard reader and a blank smart card.
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 127 Jean-Michel Pouré
Avoid Java cards as they may need MUSCLE framework, which is still experimental.
36 127 Jean-Michel Pouré
Read the Acknowledgements section for more information on Java cards.
37 127 Jean-Michel Pouré
38 126 Jean-Michel Pouré
A list of compatible cards is listed "here":http://www.opensc-project.org/opensc/wiki#SmartCards.
39 125 Jean-Michel Pouré
40 1 Jean-Michel Pouré
You may also use read-only, pre-personalized read-only cards:
41 91 Jean-Michel Pouré
* eID cards. Many European countries offer them and don't need to buy extra cards for VPN use.
42 1 Jean-Michel Pouré
* [fix-me] Please provide us with names of providers.
43 1 Jean-Michel Pouré
44 91 Jean-Michel Pouré
Where to buy: in Europe, you may try:
45 45 Jean-Michel Pouré
* "Cryptoshop":http://www.cryptoshop.com sells STARCOS SPK 2.3 and Siemens Card OS 4.3 B cards.
46 120 Jean-Michel Pouré
* "Smartcardfocus":http://www.smartcardfocus.com sells STARCOS SPK 2.4.
47 115 Jean-Michel Pouré
48 115 Jean-Michel Pouré
Fix-me, please provide more IT shops. We are still looking for a 10€ compatible card.
49 1 Jean-Michel Pouré
50 138 Jean-Michel Pouré
h2. Preparation
51 138 Jean-Michel Pouré
h3. Smartcard reader
52 2 Jean-Michel Pouré
53 135 Jean-Michel Pouré
To install pcsc-tools with ccid support, under Debian based distributions:
54 32 Jean-Michel Pouré
<pre>
55 134 Jean-Michel Pouré
apt-get install pcsc-tools libccid
56 132 Jean-Michel Pouré
</pre>
57 132 Jean-Michel Pouré
58 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. 
59 1 Jean-Michel Pouré
60 134 Jean-Michel Pouré
To install "opensc":http://www.opensc-project.org:
61 134 Jean-Michel Pouré
<pre>
62 134 Jean-Michel Pouré
sudo apt-get install opensc
63 134 Jean-Michel Pouré
</pre>
64 134 Jean-Michel Pouré
65 32 Jean-Michel Pouré
Open /etc/opensc/opensc.conf.
66 32 Jean-Michel Pouré
67 7 Jean-Michel Pouré
Edit this line to use only pcsc drivers:
68 1 Jean-Michel Pouré
<pre>
69 36 Jean-Michel Pouré
reader_drivers = pcsc;
70 2 Jean-Michel Pouré
</pre>
71 3 Jean-Michel Pouré
72 134 Jean-Michel Pouré
Do not install OpenCT package, as it is incompatible with OpenSC package. OpenSC supports OpenCT protocol using shared libraries.
73 4 Jean-Michel Pouré
74 22 Jean-Michel Pouré
Check that the card reader is correctly recognized by OpenSC:
75 22 Jean-Michel Pouré
<pre>
76 22 Jean-Michel Pouré
$ opensc-tool -l
77 22 Jean-Michel Pouré
Readers known about:
78 22 Jean-Michel Pouré
Nr.    Driver     Name
79 22 Jean-Michel Pouré
0      pcsc       OmniKey CardMan 3121 00 00
80 22 Jean-Michel Pouré
</pre>
81 22 Jean-Michel Pouré
82 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):
83 23 Jean-Michel Pouré
84 23 Jean-Michel Pouré
Let's double check that the card is recongized by printing its ATR:
85 1 Jean-Michel Pouré
86 1 Jean-Michel Pouré
<pre>
87 23 Jean-Michel Pouré
$ opensc-tool -r0 -a
88 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
89 23 Jean-Michel Pouré
</pre>
90 1 Jean-Michel Pouré
91 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):
92 1 Jean-Michel Pouré
93 1 Jean-Michel Pouré
<pre>
94 1 Jean-Michel Pouré
$ opensc-tool -n
95 136 Jean-Michel Pouré
Using reader with a card: OmniKey CardMan 3121 00 00
96 136 Jean-Michel Pouré
entersafe
97 23 Jean-Michel Pouré
</pre>
98 23 Jean-Michel Pouré
99 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)
100 136 Jean-Michel Pouré
101 136 Jean-Michel Pouré
h3. Certification Authority
102 136 Jean-Michel Pouré
103 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.
104 136 Jean-Michel Pouré
105 136 Jean-Michel Pouré
Make a backup of your keys/certificates on a CD-ROM and store it in a safe place.
106 136 Jean-Michel Pouré
107 136 Jean-Michel Pouré
h2. Smartcard configuration
108 23 Jean-Michel Pouré
109 71 Jean-Michel Pouré
h3. Configuring a smartcard with pkcsc15-init
110 71 Jean-Michel Pouré
111 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
112 71 Jean-Michel Pouré
113 71 Jean-Michel Pouré
<pre>
114 71 Jean-Michel Pouré
    pkcs15-init --erase-card --create-pkcs15
115 71 Jean-Michel Pouré
</pre>
116 71 Jean-Michel Pouré
117 71 Jean-Michel Pouré
a fresh PKCS#15 file structure is created on a smartcard or cryptotoken. With the next command
118 71 Jean-Michel Pouré
119 71 Jean-Michel Pouré
<pre>
120 130 Jean-Michel Pouré
    pkcs15-init --auth-id 1 --store-pin --pin "1234" \
121 130 Jean-Michel Pouré
                --puk "4321" --label "my PIN"
122 71 Jean-Michel Pouré
</pre>
123 71 Jean-Michel Pouré
124 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.
125 71 Jean-Michel Pouré
126 71 Jean-Michel Pouré
Next the RSA private key is transferred to the smartcard
127 71 Jean-Michel Pouré
128 71 Jean-Michel Pouré
<pre>
129 71 Jean-Michel Pouré
    pkcs15-init --auth-id 1 --store-private-key myKey.pem
130 71 Jean-Michel Pouré
               [--id 45]
131 71 Jean-Michel Pouré
</pre>
132 71 Jean-Michel Pouré
133 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.
134 71 Jean-Michel Pouré
135 71 Jean-Michel Pouré
At last we load the matching X.509 certificate onto the smartcard
136 71 Jean-Michel Pouré
137 71 Jean-Michel Pouré
<pre>
138 71 Jean-Michel Pouré
    pkcs15-init --auth-id 1 --store-certificate myCert.pem
139 71 Jean-Michel Pouré
               [--id 45]
140 71 Jean-Michel Pouré
</pre>
141 71 Jean-Michel Pouré
142 71 Jean-Michel Pouré
The pkcs15-tool can now be used to verify the contents of the smartcard.
143 71 Jean-Michel Pouré
144 71 Jean-Michel Pouré
<pre>
145 71 Jean-Michel Pouré
    pkcs15-tool --list-pins --list-keys --list-certificates
146 1 Jean-Michel Pouré
</pre>
147 1 Jean-Michel Pouré
148 66 Jean-Michel Pouré
h2. strongSwan management
149 1 Jean-Michel Pouré
150 79 Jean-Michel Pouré
h3. Configuring peers
151 66 Jean-Michel Pouré
152 65 Jean-Michel Pouré
To enable smart card support in strongSwan, you may need to compile from sources:
153 65 Jean-Michel Pouré
<pre>
154 65 Jean-Michel Pouré
./configure <add your options there> \
155 65 Jean-Michel Pouré
--enable-smartcard
156 65 Jean-Michel Pouré
make
157 1 Jean-Michel Pouré
sudo make install
158 66 Jean-Michel Pouré
</pre>
159 66 Jean-Michel Pouré
160 66 Jean-Michel Pouré
Defining a smartcard-based connection in ipsec.conf is easy:
161 66 Jean-Michel Pouré
162 66 Jean-Michel Pouré
<pre>
163 66 Jean-Michel Pouré
    conn sun
164 66 Jean-Michel Pouré
         right=192.168.0.2
165 66 Jean-Michel Pouré
         rightid=@sun.strongswan.org
166 66 Jean-Michel Pouré
         left=%defaultroute
167 66 Jean-Michel Pouré
         leftcert=%smartcard
168 66 Jean-Michel Pouré
         auto=add
169 66 Jean-Michel Pouré
</pre>
170 66 Jean-Michel Pouré
171 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
172 66 Jean-Michel Pouré
173 66 Jean-Michel Pouré
<pre>
174 66 Jean-Michel Pouré
    leftcert=%smartcard
175 66 Jean-Michel Pouré
</pre>
176 66 Jean-Michel Pouré
177 66 Jean-Michel Pouré
which stands for the full notation
178 66 Jean-Michel Pouré
179 66 Jean-Michel Pouré
<pre>
180 66 Jean-Michel Pouré
    leftcert=%smartcard#1
181 66 Jean-Michel Pouré
</pre>
182 66 Jean-Michel Pouré
183 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
184 66 Jean-Michel Pouré
185 66 Jean-Michel Pouré
<pre>
186 66 Jean-Michel Pouré
    leftcert=%smartcard#<n>
187 66 Jean-Michel Pouré
</pre>
188 66 Jean-Michel Pouré
189 66 Jean-Michel Pouré
The command
190 66 Jean-Michel Pouré
191 66 Jean-Michel Pouré
<pre>
192 66 Jean-Michel Pouré
    ipsec listcards
193 66 Jean-Michel Pouré
</pre>
194 66 Jean-Michel Pouré
195 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.
196 66 Jean-Michel Pouré
197 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
198 66 Jean-Michel Pouré
199 66 Jean-Michel Pouré
<pre>
200 66 Jean-Michel Pouré
    leftcert=%smartcard<slot nr>:<key id in hex format>
201 66 Jean-Michel Pouré
</pre>
202 66 Jean-Michel Pouré
203 66 Jean-Michel Pouré
Thus
204 66 Jean-Michel Pouré
205 66 Jean-Michel Pouré
<pre>
206 66 Jean-Michel Pouré
    leftcert=%smartcard:50
207 66 Jean-Michel Pouré
</pre>
208 66 Jean-Michel Pouré
209 66 Jean-Michel Pouré
will look in all available slots for ID 0x50 starting with the first slot (usually slot 0) whereas
210 66 Jean-Michel Pouré
211 66 Jean-Michel Pouré
<pre>
212 66 Jean-Michel Pouré
    leftcert=%smartcard4:50
213 66 Jean-Michel Pouré
</pre>
214 66 Jean-Michel Pouré
215 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.
216 66 Jean-Michel Pouré
217 66 Jean-Michel Pouré
h3. Entering the PIN code
218 66 Jean-Michel Pouré
219 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.
220 66 Jean-Michel Pouré
221 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
222 66 Jean-Michel Pouré
223 66 Jean-Michel Pouré
<pre>
224 66 Jean-Michel Pouré
    : PIN %smartcard "12345678"
225 66 Jean-Michel Pouré
</pre>
226 66 Jean-Michel Pouré
227 66 Jean-Michel Pouré
or with the general notation
228 66 Jean-Michel Pouré
229 66 Jean-Michel Pouré
<pre>
230 66 Jean-Michel Pouré
    : PIN %smartcard<nr> "<PIN code>"
231 66 Jean-Michel Pouré
</pre>
232 66 Jean-Michel Pouré
233 66 Jean-Michel Pouré
or alternatively
234 66 Jean-Michel Pouré
235 66 Jean-Michel Pouré
<pre>
236 66 Jean-Michel Pouré
    : PIN %smartcard<slot nr>:<key id> "<PIN code>"
237 66 Jean-Michel Pouré
</pre>
238 66 Jean-Michel Pouré
239 66 Jean-Michel Pouré
On a personal notebook computer that could get stolen, you wouldn't want to store your PIN in ipsec.secrets.
240 66 Jean-Michel Pouré
241 66 Jean-Michel Pouré
Thus the alternative form
242 66 Jean-Michel Pouré
243 66 Jean-Michel Pouré
<pre>
244 66 Jean-Michel Pouré
    : PIN %smartcard %prompt
245 66 Jean-Michel Pouré
</pre>
246 66 Jean-Michel Pouré
247 66 Jean-Michel Pouré
will prompt you for the PIN when you start up the first IPsec connection using the command
248 66 Jean-Michel Pouré
249 66 Jean-Michel Pouré
<pre>
250 66 Jean-Michel Pouré
    ipsec up sun
251 66 Jean-Michel Pouré
</pre>
252 66 Jean-Michel Pouré
253 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:
254 66 Jean-Michel Pouré
255 66 Jean-Michel Pouré
<pre>
256 66 Jean-Michel Pouré
    conn rw
257 66 Jean-Michel Pouré
         right=%any
258 66 Jean-Michel Pouré
         rightrsasigkey=%cert
259 66 Jean-Michel Pouré
         left=%defaultroute
260 66 Jean-Michel Pouré
         leftcert=%smartcard1:50
261 66 Jean-Michel Pouré
         auto=add
262 66 Jean-Michel Pouré
</pre>
263 66 Jean-Michel Pouré
264 66 Jean-Michel Pouré
But if there is a corresponding entry
265 66 Jean-Michel Pouré
266 66 Jean-Michel Pouré
<pre>
267 66 Jean-Michel Pouré
    : PIN %smartcard1:50 %prompt
268 66 Jean-Michel Pouré
</pre>
269 66 Jean-Michel Pouré
270 66 Jean-Michel Pouré
in ipsec.secrets, then the standard command
271 66 Jean-Michel Pouré
272 66 Jean-Michel Pouré
<pre>
273 66 Jean-Michel Pouré
    ipsec rereadsecrets
274 66 Jean-Michel Pouré
</pre>
275 66 Jean-Michel Pouré
276 66 Jean-Michel Pouré
or the alias
277 66 Jean-Michel Pouré
278 66 Jean-Michel Pouré
<pre>
279 66 Jean-Michel Pouré
    ipsec secrets
280 66 Jean-Michel Pouré
</pre>
281 66 Jean-Michel Pouré
282 66 Jean-Michel Pouré
can be used to enter the PIN code for this connection interactively. The command
283 66 Jean-Michel Pouré
284 66 Jean-Michel Pouré
<pre>
285 66 Jean-Michel Pouré
    ipsec listcards
286 66 Jean-Michel Pouré
</pre>
287 66 Jean-Michel Pouré
288 66 Jean-Michel Pouré
can be executed at any time to check the current status of the PIN code[s].
289 66 Jean-Michel Pouré
 
290 66 Jean-Michel Pouré
h3. PIN-pad equipped smartcard readers
291 66 Jean-Michel Pouré
292 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
293 66 Jean-Michel Pouré
294 66 Jean-Michel Pouré
<pre>
295 66 Jean-Michel Pouré
    : PIN %smartcard:50 %pinpad
296 66 Jean-Michel Pouré
</pre>
297 66 Jean-Michel Pouré
298 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:
299 66 Jean-Michel Pouré
300 66 Jean-Michel Pouré
<pre>
301 66 Jean-Michel Pouré
    config setup
302 66 Jean-Michel Pouré
        pkcs11keepstate=yes
303 66 Jean-Michel Pouré
</pre>
304 66 Jean-Michel Pouré
305 65 Jean-Michel Pouré
The default setting is pkcs11keepstate=no.
306 1 Jean-Michel Pouré
307 128 Jean-Michel Pouré
h2. Acknowledgements and other resources
308 1 Jean-Michel Pouré
309 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.
310 127 Jean-Michel Pouré
* Bold users: some Java cards may be supported, using the Muscle experimental framework.
311 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