-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
yubikey_common.go
56 lines (48 loc) · 1.92 KB
/
yubikey_common.go
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
/*
Copyright 2022 Gravitational, Inc.
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 keys
import (
"context"
"github.com/gravitational/trace"
)
// GetYubiKeyPrivateKey attempt to retrieve a YubiKey private key matching the given hardware key policy
// from the given slot. If slot is unspecified, the default slot for the given key policy will be used.
// If the slot is empty, a new private key matching the given policy will be generated in the slot.
// - hardware_key: 9a
// - hardware_key_touch: 9c
func GetYubiKeyPrivateKey(ctx context.Context, policy PrivateKeyPolicy, slot PIVSlot) (*PrivateKey, error) {
priv, err := getOrGenerateYubiKeyPrivateKey(ctx, policy, slot)
if err != nil {
return nil, trace.Wrap(err, "failed to get a YubiKey private key")
}
return priv, nil
}
// TODO(Joerger): Deprecated in favor of GetYubiKeyPrivateKey.
// Delete once all references in /e are removed
func GetOrGenerateYubiKeyPrivateKey(touchRequired bool) (*PrivateKey, error) {
policy := PrivateKeyPolicyHardwareKey
if touchRequired {
policy = PrivateKeyPolicyHardwareKeyTouch
}
priv, err := getOrGenerateYubiKeyPrivateKey(context.TODO(), policy, "")
if err != nil {
return nil, trace.Wrap(err, "failed to get a YubiKey private key")
}
return priv, nil
}
// PIVSlot is the string representation of a PIV slot. e.g. "9a".
type PIVSlot string
// Validate that the PIV slot is a valid value.
func (s PIVSlot) Validate() error {
return trace.Wrap(s.validate())
}