forked from hyperledger/fabric-sdk-go
/
util.go
317 lines (276 loc) · 9.56 KB
/
util.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
/*
Copyright IBM Corp. 2016 All Rights Reserved.
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.
*/
/*
Notice: This file has been modified for Hyperledger Fabric SDK Go usage.
Please review third_party pinning scripts and patches for more details.
*/
package util
import (
"bytes"
"crypto/ecdsa"
"crypto/x509"
"encoding/base64"
"encoding/json"
"encoding/pem"
"fmt"
"io/ioutil"
"math/big"
mrand "math/rand"
factory "github.com/hyperledger/fabric-sdk-go/internal/github.com/hyperledger/fabric-ca/sdkpatch/cryptosuitebridge"
"github.com/hyperledger/fabric-sdk-go/pkg/common/providers/core"
"net/http"
"os"
"path"
"path/filepath"
"reflect"
"regexp"
"strings"
"time"
"github.com/pkg/errors"
"golang.org/x/crypto/ocsp"
)
var (
rnd = mrand.NewSource(time.Now().UnixNano())
// ErrNotImplemented used to return errors for functions not implemented
ErrNotImplemented = errors.New("NOT YET IMPLEMENTED")
)
const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
const (
letterIdxBits = 6 // 6 bits to represent a letter index
letterIdxMask = 1<<letterIdxBits - 1 // All 1-bits, as many as letterIdxBits
letterIdxMax = 63 / letterIdxBits // # of letter indices fitting in 63 bits
)
// RevocationReasonCodes is a map between string reason codes to integers as defined in RFC 5280
var RevocationReasonCodes = map[string]int{
"unspecified": ocsp.Unspecified,
"keycompromise": ocsp.KeyCompromise,
"cacompromise": ocsp.CACompromise,
"affiliationchanged": ocsp.AffiliationChanged,
"superseded": ocsp.Superseded,
"cessationofoperation": ocsp.CessationOfOperation,
"certificatehold": ocsp.CertificateHold,
"removefromcrl": ocsp.RemoveFromCRL,
"privilegewithdrawn": ocsp.PrivilegeWithdrawn,
"aacompromise": ocsp.AACompromise,
}
// SecretTag to tag a field as secret as in password, token
const SecretTag = "mask"
// URLRegex is the regular expression to check if a value is an URL
var URLRegex = regexp.MustCompile("(ldap|http)s*://(\\S+):(\\S+)@")
//ECDSASignature forms the structure for R and S value for ECDSA
type ECDSASignature struct {
R, S *big.Int
}
// ReadFile reads a file
func ReadFile(file string) ([]byte, error) {
return ioutil.ReadFile(file)
}
// WriteFile writes a file
func WriteFile(file string, buf []byte, perm os.FileMode) error {
dir := path.Dir(file)
// Create the directory if it doesn't exist
if _, err := os.Stat(dir); os.IsNotExist(err) {
err = os.MkdirAll(dir, 0755)
if err != nil {
return errors.Wrapf(err, "Failed to create directory '%s' for file '%s'", dir, file)
}
}
return ioutil.WriteFile(file, buf, perm)
}
// FileExists checks to see if a file exists
func FileExists(name string) bool {
if _, err := os.Stat(name); err != nil {
if os.IsNotExist(err) {
return false
}
}
return true
}
// Marshal to bytes
func Marshal(from interface{}, what string) ([]byte, error) {
buf, err := json.Marshal(from)
if err != nil {
return nil, errors.Wrapf(err, "Failed to marshal %s", what)
}
return buf, nil
}
// CreateToken creates a JWT-like token.
// In a normal JWT token, the format of the token created is:
// <algorithm,claims,signature>
// where each part is base64-encoded string separated by a period.
// In this JWT-like token, there are two differences:
// 1) the claims section is a certificate, so the format is:
// <certificate,signature>
// 2) the signature uses the private key associated with the certificate,
// and the signature is across both the certificate and the "body" argument,
// which is the body of an HTTP request, though could be any arbitrary bytes.
// @param cert The pem-encoded certificate
// @param key The pem-encoded key
// @param method http method of the request
// @param uri URI of the request
// @param body The body of an HTTP request
func CreateToken(csp core.CryptoSuite, cert []byte, key core.Key, method, uri string, body []byte) (string, error) {
x509Cert, err := GetX509CertificateFromPEM(cert)
if err != nil {
return "", err
}
publicKey := x509Cert.PublicKey
var token string
switch publicKey.(type) {
case *ecdsa.PublicKey:
token, err = GenECDSAToken(csp, cert, key, method, uri, body)
if err != nil {
return "", err
}
}
return token, nil
}
//GenECDSAToken signs the http body and cert with ECDSA using EC private key
func GenECDSAToken(csp core.CryptoSuite, cert []byte, key core.Key, method, uri string, body []byte) (string, error) {
b64body := B64Encode(body)
b64cert := B64Encode(cert)
b64uri := B64Encode([]byte(uri))
payload := method + "." + b64uri + "." + b64body + "." + b64cert
return genECDSAToken(csp, key, b64cert, payload)
}
func genECDSAToken(csp core.CryptoSuite, key core.Key, b64cert, payload string) (string, error) {
digest, digestError := csp.Hash([]byte(payload), factory.GetSHAOpts())
if digestError != nil {
return "", errors.WithMessage(digestError, fmt.Sprintf("Hash failed on '%s'", payload))
}
ecSignature, err := csp.Sign(key, digest, nil)
if err != nil {
return "", errors.WithMessage(err, "BCCSP signature generation failure")
}
if len(ecSignature) == 0 {
return "", errors.New("BCCSP signature creation failed. Signature must be different than nil")
}
b64sig := B64Encode(ecSignature)
token := b64cert + "." + b64sig
return token, nil
}
// B64Encode base64 encodes bytes
func B64Encode(buf []byte) string {
return base64.StdEncoding.EncodeToString(buf)
}
// B64Decode base64 decodes a string
func B64Decode(str string) (buf []byte, err error) {
return base64.StdEncoding.DecodeString(str)
}
// HTTPRequestToString returns a string for an HTTP request for debuggging
func HTTPRequestToString(req *http.Request) string {
body, _ := ioutil.ReadAll(req.Body)
req.Body = ioutil.NopCloser(bytes.NewReader(body))
return fmt.Sprintf("%s %s\n%s",
req.Method, req.URL, string(body))
}
// HTTPResponseToString returns a string for an HTTP response for debuggging
func HTTPResponseToString(resp *http.Response) string {
body, _ := ioutil.ReadAll(resp.Body)
resp.Body = ioutil.NopCloser(bytes.NewReader(body))
return fmt.Sprintf("statusCode=%d (%s)\n%s",
resp.StatusCode, resp.Status, string(body))
}
// GetX509CertificateFromPEM get an X509 certificate from bytes in PEM format
func GetX509CertificateFromPEM(cert []byte) (*x509.Certificate, error) {
block, _ := pem.Decode(cert)
if block == nil {
return nil, errors.New("Failed to PEM decode certificate")
}
x509Cert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return nil, errors.Wrap(err, "Error parsing certificate")
}
return x509Cert, nil
}
// GetEnrollmentIDFromPEM returns the EnrollmentID from a PEM buffer
func GetEnrollmentIDFromPEM(cert []byte) (string, error) {
x509Cert, err := GetX509CertificateFromPEM(cert)
if err != nil {
return "", err
}
return GetEnrollmentIDFromX509Certificate(x509Cert), nil
}
// GetEnrollmentIDFromX509Certificate returns the EnrollmentID from the X509 certificate
func GetEnrollmentIDFromX509Certificate(cert *x509.Certificate) string {
return cert.Subject.CommonName
}
// MakeFileAbs makes 'file' absolute relative to 'dir' if not already absolute
func MakeFileAbs(file, dir string) (string, error) {
if file == "" {
return "", nil
}
if filepath.IsAbs(file) {
return file, nil
}
path, err := filepath.Abs(filepath.Join(dir, file))
if err != nil {
return "", errors.Wrapf(err, "Failed making '%s' absolute based on '%s'", file, dir)
}
return path, nil
}
// GetSerialAsHex returns the serial number from certificate as hex format
func GetSerialAsHex(serial *big.Int) string {
hex := fmt.Sprintf("%x", serial)
return hex
}
// StructToString converts a struct to a string. If a field
// has a 'secret' tag, it is masked in the returned string
func StructToString(si interface{}) string {
rval := reflect.ValueOf(si).Elem()
tipe := rval.Type()
var buffer bytes.Buffer
buffer.WriteString("{ ")
for i := 0; i < rval.NumField(); i++ {
tf := tipe.Field(i)
if !rval.FieldByName(tf.Name).CanSet() {
continue // skip unexported fields
}
var fStr string
tagv := tf.Tag.Get(SecretTag)
if tagv == "password" || tagv == "username" {
fStr = fmt.Sprintf("%s:**** ", tf.Name)
} else if tagv == "url" {
val, ok := rval.Field(i).Interface().(string)
if ok {
val = GetMaskedURL(val)
fStr = fmt.Sprintf("%s:%v ", tf.Name, val)
} else {
fStr = fmt.Sprintf("%s:%v ", tf.Name, rval.Field(i).Interface())
}
} else {
fStr = fmt.Sprintf("%s:%v ", tf.Name, rval.Field(i).Interface())
}
buffer.WriteString(fStr)
}
buffer.WriteString(" }")
return buffer.String()
}
// GetMaskedURL returns masked URL. It masks username and password from the URL
// if present
func GetMaskedURL(url string) string {
matches := URLRegex.FindStringSubmatch(url)
// If there is a match, there should be four entries: 1 for
// the match and 3 for submatches
if len(matches) == 4 {
matchIdxs := URLRegex.FindStringSubmatchIndex(url)
matchStr := url[matchIdxs[0]:matchIdxs[1]]
for idx := 2; idx < len(matches); idx++ {
if matches[idx] != "" {
matchStr = strings.Replace(matchStr, matches[idx], "****", 1)
}
}
url = url[:matchIdxs[0]] + matchStr + url[matchIdxs[1]:len(url)]
}
return url
}