Integration#

Kapitlet beskriver processer för olika uppgifter och riktar sig till alla användargrupper.

REST-API#

NetHSM:s primära gränssnitt är ett modernt REST-API som garanterar bästa prestanda och funktionalitet. API-specifikationen finns tillgänglig i OpenAPI-format och kan inspekteras och testas i API browser.

PKCS#11#

NetHSM stöder standarden PKCS#11. Den drivrutin som krävs finns tillgänglig i repository. Repository innehåller källkod och bibliotek för olika operativsystem. I PKCS#11 guide beskrivs användningen i detalj.

Utveckling och testning#

En offentlig NetHSM-demoinstans finns tillgänglig på nethsmdemo.nitrokey.com. Den kommer att återställas var åttonde timme (CET 6:00, 14:00, 22:00). Användare ”admin”, lösenord ”adminadmin”, upplåsningslösenord ”unlockunlock”.

Alternativt kan du köra NetHSM som en Docker-behållare lokalt.

Behållaren kan utföras på följande sätt.

$ sudo docker run --rm -ti -p8443:8443 nitrokey/nethsm:testing

Detta kommer att köra NetHSM som en Unix-process inuti containern och exponera REST API på porten 8443 via HTTPS-protokollet.

Förutom att NetHSM kan köras som en Unix-process kan den även köras som en unikernel med stöd av KVM.

Behållaren kan utföras på följande sätt.

$ docker run -ti --rm -p 8443:8443 --device /dev/net/tun --device /dev/kvm --cap-add=NET_ADMIN nitrokey/nethsm:testing

Detta kommer att köra NetHSM som en unikernel inuti en KVM-virtuell maskin. Containern exponerar REST API, via HTTPS-protokollet, på gränssnittet tap200 med IP-adressen 192.168.1.100 och port 8443.

Viktigt

Behållaren använder ett självsignerat TLS-certifikat. Se till att använda rätt inställningar för anslutning för att upprätta en anslutning. Se kapitel NetHSM-introduktion för att få mer information.

Integrering i en anpassad applikation#

För att integrera NetHSM i egna anpassade applikationer finns klientbibliotek tillgängliga för nästan alla programmeringsspråk. Här finns bibliotek för Python och Rust samt denna tredjeparts Rust crate. För alla andra programmeringsspråk rekommenderar vi att du använder OpenAPI Generator.

Listan över alla tillgängliga språk kan hämtas på följande sätt.

$ docker run --rm -ti openapitools/openapi-generator-cli list -i stable

NetHSM-klienten kan genereras för ditt programmeringsspråk på följande sätt.

$ docker run --rm -ti -v "${PWD}/out:/out" openapitools/openapi-generator-cli generate -i=https://nethsmdemo.nitrokey.com/api_docs/nethsm-api.yaml -o out -g javascript

Den genererade klientkoden, i det här exemplet JavaScript, skapas i katalogen ./out/. Denna mapp innehåller också den nödvändiga dokumentationen om hur den ska användas.

Viktigt

Om Podman används för att upprätthålla SELinux kan det krävas en märkning av volymmonteringen. Läget för SELinux kan begäras med sestatus |grep "Current mode". Om läget är inställt på enforcing krävs en ändring av kontexten. I detta fall måste volymmonteringen efterfixeras med :z, vilket resulterar i -v "${PWD}/out:/out:z".