forked from TBD54566975/ssi-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pkh.go
executable file
·247 lines (208 loc) · 6.59 KB
/
pkh.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
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
package pkh
import (
"embed"
"fmt"
"regexp"
"strings"
"github.com/extrimian/ssi-sdk/cryptosuite"
"github.com/pkg/errors"
"github.com/extrimian/ssi-sdk/did"
"github.com/extrimian/ssi-sdk/util"
)
type (
PKH string
Network string
)
var (
//go:embed context
knownContexts embed.FS
)
const (
// DIDPKHPrefix did:pkh prefix
DIDPKHPrefix = "did:pkh"
pkhContextFilename = "did-pkh-context.json"
)
const (
Bitcoin Network = "Bitcoin"
Ethereum Network = "Ethereum"
Polygon Network = "Polygon"
)
const (
BitcoinNetworkPrefix = "bip122:000000000019d6689c085ae165831e93"
EthereumNetworkPrefix = "eip155:1"
PolygonNetworkPrefix = "eip155:137"
ECDSASECP256k1RecoveryMethod2020 = "EcdsaSecp256k1RecoveryMethod2020"
)
// GetDIDPKHContext returns a context which should be manually inserted into each did:pkh document. This will likely
// change over time as new verification methods are supported, and general-purpose methods are specified.
func GetDIDPKHContext() (string, error) {
b, err := knownContexts.ReadFile("context/" + pkhContextFilename)
return string(b), err
}
// CreateDIDPKHFromNetwork constructs a did:pkh from a network and the networks native address.
func CreateDIDPKHFromNetwork(network Network, address string) (*PKH, error) {
prefix, err := GetDIDPKHPrefixForNetwork(network)
if err != nil {
return nil, err
}
split := strings.Split(prefix, ":")
return CreateDIDPKH(split[0], split[1], address)
}
// CreateDIDPKH constructs a did:pkh from a namespace, reference, and account address.
// Reference: did:pkh:namespace:reference:account_address
func CreateDIDPKH(namespace, reference, address string) (*PKH, error) {
didPKH := PKH(fmt.Sprintf("%s:%s:%s:%s", DIDPKHPrefix, namespace, reference, address))
if !IsValidPKH(didPKH) {
return nil, fmt.Errorf("PKH DID is not valid: %s", didPKH.String())
}
return &didPKH, nil
}
func (d PKH) IsValid() bool {
return IsValidPKH(d)
}
func (d PKH) String() string {
return string(d)
}
// Suffix Parse returns the value without the `did:pkh` prefix
func (d PKH) Suffix() (string, error) {
split := strings.Split(string(d), DIDPKHPrefix+":")
if len(split) != 2 {
return "", errors.New("invalid did pkh")
}
return split[1], nil
}
func (PKH) Method() did.Method {
return did.PKHMethod
}
// GetDIDPKHPrefixForNetwork returns the did:pkh prefix for a given network
func GetDIDPKHPrefixForNetwork(n Network) (string, error) {
switch n {
case Bitcoin:
return BitcoinNetworkPrefix, nil
case Ethereum:
return EthereumNetworkPrefix, nil
case Polygon:
return PolygonNetworkPrefix, nil
}
return "", fmt.Errorf("unsupported did:pkh network: %s", n)
}
// GetDIDPKHNetworkForPrefix returns the did:pkh network for a given prefix
func GetDIDPKHNetworkForPrefix(p string) (Network, error) {
switch p {
case BitcoinNetworkPrefix:
return Bitcoin, nil
case EthereumNetworkPrefix:
return Ethereum, nil
case PolygonNetworkPrefix:
return Polygon, nil
}
return "", fmt.Errorf("unsupported did:pkh prefix: %s", p)
}
// GetDIDPKHNetworkForDID returns the network for a given did:pkh
func GetDIDPKHNetworkForDID(id string) (Network, error) {
prefixes := GetDIDPKHNetworkPrefixes()
for _, prefix := range prefixes {
if strings.Contains(id, prefix+":") {
return GetDIDPKHNetworkForPrefix(prefix)
}
}
return "", fmt.Errorf("could not find network for did:pkh DID: %s", id)
}
// GetVerificationTypeForNetwork returns the verification key type for a given network
func GetVerificationTypeForNetwork(n Network) (string, error) {
switch n {
case Bitcoin, Ethereum, Polygon:
return ECDSASECP256k1RecoveryMethod2020, nil
}
return "", fmt.Errorf("unsupported did:pkh network: %s", n)
}
func GetSupportedPKHNetworks() []Network {
return []Network{Bitcoin, Ethereum, Polygon}
}
func GetDIDPKHNetworkPrefixes() []string {
return []string{BitcoinNetworkPrefix, EthereumNetworkPrefix, PolygonNetworkPrefix}
}
// Expand turns the DID key into a complaint DID Document
func (d PKH) Expand() (*did.Document, error) {
verificationMethod, err := constructPKHVerificationMethod(d)
if err != nil {
return nil, errors.Wrap(err, "constructing verification method")
}
knownDIDPKHContextJSON, err := GetDIDPKHContext()
if err != nil {
return nil, errors.Wrap(err, "getting known context json")
}
contextJSON, err := util.ToJSONInterface(knownDIDPKHContextJSON)
if err != nil {
return nil, errors.Wrap(err, "converting known context to json")
}
verificationMethodSet := []did.VerificationMethodSet{
string(d) + "#blockchainAccountId",
}
return &did.Document{
Context: contextJSON,
ID: string(d),
VerificationMethod: []did.VerificationMethod{*verificationMethod},
Authentication: verificationMethodSet,
AssertionMethod: verificationMethodSet,
CapabilityDelegation: verificationMethodSet,
CapabilityInvocation: verificationMethodSet,
}, nil
}
func constructPKHVerificationMethod(didPKH PKH) (*did.VerificationMethod, error) {
if !IsValidPKH(didPKH) {
parsed, err := didPKH.Suffix()
if err != nil || parsed == "" {
return nil, errors.Wrap(err, "PKH DID is not valid")
}
}
network, err := GetDIDPKHNetworkForDID(didPKH.String())
if err != nil {
return nil, errors.Wrap(err, "finding network")
}
verificationType, err := GetVerificationTypeForNetwork(network)
if err != nil {
return nil, errors.Wrap(err, "finding verification type")
}
suffix, err := didPKH.Suffix()
if err != nil {
return nil, err
}
return &did.VerificationMethod{
ID: string(didPKH) + "#blockchainAccountId",
Type: cryptosuite.LDKeyType(verificationType),
Controller: string(didPKH),
BlockchainAccountID: suffix,
}, nil
}
// IsValidPKH checks if a pkh did is valid based on the following parameters:
// pkh-did = "did:pkh:" address
// address = account_id according to [CAIP-10]
// account_id: chain_id + ":" + account_address
// chain_id: [-a-z0-9]{3,8}:[-a-zA-Z0-9]{1,32}
// account_address: [a-zA-Z0-9]{1,64}
// chain_id: namespace + ":" + reference
// namespace: [-a-z0-9]{3,8}
// reference: [-a-zA-Z0-9]{1,32}
func IsValidPKH(id PKH) bool {
split := strings.Split(string(id), ":")
if len(split) != 5 || (split[0]+":"+split[1]) != DIDPKHPrefix {
return false
}
// namespace
matched, err := regexp.MatchString(`[-a-z0-9]{3,8}`, split[2])
if !matched || err != nil {
return false
}
// reference
matched, err = regexp.MatchString(`[-a-zA-Z0-9]{1,32}`, split[3])
if !matched || err != nil {
return false
}
// account_address
matched, err = regexp.MatchString(`[a-zA-Z0-9]{1,64}`, split[4])
if !matched || err != nil {
return false
}
return true
}