File: keywrapper_pkcs11_test.go

package info (click to toggle)
golang-github-containers-ocicrypt 1.1.10-3
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid, trixie
  • size: 540 kB
  • sloc: sh: 242; makefile: 17
file content (217 lines) | stat: -rw-r--r-- 5,365 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
   Copyright The ocicrypt Authors.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package pkcs11

import (
	"fmt"
	"os"
	"testing"

	"github.com/containers/ocicrypt/config"
	"github.com/containers/ocicrypt/crypto/pkcs11"
	"github.com/containers/ocicrypt/utils"
	"github.com/containers/ocicrypt/utils/softhsm"
)

var (
	SOFTHSM_SETUP = "../../scripts/softhsm_setup"
)

func getPkcs11ConfigYaml(t *testing.T) []byte {
	// we need to provide a configuration file so that on the various distros
	// the libsofthsm2.so will be found by searching directories
	mdyamls := pkcs11.GetDefaultModuleDirectoriesYaml("")
	config := fmt.Sprintf("module-directories:\n"+
		"%s"+
		"allowed-module-paths:\n"+
		"%s", mdyamls, mdyamls)
	return []byte(config)
}

func createValidPkcs11Ccs(t *testing.T) ([]*config.CryptoConfig, *softhsm.SoftHSMSetup, error) {
	shsm := softhsm.NewSoftHSMSetup()
	pkcs11PubKeyUriStr, err := shsm.RunSoftHSMSetup(SOFTHSM_SETUP)
	if err != nil {
		return nil, shsm, err
	}
	pubKeyPem, err := shsm.RunSoftHSMGetPubkey(SOFTHSM_SETUP)
	if err != nil {
		return nil, shsm, err
	}
	pkcs11PrivKeyYaml := `
pkcs11:
  uri: ` + pkcs11PubKeyUriStr + `
module:
  env:
    SOFTHSM2_CONF: ` + shsm.GetConfigFilename()

	p11confYaml := getPkcs11ConfigYaml(t)

	validPkcs11Ccs := []*config.CryptoConfig{
		// Key 1
		{
			EncryptConfig: &config.EncryptConfig{
				Parameters: map[string][][]byte{
					"pkcs11-pubkeys": {[]byte(pubKeyPem)},
				},
				DecryptConfig: config.DecryptConfig{
					Parameters: map[string][][]byte{
						"pkcs11-yamls":  {[]byte(pkcs11PrivKeyYaml)},
						"pkcs11-config": {p11confYaml},
					},
				},
			},

			DecryptConfig: &config.DecryptConfig{
				Parameters: map[string][][]byte{
					"pkcs11-yamls":  {[]byte(pkcs11PrivKeyYaml)},
					"pkcs11-config": {p11confYaml},
				},
			},
		},
		// Key 2
		{
			EncryptConfig: &config.EncryptConfig{
				Parameters: map[string][][]byte{
					// public and private key YAMLs are identical
					"pkcs11-yamls": {[]byte(pkcs11PrivKeyYaml)},
				},
				DecryptConfig: config.DecryptConfig{
					Parameters: map[string][][]byte{
						"pkcs11-yamls":  {[]byte(pkcs11PrivKeyYaml)},
						"pkcs11-config": {p11confYaml},
					},
				},
			},

			DecryptConfig: &config.DecryptConfig{
				Parameters: map[string][][]byte{
					"pkcs11-yamls":  {[]byte(pkcs11PrivKeyYaml)},
					"pkcs11-config": {p11confYaml},
				},
			},
		},
	}
	return validPkcs11Ccs, shsm, nil
}

func createInvalidPkcs11Ccs(t *testing.T) ([]*config.CryptoConfig, *softhsm.SoftHSMSetup, error) {
	shsm := softhsm.NewSoftHSMSetup()
	pkcs11PubKeyUriStr, err := shsm.RunSoftHSMSetup(SOFTHSM_SETUP)
	if err != nil {
		return nil, shsm, err
	}
	pubKey2Pem, _, err := utils.CreateRSATestKey(2048, nil, true)
	if err != nil {
		return nil, shsm, err
	}
	pkcs11PrivKeyYaml := `
pkcs11:
  uri: ` + pkcs11PubKeyUriStr + `
module:
  env:
    SOFTHSM2_CONF: ` + shsm.GetConfigFilename()

	p11confYaml := getPkcs11ConfigYaml(t)

	invalidPkcs11Ccs := []*config.CryptoConfig{
		// Key 1
		{
			EncryptConfig: &config.EncryptConfig{
				Parameters: map[string][][]byte{
					"pkcs11-pubkeys": {pubKey2Pem},
				},
				DecryptConfig: config.DecryptConfig{
					Parameters: map[string][][]byte{
						"pkcs11-yamls":  {[]byte(pkcs11PrivKeyYaml)},
						"pkcs11-config": {p11confYaml},
					},
				},
			},

			DecryptConfig: &config.DecryptConfig{
				Parameters: map[string][][]byte{
					"pkcs11-yamls":  {[]byte(pkcs11PrivKeyYaml)},
					"pkcs11-config": {p11confYaml},
				},
			},
		},
	}
	return invalidPkcs11Ccs, shsm, nil
}

func TestKeyWrapPkcs11Success(t *testing.T) {
	validPkcs11Ccs, shsm, err := createValidPkcs11Ccs(t)
	defer shsm.RunSoftHSMTeardown(SOFTHSM_SETUP)
	if err != nil {
		t.Fatal(err)
	}

	os.Setenv("OCICRYPT_OAEP_HASHALG", "sha1")

	for _, cc := range validPkcs11Ccs {
		kw := NewKeyWrapper()

		data := []byte("This is some secret text")

		wk, err := kw.WrapKeys(cc.EncryptConfig, data)
		if err != nil {
			t.Fatal(err)
		}

		ud, err := kw.UnwrapKey(cc.DecryptConfig, wk)
		if err != nil {
			t.Fatal(err)
		}

		if string(data) != string(ud) {
			t.Fatal("Strings don't match")
		}
	}
}

func TestKeyWrapPkcs11Invalid(t *testing.T) {
	invalidPkcs11Ccs, shsm, err := createInvalidPkcs11Ccs(t)
	defer shsm.RunSoftHSMTeardown(SOFTHSM_SETUP)
	if err != nil {
		t.Fatal(err)
	}

	os.Setenv("OCICRYPT_OAEP_HASHALG", "sha1")

	for _, cc := range invalidPkcs11Ccs {
		kw := NewKeyWrapper()

		data := []byte("This is some secret text")

		wk, err := kw.WrapKeys(cc.EncryptConfig, data)
		if err != nil {
			t.Fatalf("Wrapping should have worked")
		}

		ud, err := kw.UnwrapKey(cc.DecryptConfig, wk)
		if err != nil {
			continue
		}

		if string(data) != string(ud) {
			t.Fatalf("Unwrapping should have failed already")
		}

		t.Fatal("Successfully wrapped and unwrapped with invalid crypto config")
	}
}