Need help with using SoftHSM #2248

Wellnitz-Stefan · 2024-05-14T11:58:42Z

Wellnitz-Stefan
May 14, 2024

Hi there,
I'm trying to use a SoftHSM stored Token to get a connection in "Road Warrior" scenario with moon and carol, but I'm receiving this errors on startup

00[DMN] Starting IKE charon daemon (strongSwan 6.0.0beta6, Linux 6.1.0-18-amd64, x86_64)
00[CFG] PKCS11 module '<name>' lacks library path
00[CFG] loaded PKCS#11 v2.40 library 'hsm-module' (/usr/lib/softhsm/libsofthsm2.so)
00[CFG]   SoftHSM: Implementation of PKCS11 v2.6
00[CFG]   found token in slot 'hsm-module':699290023 (SoftHSM slot ID 0x29ae51a7)
00[CFG]     my_token (SoftHSM project: SoftHSM v2)
00[CFG]   found token in slot 'hsm-module':1 (SoftHSM slot ID 0x1)
00[CFG]       (SoftHSM project: SoftHSM v2)
00[LIB] plugin 'sha1': failed to load - sha1_plugin_create not found and no plugin file available
00[LIB] providers loaded by OpenSSL: default legacy
00[CFG] install DNS servers in '/etc/resolv.conf'
00[CFG]     loaded untrusted cert 'MyCertificate'
00[CFG] opening session failed: TOKEN_NOT_RECOGNIZED
00[LIB] loaded plugins: charon pkcs11 sha3 random nonce x509 revocation constraints pubkey pkcs1 pkcs7 pgp dnskey sshkey pem openssl pkcs8 xcbc cmac kdf drbg attr kernel-netlink resolve socket-default vici updown xauth-generic
00[JOB] spawning 16 worker threads
00[DMN] executing start script 'creds' (swanctl --load-creds)
15[CFG] module 'hsm-module' does not support hot-plugging, canceled
loaded PKCS#11 v2.40 library 'hsm-module' (/usr/lib/softhsm/libsofthsm2.so)
  SoftHSM: Implementation of PKCS11 v2.6
  found token in slot 'hsm-module':699290023 (SoftHSM slot ID 0x29ae51a7)
    my_token (SoftHSM project: SoftHSM v2)
  found token in slot 'hsm-module':1 (SoftHSM slot ID 0x1)
      (SoftHSM project: SoftHSM v2)
    loaded untrusted cert 'MyCertificate'
opening session failed: TOKEN_NOT_RECOGNIZED
module 'hsm-module' does not support hot-plugging, canceled
02[CFG] loaded RSA private key from token
00[DMN] creds: loaded key tokenSofthsm from token [keyid: f5a27a20dfaf9eb4f0564b556bce691de21bb40d]
Segmentation fault (core dumped)
00[DMN] executing start script 'conns' (swanctl --load-conns)
loaded PKCS#11 v2.40 library 'hsm-module' (/usr/lib/softhsm/libsofthsm2.so)
  SoftHSM: Implementation of PKCS11 v2.6
  found token in slot 'hsm-module':699290023 (SoftHSM slot ID 0x29ae51a7)
    my_token (SoftHSM project: SoftHSM v2)
  found token in slot 'hsm-module':1 (SoftHSM slot ID 0x1)
      (SoftHSM project: SoftHSM v2)
    loaded untrusted cert 'MyCertificate'
opening session failed: TOKEN_NOT_RECOGNIZED
module 'hsm-module' does not support hot-plugging, canceled
09[CFG] added vici connection: IKEv2
09[CFG] initiating 'IKEv2'
09[IKE] initiating IKE_SA IKEv2[1] to 192.168.254.3
09[CFG] C_GenerateKeyPair() error: GENERAL_ERROR
09[ENC] generating IKE_SA_INIT request 0 [ SA KE No N(NATD_S_IP) N(NATD_D_IP) N(FRAG_SUP) N(HASH_ALG) N(REDIR_SUP) V ]
09[NET] sending packet: from 192.168.254.2[500] to 192.168.254.3[500] (1100 bytes)
13[NET] received packet: from 192.168.254.3[500] to 192.168.254.2[500] (364 bytes)
00[DMN] conns: loaded connection 'IKEv2'
00[DMN] conns: successfully loaded 1 connections, 0 unloaded
13[ENC] parsed IKE_SA_INIT response 0 [ SA KE No N(NATD_S_IP) N(NATD_D_IP) N(FRAG_SUP) N(HASH_ALG) N(CHDLESS_SUP) N(MULT_AUTH) V ]
13[IKE] received strongSwan vendor ID
13[CFG] selected proposal: IKE:AES_CBC_128/HMAC_SHA2_256_128/PRF_HMAC_SHA1/MODP_1024
Segmentation fault (core dumped)
00[DMN] executing start script 'pools' (swanctl --load-pools)
13[IKE] no private key found for 'moon.strongswan.org'
loaded PKCS#11 v2.40 library 'hsm-module' (/usr/lib/softhsm/libsofthsm2.so)
  SoftHSM: Implementation of PKCS11 v2.6
  found token in slot 'hsm-module':699290023 (SoftHSM slot ID 0x29ae51a7)
    my_token (SoftHSM project: SoftHSM v2)
  found token in slot 'hsm-module':1 (SoftHSM slot ID 0x1)
      (SoftHSM project: SoftHSM v2)
    loaded untrusted cert 'MyCertificate'
opening session failed: TOKEN_NOT_RECOGNIZED
module 'hsm-module' does not support hot-plugging, canceled
00[DMN] pools: no pools found, 0 unloaded
Segmentation fault (core dumped)
15[NET] received packet: from 192.168.254.3[500] to 192.168.254.2[500] (1100 bytes)
15[ENC] parsed IKE_SA_INIT request 0 [ SA KE No N(NATD_S_IP) N(NATD_D_IP) N(FRAG_SUP) N(HASH_ALG) N(REDIR_SUP) V ]
15[IKE] received strongSwan vendor ID
15[IKE] 192.168.254.3 is initiating an IKE_SA
15[CFG] selected proposal: IKE:AES_CBC_128/HMAC_SHA2_256_128/PRF_HMAC_SHA1/MODP_1024
15[CFG] C_GenerateKeyPair() error: GENERAL_ERROR
15[ENC] generating IKE_SA_INIT response 0 [ SA KE No N(NATD_S_IP) N(NATD_D_IP) N(FRAG_SUP) N(HASH_ALG) N(CHDLESS_SUP) N(MULT_AUTH) V ]
15[NET] sending packet: from 192.168.254.2[500] to 192.168.254.3[500] (364 bytes)
11[JOB] deleting half open IKE_SA with 192.168.254.3 after timeout

Setup

There are two docker containers (moon, carol), they are trying to connect to each other.
Ubuntu 23.10
Key and Cert are generated within the Token
Strongswan 6beta
OpenSC (current version)
SoftHSM 2.6.1

Configuration

swanctl.conf:

connections {
	IKEv2 {
		#include /etc/swanctl/conf.d/ike_sa_default.conf
		fragmentation=yes
		keyingtries=0
		#rekeyfuzz=0%
		#=.casa-strand.com
		reauth_time=0s
		rekey_time=1
		version=2
		remote_addrs=192.168.254.2
		local_addrs=192.168.254.3
		local_port=500
		remote_port=500
		vips=0.0.0.0
		proposals=aes128-sha256-prfsha1-modp1024, default
		dpd_delay=180
		#margin_time=9m
		children {
			IKEv2 {
				#include /etc/swanctl/conf.d/child_sa_default.conf
				start_action=start
				esp_proposals=aes128-sha256-modp1024, default
				remote_ts=0.0.0.0/0
				dpd_action=restart
				close_action=restart
				life_time=8h
			}
		}
		local-0 {
			auth = pubkey
			id = "[email protected]"
			certs=/etc/strongswan_certs/myCert.pem
		}
		remote-0 {
			auth = pubkey
			id = "example.com"
		}
	}
}
pools {
	pool1 {
        addrs = 192.168.10.100-192.168.255.200
        dns = 8.8.8.8
    }
}
authorities {
	myca {
		cacert=/etc/strongswan_certs/caCert.der
	}
}
secrets {
        privateKey{
                file=/etc/strongswan_certs/privateKey.der
        }
        tokenSofthsm {
             handle=4142
             slot=SLOT_ID
             module=hsm-module
             pin=2345
        }
}

Hint: SLOT_ID is replaced automatically

strongswan.conf:

charon {
  #threads = 1
  # Definiert Skripte, die beim Start von Charon ausgeführt werden. In diesem Fall werden die Befehle swanctl --load-creds, swanctl --load-conns und swanctl --load-pools ausgeführt, um Anmeldeinformationen, Verbindungen und IP-Pools zu laden.
  start-scripts {
     creds = swanctl --load-creds
     conns = swanctl --load-conns
     pools = swanctl --load-pools
  }

  #  Definiert die Log-Einstellungen für Charon. In diesem Fall wird das Standard-Log-Level auf 1 gesetzt und die Log-Nachrichten werden an stderr gesendet.
  filelog {
     stderr {
        default = 1
     }
  }
   
  send_vendor_id = yes
  prefer_configured_proposals = no
  fragment_size = 1480
  max_packet = 30000  
	load_modular = yes
  nonce_plugins = random
	plugins {
		include strongswan.d/charon/*.conf
    vici {
      load = yes
    }
    random {
      # Enable the plugin
      load = yes
    }
    sha1 {
      # Enable the plugin
      load = yes
    }
    sha3 {
      # Enable the plugin
      load = yes
    }
    socket-default {
      # Enable the plugin
      use = netkey
    }
	}
}

swanctl {
  load = pem pkcs11 x509 revocation constraints pubkey openssl random
}

include strongswan.d/*.conf


libstrongswan {
  plugins {
    pkcs11 {
      use_dh = true
      use_ecc = true
      use_pubkey = true
      
      modules {
        hsm-module {
          path = /usr/lib/softhsm/libsofthsm2.so
        }
      }
    }
  }
}

Key generation:

openssl genpkey -algorithm RSA -outform DER -out ca/caKey.der
openssl req -x509 -keyform DER -key ca/caKey.der -new -outform DER -out ca/caCert.der -days 3652 -subj "/C=CH/O=Cyber/CN=Cyber Root CA"

openssl genpkey -algorithm RSA -outform DER -out moon/privateKey.der
openssl rsa -in moon/privateKey.der -pubout -outform DER -out moon/publicKey.der
openssl req -new -key moon/privateKey.der -out moon/moonReq.csr -subj "/C=CH/O=Cyber/CN=moon.strongswan.org"
openssl x509 -req -in moon/moonReq.csr -CA ca/caCert.der -CAkey ca/caKey.der -CAcreateserial -out moon/myCert.pem -days 1461


openssl genpkey -algorithm RSA -outform DER -out carol/privateKey.der
openssl rsa -in carol/privateKey.der -pubout -outform DER -out carol/publicKey.der
openssl req -new -key carol/privateKey.der -out carol/carolReq.csr -subj "/C=CH/O=Cyber/[email protected]"
openssl x509 -req -in carol/carolReq.csr -CA ca/caCert.der -CAkey ca/caKey.der -CAcreateserial -out carol/myCert.pem -days 1461

Token setup


softhsm2-util --init-token \
              --slot 0 \
              --free \
              --label "my_token" \
              --pin 2345 \
              --so-pin 2345 \
              | cut -d ' ' -f11 > /id_file && \
\
export LD_LIBRARY_PATH=/usr/local/lib/:$LD_LIBRARY_PATH && \
\
pkcs11-tool --module /usr/lib/softhsm/libsofthsm2.so \
            -l -k \
            --key-type rsa:2048 \
            --id 4142 \
            --label "aeskey" \
            --pin 2345 \
            --usage-decrypt \
            --usage-sign \
            --extractable && \ 
\
export PKCS11_MODULE_PATH=/usr/lib/softhsm/libsofthsm2.so && \
\
openssl req \
          -new \
          -keyform engine \
          -engine pkcs11 \
          -key slot_$(cat /id_file)-id_4142 \
          -passin pass:2345 \
          -out certificate_request.csr \
          -subj "/C=DE/ST=Unknown/L=Unknown/O=MeineFirma/OU=IT/CN=example.com/[email protected]" \
          -nodes \
          -addext "keyUsage = digitalSignature, keyEncipherment" && \
          \
openssl x509 \
          -req \
          -days 365 \
          -in certificate_request.csr \
          -engine pkcs11 \
          -keyform engine \
          -key slot_$(cat /id_file)-id_4142 \
          -passin pass:2345 \
          -out certificate.crt && \
\
pkcs11-tool --module /usr/lib/softhsm/libsofthsm2.so \
            --login \
            --pin 2345 \
            --write-object certificate.crt \
            --type cert \
            --label "MyCertificate"

Hint: the slot gets replaced automatically.

I also tried some tipps from https://github.com/strongswan/strongswan/discussions/906

Please advise.

tobiasbrunner · 2024-05-14T17:20:48Z

tobiasbrunner
May 14, 2024
Maintainer

We obviously don't know more than you from those error messages. Check the log of that soft token (if it has one). And perhaps try other DH methods (stronger ones) or don't use the token for DH at all if it doesn't work.

0 replies

Wellnitz-Stefan · 2024-05-15T15:03:26Z

Wellnitz-Stefan
May 15, 2024
Author

Thank you for the quick answer,
I dropped SoftHSM for testing and established connection, but it was closed afterwards.

Moon:

00[DMN] Starting IKE charon daemon (strongSwan 6.0.0beta6, Linux 6.1.0-18-amd64, x86_64)
00[CFG] PKCS11 module '<name>' lacks library path
00[LIB] plugin 'sha1': failed to load - sha1_plugin_create not found and no plugin file available
00[LIB] plugin 'tpm': failed to load - tpm_plugin_create not found and no plugin file available
00[LIB] providers loaded by OpenSSL: legacy default
00[CFG] using '/sbin/resolvconf' to install DNS servers
00[LIB] loaded plugins: charon pkcs11 sha3 random nonce x509 revocation constraints pubkey pkcs1 pkcs7 pgp dnskey sshkey pem openssl pkcs8 xcbc cmac kdf drbg attr kernel-netlink resolve socket-default vici updown xauth-generic
00[JOB] spawning 16 worker threads
00[DMN] executing start script 'creds' (swanctl --load-creds)
07[CFG] loaded certificate 'C=CH, O=strongswan, CN=carol.strongswan.org'
13[CFG] loaded certificate 'C=CH, O=strongSwan, CN=strongSwan Root CA'
11[CFG] loaded ED25519 private key
00[DMN] creds: loaded certificate from '/etc/swanctl/x509/myCert.pem'
00[DMN] creds: loaded certificate from '/etc/swanctl/x509ca/caCert.pem'
00[DMN] creds: loaded ED25519 key from '/etc/swanctl/private/privateKey.pem'
00[DMN] executing start script 'conns' (swanctl --load-conns)
11[CFG] added vici connection: IKEv2
11[CFG] initiating 'IKEv2'
11[IKE] initiating IKE_SA IKEv2[1] to 192.168.254.2
11[ENC] generating IKE_SA_INIT request 0 [ SA KE No N(NATD_S_IP) N(NATD_D_IP) N(FRAG_SUP) N(HASH_ALG) N(REDIR_SUP) V ]
11[NET] sending packet: from 192.168.254.3[500] to 192.168.254.2[500] (1100 bytes)
00[DMN] conns: loaded connection 'IKEv2'
00[DMN] conns: successfully loaded 1 connections, 0 unloaded
00[DMN] executing start script 'pools' (swanctl --load-pools)
00[DMN] pools: no pools found, 0 unloaded
09[NET] received packet: from 192.168.254.2[500] to 192.168.254.3[500] (389 bytes)
09[ENC] parsed IKE_SA_INIT response 0 [ SA KE No N(NATD_S_IP) N(NATD_D_IP) CERTREQ N(FRAG_SUP) N(HASH_ALG) N(CHDLESS_SUP) N(MULT_AUTH) V ]
09[IKE] received strongSwan vendor ID
09[CFG] selected proposal: IKE:AES_CBC_128/HMAC_SHA2_256_128/PRF_HMAC_SHA1/MODP_1024
09[IKE] received cert request for "C=CH, O=strongSwan, CN=strongSwan Root CA"
09[IKE] sending cert request for "C=CH, O=strongSwan, CN=strongSwan Root CA"
09[IKE] authentication of 'carol.strongswan.org' (myself) with ED25519 successful
09[IKE] sending end entity cert "C=CH, O=strongswan, CN=carol.strongswan.org"
09[IKE] establishing CHILD_SA IKEv2{1}
09[ENC] generating IKE_AUTH request 1 [ IDi CERT N(INIT_CONTACT) CERTREQ IDr AUTH CPRQ(ADDR DNS) SA TSi TSr N(MOBIKE_SUP) N(NO_ADD_ADDR) N(MULT_AUTH) N(EAP_ONLY) N(MSG_ID_SYN_SUP) ]
09[NET] sending packet: from 192.168.254.3[4500] to 192.168.254.2[4500] (880 bytes)
11[NET] received packet: from 192.168.254.2[4500] to 192.168.254.3[4500] (592 bytes)
11[ENC] parsed IKE_AUTH response 1 [ IDr CERT AUTH N(MOBIKE_SUP) N(ADD_4_ADDR) N(INT_ADDR_FAIL) ]
11[IKE] received end entity cert "C=CH, O=strongswan, CN=moon.strongswan.org"
11[CFG]   using certificate "C=CH, O=strongswan, CN=moon.strongswan.org"
11[CFG]   using trusted ca certificate "C=CH, O=strongSwan, CN=strongSwan Root CA"
11[CFG]   reached self-signed root ca with a path length of 0
11[CFG] checking certificate status of "C=CH, O=strongswan, CN=moon.strongswan.org"
11[CFG] certificate status is not available
11[IKE] authentication of 'moon.strongswan.org' with ED25519 successful
11[IKE] peer supports MOBIKE
11[IKE] IKE_SA IKEv2[1] established between 192.168.254.3[carol.strongswan.org]...192.168.254.2[moon.strongswan.org]
11[IKE] scheduling rekeying in 1s
11[IKE] maximum IKE_SA lifetime 1s
11[IKE] received INTERNAL_ADDRESS_FAILURE notify, no CHILD_SA built
11[IKE] failed to establish CHILD_SA, keeping IKE_SA
01[IKE] initiating IKE_SA IKEv2[2] to 192.168.254.2
01[ENC] generating CREATE_CHILD_SA request 2 [ SA No KE ]
01[NET] sending packet: from 192.168.254.3[4500] to 192.168.254.2[4500] (1056 bytes)
05[NET] received packet: from 192.168.254.2[4500] to 192.168.254.3[4500] (304 bytes)
05[ENC] parsed CREATE_CHILD_SA response 2 [ SA No KE ]
05[CFG] selected proposal: IKE:AES_CBC_128/HMAC_SHA2_256_128/PRF_HMAC_SHA1/MODP_1024
05[IKE] scheduling rekeying in 1s
05[IKE] maximum IKE_SA lifetime 1s
05[IKE] IKE_SA IKEv2[2] rekeyed between 192.168.254.3[carol.strongswan.org]...192.168.254.2[moon.strongswan.org]
05[IKE] deleting IKE_SA IKEv2[1] between 192.168.254.3[carol.strongswan.org]...192.168.254.2[moon.strongswan.org]
05[IKE] sending DELETE for IKE_SA IKEv2[1]
15[IKE] deleting IKE_SA IKEv2[2] between 192.168.254.3[carol.strongswan.org]...192.168.254.2[moon.strongswan.org]
15[IKE] sending DELETE for IKE_SA IKEv2[2]
15[ENC] generating INFORMATIONAL request 0 [ D ]
15[NET] sending packet: from 192.168.254.3[4500] to 192.168.254.2[4500] (80 bytes)
05[ENC] generating INFORMATIONAL request 3 [ D ]
05[NET] sending packet: from 192.168.254.3[4500] to 192.168.254.2[4500] (80 bytes)
16[NET] received packet: from 192.168.254.2[4500] to 192.168.254.3[4500] (80 bytes)
04[NET] received packet: from 192.168.254.2[4500] to 192.168.254.3[4500] (80 bytes)
16[ENC] parsed INFORMATIONAL response 0 [ ]
04[ENC] parsed INFORMATIONAL response 3 [ ]
16[IKE] IKE_SA deleted
04[IKE] IKE_SA deleted

This is my swanctl.conf now:

carol

connections {
	IKEv2 {
		fragmentation=yes
		keyingtries=0
		reauth_time=0s
		rekey_time=1
		version=2
		remote_addrs=192.168.254.2
		local_addrs=192.168.254.3
		local_port=500
		remote_port=500
		vips=0.0.0.0
		proposals=aes128-sha256-prfsha1-modp1024, default
		dpd_delay=180
		children {
			IKEv2 {
				local_ts = 0.0.0.0/0
				remote_ts  = 10.1.0.0/16
				start_action = start
			}
		}
		local {
			auth = pubkey
			certs = myCert.pem
			id = carol.strongswan.org
		}
		remote {
			auth = pubkey
			id = moon.strongswan.org
		}
	}
}

authorities {
	myca {
		cacert=caCert.pem
	}
}
secrets {
	privateKey {
			file=privateKey.pem
	}
#	tokenSofthsm {
#			handle=4142
#			# SLOT_ID must be replaced!
#			slot=SLOT_ID
#			module=hsm-module
#			pin=2345
#	}
}

moon

	IKEv2 {
		fragmentation=yes
		keyingtries=0
		reauth_time=0s
		rekey_time=1d
		version=2
		remote_addrs=192.168.254.3
		local_addrs=192.168.254.2
		local_port=500
		remote_port=500
		vips=0.0.0.0
		proposals=aes128-sha256-prfsha1-modp1024, default
		dpd_delay=180
		children {
			IKEv2 {
				local_ts  = 10.1.0.0/16
				remote_ts = 0.0.0.0/0
			}
		}
		local {
			auth = pubkey
			certs = myCert.pem
			id = moon.strongswan.org
		}
		remote {
			auth = pubkey
		}
	}
}

authorities {
	myca {
		cacert=caCert.pem
	}
}
secrets {
	privateKey{
			file=privateKey.pem
	}
#	tokenSofthsm {
#			handle=4142
#			# SLOT_ID must be replaced!
#			slot=SLOT_ID
#			module=hsm-module
#			pin=2345
#	}
}

What am I missing here?

2 replies

tobiasbrunner May 16, 2024
Maintainer

What am I missing here?

 05[IKE] scheduling rekeying in 1s
 05[IKE] maximum IKE_SA lifetime 1s

👉 rekey_time=1 👈 I guess that's a typo (i.e. a missing d like you have in the other config).

Wellnitz-Stefan May 17, 2024
Author

Great finding! Thx a lot! I was able to establish and use the connection without the use of the token.

Next step will be the integration of the SoftHSM Token. I will try to use the PKCS11-Spy (https://github.com/OpenSC/OpenSC/wiki/Using-OpenSC) to Investigate / get a log.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Need help with using SoftHSM #2248

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 2 comments 2 replies

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Need help with using SoftHSM #2248

Wellnitz-Stefan May 14, 2024

Setup

Configuration

Replies: 2 comments · 2 replies

tobiasbrunner May 14, 2024 Maintainer

Wellnitz-Stefan May 15, 2024 Author

This is my swanctl.conf now:

carol

moon

tobiasbrunner May 16, 2024 Maintainer

Wellnitz-Stefan May 17, 2024 Author

Wellnitz-Stefan
May 14, 2024

Replies: 2 comments 2 replies

tobiasbrunner
May 14, 2024
Maintainer

Wellnitz-Stefan
May 15, 2024
Author

tobiasbrunner May 16, 2024
Maintainer

Wellnitz-Stefan May 17, 2024
Author