EJBCAからPKCS#11でSoftHSM2にキーペアを登録してみた

# apt update -y
# apt install softhsm2 -y
取得:1 http://jp.archive.ubuntu.com/ubuntu jammy/universe amd64 softhsm2-common amd64 2.6.1-2ubuntu1 [7,168 B]
取得:2 http://jp.archive.ubuntu.com/ubuntu jammy/universe amd64 libsofthsm2 amd64 2.6.1-2ubuntu1 [268 kB]
取得:3 http://jp.archive.ubuntu.com/ubuntu jammy/universe amd64 softhsm2 amd64 2.6.1-2ubuntu1 [177 kB]
453 kB を 3秒 で取得しました (144 kB/s)
以前に未選択のパッケージ softhsm2-common を選択しています。
(データベースを読み込んでいます ... 現在 210742 個のファイルとディレクトリがインストールされています。)
.../softhsm2-common_2.6.1-2ubuntu1_amd64.deb を展開する準備をしています ...
softhsm2-common (2.6.1-2ubuntu1) を展開しています...
以前に未選択のパッケージ libsofthsm2 を選択しています。
.../libsofthsm2_2.6.1-2ubuntu1_amd64.deb を展開する準備をしています ...
libsofthsm2 (2.6.1-2ubuntu1) を展開しています...
以前に未選択のパッケージ softhsm2 を選択しています。
.../softhsm2_2.6.1-2ubuntu1_amd64.deb を展開する準備をしています ...
softhsm2 (2.6.1-2ubuntu1) を展開しています...
softhsm2-common (2.6.1-2ubuntu1) を設定しています ...

# ls -ld /var/lib/softhsm
drwxrws--- 3 root softhsm 4096  2月 11 21:24 /var/lib/softhsm

# usermod -aG softhsm wildfly

# softhsm2-util --init-token --free --label slot1
Slot 0 has a free/uninitialized token.
=== SO PIN (4-255 characters) ===
Please enter SO PIN: ********
Please reenter SO PIN: ********
=== User PIN (4-255 characters) ===
Please enter user PIN: ********
Please reenter user PIN: ********
The token has been initialized and is reassigned to slot 661497608

# softhsm2-util --show-slots
Available slots:
Slot 661497608
    Slot info:
        Description:      SoftHSM slot ID 0x276da708
        Manufacturer ID:  SoftHSM project
        Hardware version: 2.6
        Firmware version: 2.6
        Token present:    yes
    Token info:
        Manufacturer ID:  SoftHSM project
        Model:            SoftHSM v2
        Hardware version: 2.6
        Firmware version: 2.6
        Serial number:    c630b01f276da708
        Initialized:      yes
        User PIN init.:   yes
        Label:            slot1
Slot 1
    Slot info:
        Description:      SoftHSM slot ID 0x1
        Manufacturer ID:  SoftHSM project
        Hardware version: 2.6
        Firmware version: 2.6
        Token present:    yes
    Token info:
        Manufacturer ID:  SoftHSM project
        Model:            SoftHSM v2
        Hardware version: 2.6
        Firmware version: 2.6
        Serial number:
        Initialized:      no
        User PIN init.:   no
        Label:

# find /var/lib/softhsm/tokens/ -ls
 23462679      4 drwxrws---   3 root     softhsm      4096  2月 11 21:25 /var/lib/softhsm/tokens/
 23462645      4 drwx--S---   2 root     softhsm      4096  2月 11 21:25 /var/lib/softhsm/tokens/56d61a9e-6da5-b279-c630-b01f276da708
 23462683      4 -rw-------   1 root     softhsm         8  2月 11 21:32 /var/lib/softhsm/tokens/56d61a9e-6da5-b279-c630-b01f276da708/generation
 23462682      0 -rw-------   1 root     softhsm         0  2月 11 21:30 /var/lib/softhsm/tokens/56d61a9e-6da5-b279-c630-b01f276da708/token.lock
 23462647      4 -rw-------   1 root     softhsm       320  2月 11 21:30 /var/lib/softhsm/tokens/56d61a9e-6da5-b279-c630-b01f276da708/token.object

# chown -R wildfly /var/lib/softhsm/tokens

# systemctl restart wildfly

# cd /opt/ejbca/dist/clientToolBox/
# ./ejbcaClientToolBox.sh PKCS11HSMKeyTool test /usr/lib/softhsm/libsofthsm2.so TOKEN_LABEL:slot1

Testing of key: signKey
Private part:
SunPKCS11-libsofthsm2.so-slot661497608 RSA private key, 4096 bitstoken object, sensitive, unextractable)
RSA key:
  modulus: adb65f0e17d306edc3e2e2bbc92dcc200559100b7dbe4ad380c51d99290399a411804d0742009b4a2baf5e2f97483e66fb4e658b61ac55bc61ce97ef3c085b732e0a6048ceedb2ea4abdc4824d28e3b947c32308690590ff8f3eb1b3806b7431c45954506198431a9fcbb38755fad1f1e358010a7131e2ceddcaecf08ec6376b720d10c5726c3f8c0fc953c732f1c20fd8f231a143b615908c8b7adaf294fc36e41a5b201560a519457093fe9e9d941b168a0f62859fcad7b85bbe97e17f443587ed10efdb989d00fb929ce9bc1995cad7754b61e4134bf794efe7adbe4c2848688a61404bf5360d74f66d4aea9ee8d959731bdbbce0bac4378966d0567cea50a76351129ccfd817dce7003f3e08a550c057b7517fdff641995356482528174b7999b34cb4d4275ef0839517c9a6a1cbe31115d5825e0b103ddcfb051a6e4b4e5b90fc7dabad257f80bc4b48ca768fac580409ce6ef8ea1475659c20ff7d4eff1bcc426dee71215c5009aba8c5a06a8f26d2379f77eec9d5cf34fe9028335a6233c71156f725ce14a58a306105a54da763fbe18da1c01e42833a7a7f50803addd74f9ff3f3559a669e952027ddf5121ce7290691e374908fea625becf71dcdf945a0bd1a319153f44875add88e8badffedcb6d16994d72f3ef9dd2c6f11ffbd9d4a6e42d851a2dbcdae6e271f55a2b1891b828ee76777e22f0e2344b6468eac7
  public exponent: 10001
encryption provider: SunJCE version 11; decryption provider: SunPKCS11-libsofthsm2.so-slot661497608 version 11; modulus length: 4096; byte length 501. The decoded byte string is equal to the original!
2024-02-13 17:20:20,017 INFO  [com.keyfactor.util.keys.SignWithWorkingAlgorithm] Signature algorithm 'SHA1WithRSA' working for provider 'SunPKCS11-libsofthsm2.so-slot661497608 version 11'.
Signature test of key signKey: signature length 512; first byte a7; verifying true
Signings per second: 93
Decryptions per second: 96

# apt install opensc -y
# pkcs11-tool --module /usr/lib/softhsm/libsofthsm2.so --token-label slot1 --pin foo123 -O
Certificate Object; type = X.509 cert
label: signKey
subject: DN: CN=Dummy certificate created by a CESeCore application
ID: 7369676e4b6579
Private Key Object; RSA
label:
ID: 7369676e4b6579
Usage: decrypt, sign, unwrap
Access: sensitive, always sensitive, never extractable, local

# tar czf t.tar.gz /var/lib/softhsm/tokens/56d61a9e-6da5-b279-c630-b01f276da708
# scp t.tar.gz admin@xxx.xxx.xxx.xxx:~/.

# tar zxf t.tar.gz -C /
# systemctl restart wildfly

#!/usr/bin/python3
import pkcs11  # PKCS#11インターフェースを提供するモジュールをインポートします。
from pkcs11.constants import Attribute, ObjectClass  # PKCS#11の定数をインポートします。

MODULE_PATH = "/usr/lib/softhsm/libsofthsm2.so"  # SoftHSM2のライブラリへのパス
TOKEN_LABEL = "slot1"  # トークンのラベル
PIN = "********"  # PINコード


def get_all_keys(session):
    # セッション内のすべてのオブジェクトを取得
    all_objects = list(session.get_objects())

    # オブジェクトの中からキーだけを抽出
    keys = [
        obj
        for obj in all_objects
        if obj[Attribute.CLASS]
        in (ObjectClass.PRIVATE_KEY, ObjectClass.PUBLIC_KEY, ObjectClass.SECRET_KEY)
    ]

    return keys


def check_key_extractable(session):
    keys = get_all_keys(session)

    # キーペアが存在しない場合、エラーメッセージを表示
    if not keys:
        print(f"No keys found")
        return

    # 最初のキー（通常は秘密鍵）を取得
    key = keys[0]

    # CLASS, KEY_TYPE, ID, SENSITIVE, EXTRACTABLE 属性値取り出し
    try:
        key_val = key[Attribute.CLASS]
        print(f"CLASS: {key_val}")
    except AttributeError:
        print("CLASS: Attribute not available")
    try:
        key_val = key[Attribute.KEY_TYPE]
        print(f"KEY_TYPE: {key_val}")
    except AttributeError:
        print("KEY_TYPE: Attribute not available")
    try:
        key_val = key[Attribute.ID]
        key_id_str = key_val.decode("utf-8")  # Decode the bytes to a string
        print(f"ID: {key_id_str}")
    except AttributeError:
        print("ID: Attribute not available")
    try:
        key_val = key[Attribute.SENSITIVE]
        print(f"SENSITIVE: {key_val}")
    except AttributeError:
        print("SENSITIVE: Attribute not available")
    try:
        key_val = key[Attribute.EXTRACTABLE]
        print(f"EXTRACTABLE: {key_val}")
    except AttributeError:
        print("EXTRACTABLE: Attribute not available")

    # キーがエクスポート可能かどうかを確認
    if key[Attribute.EXTRACTABLE]:
        print("Key is extractable")
    else:
        print("Key is not extractable")


def main():
    lib = pkcs11.lib(MODULE_PATH)  # PKCS#11ライブラリをロード
    token = lib.get_token(token_label=TOKEN_LABEL)  # トークンを取得

    with token.open(user_pin=PIN, rw=True) as session:  # トークンを開く
        check_key_extractable(session)


if __name__ == "__main__":
    main()

# apt update -y
# apt install python3-pip -y
# pip3 install python-pkcs11
# pip3 install pycryptodome
# python3 check_pkcs11_attrs.py
CLASS: 3
KEY_TYPE: 0
ID: signKey
SENSITIVE: True
EXTRACTABLE: False
Key is not extractable

#!/usr/bin/python3
# このプログラムは、https://github.com/EverTrust/pkcs11-keyextractor/blob/master/src/main/scala/fr/itassets/p11/PKCS11KeyExtractor.scala を基にしています。

import pathlib  # ファイルパス操作のためのモジュールをインポート
import subprocess  # サブプロセスを実行するためのモジュールをインポート
import os  # OSに依存した機能を使用するためのモジュールをインポート
import struct  # バイナリデータを扱うためのモジュールをインポート

import pkcs11  # PKCS#11インターフェースを提供するモジュールをインポート
from pkcs11.mechanisms import (
    Mechanism,
    KeyType,
)  # PKCS#11のメカニズムとキータイプをインポート
from pkcs11.constants import Attribute, ObjectClass  # PKCS#11の定数をインポート
from Crypto.Cipher import AES  # AES暗号化を提供するモジュールをインポート

MODULE_PATH = "/usr/lib/softhsm/libsofthsm2.so"  # SoftHSM2のライブラリへのパスを定義
TOKEN_LABEL = "test-extract"  # トークンのラベルを定義
KEYPAIR_LABEL = "test-extract-keypair"  # キーペアのラベルを定義
PIN = "1234"  # PINコードを定義
KEK = os.urandom(16)  # 16バイトのランダムなバイト列を生成
SAMPLE_TEXT = "key extracted!\n"  # サンプルテキストを定義


def setup_softhsm():
    # SoftHSM2の設定
    softhsm_dir = pathlib.Path(
        "/tmp/test-softhsm-key-export"
    )  # SoftHSM2のディレクトリパスを定義
    softhsm_config = softhsm_dir / "softhsm2.conf"  # SoftHSM2の設定ファイルパスを定義
    token_dir = softhsm_dir / "tokens"  # トークンのディレクトリパスを定義
    os.environ["SOFTHSM2_CONF"] = str(
        softhsm_config
    )  # 環境変数にSoftHSM2の設定ファイルパスを設定
    if token_dir.exists():  # トークンディレクトリが既に存在する場合、関数を終了
        return
    token_dir.mkdir(parents=True)  # トークンディレクトリを作成
    softhsm_config.write_text(
        f"directories.tokendir = {token_dir}\n"
    )  # SoftHSM2の設定ファイルにトークンディレクトリのパスを書き込み
    subprocess.check_call(
        [
            "softhsm2-util",
            "--init-token",
            "--slot",
            "0",
            "--label",
            TOKEN_LABEL,
            "--so-pin",
            PIN,
            "--pin",
            PIN,
        ]
    )  # softhsm2-utilコマンドを使用してトークンを初期化


def destroy_test_rsa_keypair(session):
    # 既存のテストRSAキーペアを破棄
    for key in session.get_objects(
        {Attribute.LABEL: KEYPAIR_LABEL}
    ):  # ラベルがKEYPAIR_LABELのオブジェクトを取得
        key.destroy()  # キーを破棄


def encrypt_sample_text(session, exported_key):
    # サンプルテキストを暗号化し、その暗号文を復号化
    pubkey = list(session.get_objects({Attribute.LABEL: KEYPAIR_LABEL}))[
        0
    ]  # ラベルがKEYPAIR_LABELの公開鍵を取得
    sample_ciphertext = pubkey.encrypt(
        SAMPLE_TEXT
    )  # 公開鍵を使用してサンプルテキストを暗号化
    inkey = (
        "/tmp/test-softhsm-key-export/sample.der"  # エクスポートされた鍵のパスを定義
    )
    with open(inkey, "wb") as f:  # エクスポートされた鍵を書き込み
        f.write(exported_key)
    openssl = subprocess.Popen(
        [
            "openssl",
            "pkeyutl",
            "-decrypt",
            "-inkey",
            inkey,
            "-keyform",
            "DER",
            "-pkeyopt",
            "rsa_padding_mode:oaep",
        ],
        stdin=subprocess.PIPE,
    )  # opensslコマンドを使用して暗号文を復号化
    openssl.communicate(sample_ciphertext)  # 復号化した結果を出力


def generate_test_rsa_keypair(session):
    # RSAキーペアを生成
    session.generate_keypair(
        KeyType.RSA,
        512,
        mechanism=Mechanism.RSA_PKCS_KEY_PAIR_GEN,
        label=KEYPAIR_LABEL,
        store=True,
        public_template={},
        private_template={
            Attribute.SENSITIVE: False,
            Attribute.EXTRACTABLE: True,
        },
    )  # PKCS#11セッションを使用してRSAキーペアを生成。このキーペアは、後でエクスポートされる。


# Implementation of rfc5649. This doesn't account for the case of ciphertext
# with 2 blocks (since we are using it to export RSA private keys). While
def unwrap_key(kek, ciphertext):
    # RFC5649に基づいてキーをアンラップ。この実装は、2ブロックの暗号文のケースを考慮していない。
    # AES ECBの6ステップを使用
    decrypt = AES.new(kek, AES.MODE_ECB).decrypt
    steps = 6
    # 暗号文を8バイトのブロックに分割
    blocks = []
    block_size = 8
    block_count = len(ciphertext) // block_size - 1
    for i in range(block_count):
        block = (i + 1) * block_size
        blocks.append(ciphertext[block : block + block_size])
    # 64ビット符号なし整数をシリアライズ/デシリアライズするためのstruct.pack形式
    ulong_be = ">Q"
    # 完全性/サイズブロック。復号化後、代替初期値（AIV）と元のプレーンテキストのサイズを含むべき。
    aiv = struct.unpack(ulong_be, ciphertext[:8])[0]
    for j in range(0, steps):
        for i in range(block_count, 0, -1):
            cipherblock = (
                struct.pack(ulong_be, aiv ^ ((5 - j) * block_count + i)) + blocks[i - 1]
            )
            block = decrypt(cipherblock)
            aiv = struct.unpack(ulong_be, block[:8])[0]
            blocks[i - 1] = block[8:]
    assert aiv & 0xFFFFFFFF00000000 == 0xA65959A600000000
    # 完全性チェックが通過。元の長さは、aivの32 LSBで指定。
    length = aiv & 0xFFFFFFFF
    plaintext_with_pad = b"".join(blocks)
    return plaintext_with_pad[:length]  # パディング付きのプレーンテキストを返す


def export_private_key(session, key):
    # 秘密鍵をエクスポート
    kek_handle = session.create_object(
        {
            Attribute.CLASS: ObjectClass.SECRET_KEY,
            Attribute.KEY_TYPE: KeyType.AES,
            Attribute.VALUE: KEK,
            Attribute.WRAP: True,
            Attribute.UNWRAP: True,
            Attribute.TOKEN: False,
        }
    )  # KEKを使用して秘密鍵をラップ
    # KEK = Key Encryption Key（キーを暗号化するキー）の略
    wrapped_key = kek_handle.wrap_key(
        key, mechanism=Mechanism.AES_KEY_WRAP_PAD
    )  # 秘密鍵をラップ
    clear_key = unwrap_key(KEK, wrapped_key)  # ラップされた鍵をアンラップ
    return clear_key  # アンラップされた鍵を返す


def main():
    setup_softhsm()  # SoftHSM2をセットアップ
    lib = pkcs11.lib(MODULE_PATH)  # PKCS#11ライブラリをロード
    token = lib.get_token(token_label=TOKEN_LABEL)  # トークンを取得

    with token.open(user_pin=PIN, rw=True) as session:  # トークンを開く
        destroy_test_rsa_keypair(session)  # テストRSAキーペアを破棄
        generate_test_rsa_keypair(session)  # テストRSAキーペアを生成
        keys = list(
            session.get_objects(
                {
                    Attribute.LABEL: KEYPAIR_LABEL,
                    Attribute.EXTRACTABLE: True,
                }
            )
        )  # エクスポート可能なキーペアを取得
        exported_key = export_private_key(session, keys[0])  # 秘密鍵をエクスポート
        encrypt_sample_text(session, exported_key)  # サンプルテキストを暗号化


if __name__ == "__main__":
    main()

# python3 pkcs11_key_export.py
The token has been initialized and is reassigned to slot 1496171450
key extracted!
# ls -l /tmp/test-softhsm-key-export/sample.der
-rw-r--r-- 1 root root 352  2月 11 18:51 /tmp/test-softhsm-key-export/sample.der