diff --git a/.github/workflows/snaptest.yml b/.github/workflows/snaptest.yml new file mode 100644 index 0000000..f9a1917 --- /dev/null +++ b/.github/workflows/snaptest.yml @@ -0,0 +1,47 @@ +name: Content snap test + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "**" ] + +jobs: + build: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v4 + - name: Install and init lxd + run: | + sudo lxd init --auto + - name: Install snapcraft + run: sudo snap install snapcraft --classic + - name: Re-ensure connectivity in LXD containers + run: | + for ipt in iptables iptables-legacy ip6tables ip6tables-legacy; do \ + sudo $ipt --flush; \ + sudo $ipt --flush -t nat; \ + sudo $ipt --delete-chain; \ + sudo $ipt --delete-chain -t nat; \ + sudo $ipt -P FORWARD ACCEPT; \ + sudo $ipt -P INPUT ACCEPT; \ + sudo $ipt -P OUTPUT ACCEPT; \ + done + sudo systemctl reload snap.lxd.daemon + - name: Build openssl-fips-java snap + run: sudo snapcraft + - name: Install openssl-fips-java snap + run: sudo snap install --dangerous ./openssl-fips-java_0.0.1_amd64.snap + - name: Build sample consumer snap + run: | + cd ${{ github.workspace }}/src/test/consumer-snap + sudo snapcraft + sudo snap install --dangerous ./kem-test_1.0_amd64.snap + cd ${{ github.workspace }} + - name: Connect snaps + run: sudo snap connect kem-test:openssl-fips-provider-jar openssl-fips-java:openssl-fips-provider-jar + - name: Run kem-test + run: kem-test + + + diff --git a/pom.xml b/pom.xml index 3cbbe83..a7fd4e8 100644 --- a/pom.xml +++ b/pom.xml @@ -114,6 +114,9 @@ test-solib + + ${skipGenerateTestResources} + diff --git a/snapcraft.yaml b/snapcraft.yaml new file mode 100644 index 0000000..47156dd --- /dev/null +++ b/snapcraft.yaml @@ -0,0 +1,29 @@ +name: openssl-fips-java +base: core22 +version: "0.0.1" +summary: OpenSSL-based Java FIPS Provider +description: | + This content-snap contains the OpenSSL Java FIPS provider JAR. + + +grade: stable +confinement: strict + +parts: + openssl-fips-provider-jar: + plugin: maven + source: . + maven-parameters: + - -DskipTests=true -DskipGenerateTestResources=true -B package --file pom.xml + build-packages: + - openjdk-21-jdk + - maven + - libssl-dev + +slots: + openssl-fips-provider-jar: + interface: content + content: openssl-fips-provider-jar + source: + read: + - $SNAP/jar diff --git a/src/main/native/c/init.c b/src/main/native/c/init.c index cf2e19d..589f6c0 100644 --- a/src/main/native/c/init.c +++ b/src/main/native/c/init.c @@ -18,6 +18,7 @@ #include #include #include +#include #include "jni.h" /* Global libctx handle. Will be initializaed in JNI_OnLoad */ @@ -64,6 +65,11 @@ OSSL_LIB_CTX* load_openssl_base_provider(const char* conf_file_path) { } int JNI_OnLoad(JavaVM* vm, void *reserved) { - global_libctx = load_openssl_fips_provider("/usr/local/ssl/openssl.cnf"); + const char *default_cnf = "/usr/local/ssl/openssl.cnf"; + char *cnf = getenv("OPENSSL_CUSTOM_CONF"); + if (cnf == NULL) { + cnf = default_cnf; + } + global_libctx = load_openssl_fips_provider(cnf); return JNI_VERSION_21; } diff --git a/src/test/consumer-snap/KEMTest.java b/src/test/consumer-snap/KEMTest.java new file mode 100644 index 0000000..8803f8b --- /dev/null +++ b/src/test/consumer-snap/KEMTest.java @@ -0,0 +1,43 @@ +import java.security.KeyPair; +import java.security.PublicKey; +import java.security.PrivateKey; +import java.util.Arrays; +import java.security.KeyPairGenerator; +import javax.crypto.KEM; +import javax.crypto.KEM.Encapsulated; +import javax.crypto.KEM.Encapsulator; +import javax.crypto.KEM.Decapsulator; +import javax.crypto.SecretKey; +import java.security.Security; + + +public class KEMTest { + public static void main(String[] args) throws Exception { + String cname = "com.canonical.openssl.provider.OpenSSLFIPSProvider"; + Security.addProvider((java.security.Provider) Class.forName(cname).newInstance()); + + KeyPairGenerator kpg = KeyPairGenerator.getInstance("RSA"); + kpg.initialize(4096); + + // Alice creates a key pair and shares the public key with Bob + KeyPair aliceKeys = kpg.generateKeyPair(); + PublicKey alicePublicKey = aliceKeys.getPublic(); + PrivateKey alicePrivateKey = aliceKeys.getPrivate(); + + // Bob generates a shared secret and wraps it using Alice's public key + KEM bobKem = KEM.getInstance("RSA", "OpenSSLFIPSProvider"); + Encapsulator encapsulator = bobKem.newEncapsulator(alicePublicKey, null, null); + int secretSize = encapsulator.secretSize(); + KEM.Encapsulated encapsulated = encapsulator.encapsulate(0, secretSize, "AES"); + SecretKey bobSecret = encapsulated.key(); + + // Bob sends the encapsulated secret to Alice + // Alice uses her RSA private key to unwrap the shared secret + KEM aliceKem = KEM.getInstance("RSA", "OpenSSLFIPSProvider"); + Decapsulator decapsulator = aliceKem.newDecapsulator(alicePrivateKey, null); + byte[] encapsulationBytes = encapsulated.encapsulation(); + SecretKey aliceSecret = decapsulator.decapsulate(encapsulationBytes, 0, encapsulationBytes.length, "AES"); + + System.out.println(aliceSecret.equals(bobSecret)); + } +} diff --git a/src/test/consumer-snap/openssl.cnf b/src/test/consumer-snap/openssl.cnf new file mode 100644 index 0000000..113dd35 --- /dev/null +++ b/src/test/consumer-snap/openssl.cnf @@ -0,0 +1,386 @@ +# +# OpenSSL example configuration file. +# See doc/man5/config.pod for more info. +# +# This is mostly being used for generation of certificate requests, +# but may be used for auto loading of providers + +# Note that you can include other files from the main configuration +# file using the .include directive. +#.include filename + +# This definition stops the following lines choking if HOME isn't +# defined. +HOME = . + + # Use this in order to automatically load providers. +openssl_conf = openssl_init + +# Comment out the next line to ignore configuration errors +config_diagnostics = 1 + +# Extra OBJECT IDENTIFIER info: +# oid_file = $ENV::HOME/.oid +oid_section = new_oids + +# To use this configuration file with the "-extfile" option of the +# "openssl x509" utility, name here the section containing the +# X.509v3 extensions to use: +# extensions = +# (Alternatively, use a configuration file that has only +# X.509v3 extensions in its main [= default] section.) + +[ new_oids ] +# We can add new OIDs in here for use by 'ca', 'req' and 'ts'. +# Add a simple OID like this: +# testoid1=1.2.3.4 +# Or use config file substitution like this: +# testoid2=${testoid1}.5.6 + +# Policies used by the TSA examples. +tsa_policy1 = 1.2.3.4.1 +tsa_policy2 = 1.2.3.4.5.6 +tsa_policy3 = 1.2.3.4.5.7 + +# For FIPS +# Optionally include a file that is generated by the OpenSSL fipsinstall +# application. This file contains configuration data required by the OpenSSL +# fips provider. It contains a named section e.g. [fips_sect] which is +# referenced from the [provider_sect] below. +# Refer to the OpenSSL security policy for more information. +.include $ENV::SNAP/usr/local/ssl/fipsmodule.cnf + +[openssl_init] +providers = provider_sect +alg_section = algorithm_sect + +# List of providers to load +[provider_sect] +# The fips section name should match the section name inside the +# included fipsmodule.cnf. +fips = fips_sect +base = base_sect + +[base_sect] +activate = 1 + +[algorithm_sect] +default_properties = fips=yes + + +#################################################################### +[ ca ] +default_ca = CA_default # The default ca section + +#################################################################### +[ CA_default ] + +dir = ./demoCA # Where everything is kept +certs = $dir/certs # Where the issued certs are kept +crl_dir = $dir/crl # Where the issued crl are kept +database = $dir/index.txt # database index file. +#unique_subject = no # Set to 'no' to allow creation of + # several certs with same subject. +new_certs_dir = $dir/newcerts # default place for new certs. + +certificate = $dir/cacert.pem # The CA certificate +serial = $dir/serial # The current serial number +crlnumber = $dir/crlnumber # the current crl number + # must be commented out to leave a V1 CRL +crl = $dir/crl.pem # The current CRL +private_key = $dir/private/cakey.pem# The private key + +x509_extensions = usr_cert # The extensions to add to the cert + +# Comment out the following two lines for the "traditional" +# (and highly broken) format. +name_opt = ca_default # Subject Name options +cert_opt = ca_default # Certificate field options + +# Extension copying option: use with caution. +# copy_extensions = copy + +# Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs +# so this is commented out by default to leave a V1 CRL. +# crlnumber must also be commented out to leave a V1 CRL. +# crl_extensions = crl_ext + +default_days = 365 # how long to certify for +default_crl_days= 30 # how long before next CRL +default_md = default # use public key default MD +preserve = no # keep passed DN ordering + +# A few difference way of specifying how similar the request should look +# For type CA, the listed attributes must be the same, and the optional +# and supplied fields are just that :-) +policy = policy_match + +# For the CA policy +[ policy_match ] +countryName = match +stateOrProvinceName = match +organizationName = match +organizationalUnitName = optional +commonName = supplied +emailAddress = optional + +# For the 'anything' policy +# At this point in time, you must list all acceptable 'object' +# types. +[ policy_anything ] +countryName = optional +stateOrProvinceName = optional +localityName = optional +organizationName = optional +organizationalUnitName = optional +commonName = supplied +emailAddress = optional + +#################################################################### +[ req ] +default_bits = 2048 +default_keyfile = privkey.pem +distinguished_name = req_distinguished_name +attributes = req_attributes +x509_extensions = v3_ca # The extensions to add to the self signed cert + +# Passwords for private keys if not present they will be prompted for +# input_password = secret +# output_password = secret + +# This sets a mask for permitted string types. There are several options. +# default: PrintableString, T61String, BMPString. +# pkix : PrintableString, BMPString (PKIX recommendation before 2004) +# utf8only: only UTF8Strings (PKIX recommendation after 2004). +# nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings). +# MASK:XXXX a literal mask value. +# WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings. +string_mask = utf8only + +# req_extensions = v3_req # The extensions to add to a certificate request + +[ req_distinguished_name ] +countryName = Country Name (2 letter code) +countryName_default = AU +countryName_min = 2 +countryName_max = 2 + +stateOrProvinceName = State or Province Name (full name) +stateOrProvinceName_default = Some-State + +localityName = Locality Name (eg, city) + +0.organizationName = Organization Name (eg, company) +0.organizationName_default = Internet Widgits Pty Ltd + +# we can do this but it is not needed normally :-) +#1.organizationName = Second Organization Name (eg, company) +#1.organizationName_default = World Wide Web Pty Ltd + +organizationalUnitName = Organizational Unit Name (eg, section) +#organizationalUnitName_default = + +commonName = Common Name (e.g. server FQDN or YOUR name) +commonName_max = 64 + +emailAddress = Email Address +emailAddress_max = 64 + +# SET-ex3 = SET extension number 3 + +[ req_attributes ] +challengePassword = A challenge password +challengePassword_min = 4 +challengePassword_max = 20 + +unstructuredName = An optional company name + +[ usr_cert ] + +# These extensions are added when 'ca' signs a request. + +# This goes against PKIX guidelines but some CAs do it and some software +# requires this to avoid interpreting an end user certificate as a CA. + +basicConstraints=CA:FALSE + +# This is typical in keyUsage for a client certificate. +# keyUsage = nonRepudiation, digitalSignature, keyEncipherment + +# PKIX recommendations harmless if included in all certificates. +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid,issuer + +# This stuff is for subjectAltName and issuerAltname. +# Import the email address. +# subjectAltName=email:copy +# An alternative to produce certificates that aren't +# deprecated according to PKIX. +# subjectAltName=email:move + +# Copy subject details +# issuerAltName=issuer:copy + +# This is required for TSA certificates. +# extendedKeyUsage = critical,timeStamping + +[ v3_req ] + +# Extensions to add to a certificate request + +basicConstraints = CA:FALSE +keyUsage = nonRepudiation, digitalSignature, keyEncipherment + +[ v3_ca ] + + +# Extensions for a typical CA + + +# PKIX recommendation. + +subjectKeyIdentifier=hash + +authorityKeyIdentifier=keyid:always,issuer + +basicConstraints = critical,CA:true + +# Key usage: this is typical for a CA certificate. However since it will +# prevent it being used as an test self-signed certificate it is best +# left out by default. +# keyUsage = cRLSign, keyCertSign + +# Include email address in subject alt name: another PKIX recommendation +# subjectAltName=email:copy +# Copy issuer details +# issuerAltName=issuer:copy + +# DER hex encoding of an extension: beware experts only! +# obj=DER:02:03 +# Where 'obj' is a standard or added object +# You can even override a supported extension: +# basicConstraints= critical, DER:30:03:01:01:FF + +[ crl_ext ] + +# CRL extensions. +# Only issuerAltName and authorityKeyIdentifier make any sense in a CRL. + +# issuerAltName=issuer:copy +authorityKeyIdentifier=keyid:always + +[ proxy_cert_ext ] +# These extensions should be added when creating a proxy certificate + +# This goes against PKIX guidelines but some CAs do it and some software +# requires this to avoid interpreting an end user certificate as a CA. + +basicConstraints=CA:FALSE + +# This is typical in keyUsage for a client certificate. +# keyUsage = nonRepudiation, digitalSignature, keyEncipherment + +# PKIX recommendations harmless if included in all certificates. +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid,issuer + +# This stuff is for subjectAltName and issuerAltname. +# Import the email address. +# subjectAltName=email:copy +# An alternative to produce certificates that aren't +# deprecated according to PKIX. +# subjectAltName=email:move + +# Copy subject details +# issuerAltName=issuer:copy + +# This really needs to be in place for it to be a proxy certificate. +proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo + +#################################################################### +[ tsa ] + +default_tsa = tsa_config1 # the default TSA section + +[ tsa_config1 ] + +# These are used by the TSA reply generation only. +dir = ./demoCA # TSA root directory +serial = $dir/tsaserial # The current serial number (mandatory) +crypto_device = builtin # OpenSSL engine to use for signing +signer_cert = $dir/tsacert.pem # The TSA signing certificate + # (optional) +certs = $dir/cacert.pem # Certificate chain to include in reply + # (optional) +signer_key = $dir/private/tsakey.pem # The TSA private key (optional) +signer_digest = sha256 # Signing digest to use. (Optional) +default_policy = tsa_policy1 # Policy if request did not specify it + # (optional) +other_policies = tsa_policy2, tsa_policy3 # acceptable policies (optional) +digests = sha1, sha256, sha384, sha512 # Acceptable message digests (mandatory) +accuracy = secs:1, millisecs:500, microsecs:100 # (optional) +clock_precision_digits = 0 # number of digits after dot. (optional) +ordering = yes # Is ordering defined for timestamps? + # (optional, default: no) +tsa_name = yes # Must the TSA name be included in the reply? + # (optional, default: no) +ess_cert_id_chain = no # Must the ESS cert id chain be included? + # (optional, default: no) +ess_cert_id_alg = sha1 # algorithm to compute certificate + # identifier (optional, default: sha1) + +[insta] # CMP using Insta Demo CA +# Message transfer +server = pki.certificate.fi:8700 +# proxy = # set this as far as needed, e.g., http://192.168.1.1:8080 +# tls_use = 0 +path = pkix/ + +# Server authentication +recipient = "/C=FI/O=Insta Demo/CN=Insta Demo CA" # or set srvcert or issuer +ignore_keyusage = 1 # potentially needed quirk +unprotected_errors = 1 # potentially needed quirk +extracertsout = insta.extracerts.pem + +# Client authentication +ref = 3078 # user identification +secret = pass:insta # can be used for both client and server side + +# Generic message options +cmd = ir # default operation, can be overridden on cmd line with, e.g., kur + +# Certificate enrollment +subject = "/CN=openssl-cmp-test" +newkey = insta.priv.pem +out_trusted = apps/insta.ca.crt # does not include keyUsage digitalSignature +certout = insta.cert.pem + +[pbm] # Password-based protection for Insta CA +# Server and client authentication +ref = $insta::ref # 3078 +secret = $insta::secret # pass:insta + +[signature] # Signature-based protection for Insta CA +# Server authentication +trusted = $insta::out_trusted # apps/insta.ca.crt + +# Client authentication +secret = # disable PBM +key = $insta::newkey # insta.priv.pem +cert = $insta::certout # insta.cert.pem + +[ir] +cmd = ir + +[cr] +cmd = cr + +[kur] +# Certificate update +cmd = kur +oldcert = $insta::certout # insta.cert.pem + +[rr] +# Certificate revocation +cmd = rr +oldcert = $insta::certout # insta.cert.pem diff --git a/src/test/consumer-snap/snapcraft.yaml b/src/test/consumer-snap/snapcraft.yaml new file mode 100644 index 0000000..c380eb3 --- /dev/null +++ b/src/test/consumer-snap/snapcraft.yaml @@ -0,0 +1,67 @@ +name: kem-test +base: core22 +version: '1.0' +summary: Test consumer snap +description: | + Test consumer snap + +grade: stable +confinement: strict + +lint: + ignore: + - classic + - library + +parts: + openssl-fips: + plugin: autotools + source: https://github.com/openssl/openssl + source-type: git + source-tag: openssl-3.0.2 + build-packages: + - build-essential + override-build: | + ./Configure enable-fips && make && make install && make install_fips + mkdir -p $SNAPCRAFT_PART_INSTALL/usr/local/lib64/ossl-modules + mv /usr/local/lib64/ossl-modules/* $SNAPCRAFT_PART_INSTALL/usr/local/lib64/ossl-modules/ + mkdir -p $SNAPCRAFT_PART_INSTALL/usr/local/ssl/ + mv /usr/local/ssl/* $SNAPCRAFT_PART_INSTALL/usr/local/ssl/ + rm $SNAPCRAFT_PART_INSTALL/usr/local/ssl/openssl.cnf + + kem-test: + plugin: dump + after: + - openssl-fips + source: . + build-packages: + - openjdk-21-jdk + override-build: | + javac KEMTest.java + jar -cf KEMTest.jar ./KEMTest.class + mkdir -p $SNAPCRAFT_PART_INSTALL/bin + mv KEMTest.jar $SNAPCRAFT_PART_INSTALL/bin/ + mkdir -p $SNAPCRAFT_PART_INSTALL/usr/local/ssl/ + mv ./openssl.cnf $SNAPCRAFT_PART_INSTALL/usr/local/ssl/ + stage-packages: + - openjdk-21-jdk + - build-essential + - git + + +apps: + kem-test: + command: /usr/lib/jvm/java-21-openjdk-amd64/bin/java -cp $SNAP/bin/KEMTest.jar:$SNAP/imported-libs/jar/openssl-fips-java-0.0.1.jar KEMTest + environment: + OPENSSL_MODULES: $SNAP/usr/local/lib64/ossl-modules/ + OPENSSL_CUSTOM_CONF: $SNAP/usr/local/ssl/openssl.cnf + JAVA_HOME: $SNAP/usr/lib/jvm/java-21-openjdk-amd64 + PATH: $JAVA_HOME/bin:$PATH + plugs: + - openssl-fips-provider-jar + +plugs: + openssl-fips-provider-jar: + interface: content + content: openssl-fips-provider-jar + target: $SNAP/imported-libs