// Copyright 2022-2023 The NATS 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. // // Adapted, updated, and enhanced from CertToStore, https://github.com/google/certtostore/releases/tag/v1.0.2 // Apache License, Version 2.0, Copyright 2017 Google Inc. package certstore import ( "bytes" "crypto" "crypto/ecdsa" "crypto/elliptic" "crypto/rsa" "crypto/tls" "crypto/x509" "encoding/binary" "fmt" "io" "math/big" "reflect" "sync" "syscall" "unicode/utf16" "unsafe" "golang.org/x/crypto/cryptobyte" "golang.org/x/crypto/cryptobyte/asn1" "golang.org/x/sys/windows" ) const ( // wincrypt.h constants winAcquireCached = 0x1 // CRYPT_ACQUIRE_CACHE_FLAG winAcquireSilent = 0x40 // CRYPT_ACQUIRE_SILENT_FLAG winAcquireOnlyNCryptKey = 0x40000 // CRYPT_ACQUIRE_ONLY_NCRYPT_KEY_FLAG winEncodingX509ASN = 1 // X509_ASN_ENCODING winEncodingPKCS7 = 65536 // PKCS_7_ASN_ENCODING winCertStoreProvSystem = 10 // CERT_STORE_PROV_SYSTEM winCertStoreCurrentUser = uint32(winCertStoreCurrentUserID << winCompareShift) // CERT_SYSTEM_STORE_CURRENT_USER winCertStoreLocalMachine = uint32(winCertStoreLocalMachineID << winCompareShift) // CERT_SYSTEM_STORE_LOCAL_MACHINE winCertStoreCurrentUserID = 1 // CERT_SYSTEM_STORE_CURRENT_USER_ID winCertStoreLocalMachineID = 2 // CERT_SYSTEM_STORE_LOCAL_MACHINE_ID winInfoIssuerFlag = 4 // CERT_INFO_ISSUER_FLAG winInfoSubjectFlag = 7 // CERT_INFO_SUBJECT_FLAG winCompareNameStrW = 8 // CERT_COMPARE_NAME_STR_A winCompareShift = 16 // CERT_COMPARE_SHIFT // Reference https://learn.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-certfindcertificateinstore winFindIssuerStr = winCompareNameStrW< 1 { chain = chain[:len(chain)-1] } // For tls.Certificate.Certificate need a [][]byte from []*x509.Certificate // Approximate capacity for efficiency rawChain = make([][]byte, 0, len(chain)) for _, link := range chain { rawChain = append(rawChain, link.Raw) } tlsCert := tls.Certificate{ Certificate: rawChain, PrivateKey: pk, Leaf: leaf, } config.Certificates = []tls.Certificate{tlsCert} // note: pk is a windows pointer (not freed by Go) but needs to live the life of the server for Signing. // The cert context (leafCtx) windows pointer must not be freed underneath the pk so also life of the server. return nil } // winWide returns a pointer to uint16 representing the equivalent // to a Windows LPCWSTR. func winWide(s string) *uint16 { w := utf16.Encode([]rune(s)) w = append(w, 0) return &w[0] } // winOpenProvider gets a provider handle for subsequent calls func winOpenProvider(provider string) (uintptr, error) { var hProv uintptr pname := winWide(provider) // Open the provider, the last parameter is not used r, _, err := winNCryptOpenStorageProvider.Call(uintptr(unsafe.Pointer(&hProv)), uintptr(unsafe.Pointer(pname)), 0) if r == 0 { return hProv, nil } return hProv, fmt.Errorf("NCryptOpenStorageProvider returned %X: %v", r, err) } // winFindCert wraps the CertFindCertificateInStore library call. Note that any cert context passed // into prev will be freed. If no certificate was found, nil will be returned. func winFindCert(store windows.Handle, enc, findFlags, findType uint32, para *uint16, prev *windows.CertContext) (*windows.CertContext, error) { h, _, err := winCertFindCertificateInStore.Call( uintptr(store), uintptr(enc), uintptr(findFlags), uintptr(findType), uintptr(unsafe.Pointer(para)), uintptr(unsafe.Pointer(prev)), ) if h == 0 { // Actual error, or simply not found? if errno, ok := err.(syscall.Errno); ok && errno == winCryptENotFound { return nil, ErrFailedCertSearch } return nil, ErrFailedCertSearch } // nolint:govet return (*windows.CertContext)(unsafe.Pointer(h)), nil } // winCertStore is a store implementation for the Windows Certificate Store type winCertStore struct { Prov uintptr ProvName string stores map[string]*winStoreHandle mu sync.Mutex } // winOpenCertStore creates a winCertStore func winOpenCertStore(provider string) (*winCertStore, error) { cngProv, err := winOpenProvider(provider) if err != nil { // pass through error from winOpenProvider return nil, err } wcs := &winCertStore{ Prov: cngProv, ProvName: provider, stores: make(map[string]*winStoreHandle), } return wcs, nil } // winCertContextToX509 creates an x509.Certificate from a Windows cert context. func winCertContextToX509(ctx *windows.CertContext) (*x509.Certificate, error) { var der []byte slice := (*reflect.SliceHeader)(unsafe.Pointer(&der)) slice.Data = uintptr(unsafe.Pointer(ctx.EncodedCert)) slice.Len = int(ctx.Length) slice.Cap = int(ctx.Length) return x509.ParseCertificate(der) } // certByIssuer matches and returns the first certificate found by passed issuer. // CertContext pointer returned allows subsequent key operations like Sign. Caller specifies // current user's personal certs or local machine's personal certs using storeType. // See CERT_FIND_ISSUER_STR description at https://learn.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-certfindcertificateinstore func (w *winCertStore) certByIssuer(issuer string, storeType uint32) (*x509.Certificate, *windows.CertContext, error) { return w.certSearch(winFindIssuerStr, issuer, winMyStore, storeType) } // certBySubject matches and returns the first certificate found by passed subject field. // CertContext pointer returned allows subsequent key operations like Sign. Caller specifies // current user's personal certs or local machine's personal certs using storeType. // See CERT_FIND_SUBJECT_STR description at https://learn.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-certfindcertificateinstore func (w *winCertStore) certBySubject(subject string, storeType uint32) (*x509.Certificate, *windows.CertContext, error) { return w.certSearch(winFindSubjectStr, subject, winMyStore, storeType) } // certSearch is a helper function to lookup certificates based on search type and match value. // store is used to specify which store to perform the lookup in (system or user). func (w *winCertStore) certSearch(searchType uint32, matchValue string, searchRoot *uint16, store uint32) (*x509.Certificate, *windows.CertContext, error) { // store handle to "MY" store h, err := w.storeHandle(store, searchRoot) if err != nil { return nil, nil, err } var prev *windows.CertContext var cert *x509.Certificate i, err := windows.UTF16PtrFromString(matchValue) if err != nil { return nil, nil, ErrFailedCertSearch } // pass 0 as the third parameter because it is not used // https://msdn.microsoft.com/en-us/library/windows/desktop/aa376064(v=vs.85).aspx nc, err := winFindCert(h, winEncodingX509ASN|winEncodingPKCS7, 0, searchType, i, prev) if err != nil { return nil, nil, err } if nc != nil { // certificate found prev = nc // Extract the DER-encoded certificate from the cert context xc, err := winCertContextToX509(nc) if err == nil { cert = xc } else { return nil, nil, ErrFailedX509Extract } } else { return nil, nil, ErrFailedCertSearch } if cert == nil { return nil, nil, ErrFailedX509Extract } return cert, prev, nil } type winStoreHandle struct { handle *windows.Handle } func winNewStoreHandle(provider uint32, store *uint16) (*winStoreHandle, error) { var s winStoreHandle if s.handle != nil { return &s, nil } st, err := windows.CertOpenStore( winCertStoreProvSystem, 0, 0, provider, uintptr(unsafe.Pointer(store))) if err != nil { return nil, ErrBadCryptoStoreProvider } s.handle = &st return &s, nil } // winKey implements crypto.Signer and crypto.Decrypter for key based operations. type winKey struct { handle uintptr pub crypto.PublicKey Container string AlgorithmGroup string } // Public exports a public key to implement crypto.Signer func (k winKey) Public() crypto.PublicKey { return k.pub } // Sign returns the signature of a hash to implement crypto.Signer func (k winKey) Sign(_ io.Reader, digest []byte, opts crypto.SignerOpts) ([]byte, error) { switch k.AlgorithmGroup { case "ECDSA", "ECDH": return winSignECDSA(k.handle, digest) case "RSA": hf := opts.HashFunc() algID, ok := winAlgIDs[hf] if !ok { return nil, ErrBadRSAHashAlgorithm } switch opts.(type) { case *rsa.PSSOptions: return winSignRSAPSSPadding(k.handle, digest, algID) default: return winSignRSAPKCS1Padding(k.handle, digest, algID) } default: return nil, ErrBadSigningAlgorithm } } func winSignECDSA(kh uintptr, digest []byte) ([]byte, error) { var size uint32 // Obtain the size of the signature r, _, _ := winNCryptSignHash.Call( kh, 0, uintptr(unsafe.Pointer(&digest[0])), uintptr(len(digest)), 0, 0, uintptr(unsafe.Pointer(&size)), 0) if r != 0 { return nil, ErrStoreECDSASigningError } // Obtain the signature data buf := make([]byte, size) r, _, _ = winNCryptSignHash.Call( kh, 0, uintptr(unsafe.Pointer(&digest[0])), uintptr(len(digest)), uintptr(unsafe.Pointer(&buf[0])), uintptr(size), uintptr(unsafe.Pointer(&size)), 0) if r != 0 { return nil, ErrStoreECDSASigningError } if len(buf) != int(size) { return nil, ErrStoreECDSASigningError } return winPackECDSASigValue(bytes.NewReader(buf[:size]), len(digest)) } func winPackECDSASigValue(r io.Reader, digestLength int) ([]byte, error) { sigR := make([]byte, digestLength) if _, err := io.ReadFull(r, sigR); err != nil { return nil, ErrStoreECDSASigningError } sigS := make([]byte, digestLength) if _, err := io.ReadFull(r, sigS); err != nil { return nil, ErrStoreECDSASigningError } var b cryptobyte.Builder b.AddASN1(asn1.SEQUENCE, func(b *cryptobyte.Builder) { b.AddASN1BigInt(new(big.Int).SetBytes(sigR)) b.AddASN1BigInt(new(big.Int).SetBytes(sigS)) }) return b.Bytes() } func winSignRSAPKCS1Padding(kh uintptr, digest []byte, algID *uint16) ([]byte, error) { // PKCS#1 v1.5 padding for some TLS 1.2 padInfo := winPKCS1PaddingInfo{pszAlgID: algID} var size uint32 // Obtain the size of the signature r, _, _ := winNCryptSignHash.Call( kh, uintptr(unsafe.Pointer(&padInfo)), uintptr(unsafe.Pointer(&digest[0])), uintptr(len(digest)), 0, 0, uintptr(unsafe.Pointer(&size)), winBCryptPadPKCS1) if r != 0 { return nil, ErrStoreRSASigningError } // Obtain the signature data sig := make([]byte, size) r, _, _ = winNCryptSignHash.Call( kh, uintptr(unsafe.Pointer(&padInfo)), uintptr(unsafe.Pointer(&digest[0])), uintptr(len(digest)), uintptr(unsafe.Pointer(&sig[0])), uintptr(size), uintptr(unsafe.Pointer(&size)), winBCryptPadPKCS1) if r != 0 { return nil, ErrStoreRSASigningError } return sig[:size], nil } func winSignRSAPSSPadding(kh uintptr, digest []byte, algID *uint16) ([]byte, error) { // PSS padding for TLS 1.3 and some TLS 1.2 padInfo := winPSSPaddingInfo{pszAlgID: algID, cbSalt: winBCryptPadPSSSalt} var size uint32 // Obtain the size of the signature r, _, _ := winNCryptSignHash.Call( kh, uintptr(unsafe.Pointer(&padInfo)), uintptr(unsafe.Pointer(&digest[0])), uintptr(len(digest)), 0, 0, uintptr(unsafe.Pointer(&size)), winBCryptPadPSS) if r != 0 { return nil, ErrStoreRSASigningError } // Obtain the signature data sig := make([]byte, size) r, _, _ = winNCryptSignHash.Call( kh, uintptr(unsafe.Pointer(&padInfo)), uintptr(unsafe.Pointer(&digest[0])), uintptr(len(digest)), uintptr(unsafe.Pointer(&sig[0])), uintptr(size), uintptr(unsafe.Pointer(&size)), winBCryptPadPSS) if r != 0 { return nil, ErrStoreRSASigningError } return sig[:size], nil } // certKey wraps CryptAcquireCertificatePrivateKey. It obtains the CNG private // key of a known certificate and returns a pointer to a winKey which implements // both crypto.Signer. When a nil cert context is passed // a nil key is intentionally returned, to model the expected behavior of a // non-existent cert having no private key. // https://docs.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-cryptacquirecertificateprivatekey func (w *winCertStore) certKey(cert *windows.CertContext) (*winKey, error) { // Return early if a nil cert was passed. if cert == nil { return nil, nil } var ( kh uintptr spec uint32 mustFree int ) r, _, _ := winCryptAcquireCertificatePrivateKey.Call( uintptr(unsafe.Pointer(cert)), winAcquireCached|winAcquireSilent|winAcquireOnlyNCryptKey, 0, // Reserved, must be null. uintptr(unsafe.Pointer(&kh)), uintptr(unsafe.Pointer(&spec)), uintptr(unsafe.Pointer(&mustFree)), ) // If the function succeeds, the return value is nonzero (TRUE). if r == 0 { return nil, ErrNoPrivateKeyStoreRef } if mustFree != 0 { return nil, ErrNoPrivateKeyStoreRef } if spec != winNcryptKeySpec { return nil, ErrNoPrivateKeyStoreRef } return winKeyMetadata(kh) } func winKeyMetadata(kh uintptr) (*winKey, error) { // uc is used to populate the unique container name attribute of the private key uc, err := winGetPropertyStr(kh, winNCryptUniqueNameProperty) if err != nil { // unable to determine key unique name return nil, ErrExtractingPrivateKeyMetadata } alg, err := winGetPropertyStr(kh, winNCryptAlgorithmGroupProperty) if err != nil { // unable to determine key algorithm return nil, ErrExtractingPrivateKeyMetadata } var pub crypto.PublicKey switch alg { case "ECDSA", "ECDH": buf, err := winExport(kh, winBCryptECCPublicBlob) if err != nil { // failed to export ECC public key return nil, ErrExtractingECCPublicKey } pub, err = unmarshalECC(buf, kh) if err != nil { return nil, ErrExtractingECCPublicKey } case "RSA": buf, err := winExport(kh, winBCryptRSAPublicBlob) if err != nil { return nil, ErrExtractingRSAPublicKey } pub, err = winUnmarshalRSA(buf) if err != nil { return nil, ErrExtractingRSAPublicKey } default: return nil, ErrBadPublicKeyAlgorithm } return &winKey{handle: kh, pub: pub, Container: uc, AlgorithmGroup: alg}, nil } func winGetProperty(kh uintptr, property *uint16) ([]byte, error) { var strSize uint32 r, _, _ := winNCryptGetProperty.Call( kh, uintptr(unsafe.Pointer(property)), 0, 0, uintptr(unsafe.Pointer(&strSize)), 0, 0) if r != 0 { return nil, ErrExtractPropertyFromKey } buf := make([]byte, strSize) r, _, _ = winNCryptGetProperty.Call( kh, uintptr(unsafe.Pointer(property)), uintptr(unsafe.Pointer(&buf[0])), uintptr(strSize), uintptr(unsafe.Pointer(&strSize)), 0, 0) if r != 0 { return nil, ErrExtractPropertyFromKey } return buf, nil } func winGetPropertyStr(kh uintptr, property *uint16) (string, error) { buf, err := winFnGetProperty(kh, property) if err != nil { return "", ErrExtractPropertyFromKey } uc := bytes.ReplaceAll(buf, []byte{0x00}, []byte("")) return string(uc), nil } func winExport(kh uintptr, blobType *uint16) ([]byte, error) { var size uint32 // When obtaining the size of a public key, most parameters are not required r, _, _ := winNCryptExportKey.Call( kh, 0, uintptr(unsafe.Pointer(blobType)), 0, 0, 0, uintptr(unsafe.Pointer(&size)), 0) if r != 0 { return nil, ErrExtractingPublicKey } // Place the exported key in buf now that we know the size required buf := make([]byte, size) r, _, _ = winNCryptExportKey.Call( kh, 0, uintptr(unsafe.Pointer(blobType)), 0, uintptr(unsafe.Pointer(&buf[0])), uintptr(size), uintptr(unsafe.Pointer(&size)), 0) if r != 0 { return nil, ErrExtractingPublicKey } return buf, nil } func unmarshalECC(buf []byte, kh uintptr) (*ecdsa.PublicKey, error) { // BCRYPT_ECCKEY_BLOB from bcrypt.h header := struct { Magic uint32 Key uint32 }{} r := bytes.NewReader(buf) if err := binary.Read(r, binary.LittleEndian, &header); err != nil { return nil, ErrExtractingECCPublicKey } curve, ok := winCurveIDs[header.Magic] if !ok { // Fix for b/185945636, where despite specifying the curve, nCrypt returns // an incorrect response with BCRYPT_ECDSA_PUBLIC_GENERIC_MAGIC. var err error curve, err = winCurveName(kh) if err != nil { // unsupported header magic or cannot match the curve by name return nil, err } } keyX := make([]byte, header.Key) if n, err := r.Read(keyX); n != int(header.Key) || err != nil { // failed to read key X return nil, ErrExtractingECCPublicKey } keyY := make([]byte, header.Key) if n, err := r.Read(keyY); n != int(header.Key) || err != nil { // failed to read key Y return nil, ErrExtractingECCPublicKey } pub := &ecdsa.PublicKey{ Curve: curve, X: new(big.Int).SetBytes(keyX), Y: new(big.Int).SetBytes(keyY), } return pub, nil } // winCurveName reads the curve name property and returns the corresponding curve. func winCurveName(kh uintptr) (elliptic.Curve, error) { cn, err := winGetPropertyStr(kh, winNCryptECCCurveNameProperty) if err != nil { // unable to determine the curve property name return nil, ErrExtractPropertyFromKey } curve, ok := winCurveNames[cn] if !ok { // unknown curve name return nil, ErrBadECCCurveName } return curve, nil } func winUnmarshalRSA(buf []byte) (*rsa.PublicKey, error) { // BCRYPT_RSA_BLOB from bcrypt.h header := struct { Magic uint32 BitLength uint32 PublicExpSize uint32 ModulusSize uint32 UnusedPrime1 uint32 UnusedPrime2 uint32 }{} r := bytes.NewReader(buf) if err := binary.Read(r, binary.LittleEndian, &header); err != nil { return nil, ErrExtractingRSAPublicKey } if header.Magic != winRSA1Magic { // invalid header magic return nil, ErrExtractingRSAPublicKey } if header.PublicExpSize > 8 { // unsupported public exponent size return nil, ErrExtractingRSAPublicKey } exp := make([]byte, 8) if n, err := r.Read(exp[8-header.PublicExpSize:]); n != int(header.PublicExpSize) || err != nil { // failed to read public exponent return nil, ErrExtractingRSAPublicKey } mod := make([]byte, header.ModulusSize) if n, err := r.Read(mod); n != int(header.ModulusSize) || err != nil { // failed to read modulus return nil, ErrExtractingRSAPublicKey } pub := &rsa.PublicKey{ N: new(big.Int).SetBytes(mod), E: int(binary.BigEndian.Uint64(exp)), } return pub, nil } // storeHandle returns a handle to a given cert store, opening the handle as needed. func (w *winCertStore) storeHandle(provider uint32, store *uint16) (windows.Handle, error) { w.mu.Lock() defer w.mu.Unlock() key := fmt.Sprintf("%d%s", provider, windows.UTF16PtrToString(store)) var err error if w.stores[key] == nil { w.stores[key], err = winNewStoreHandle(provider, store) if err != nil { return 0, ErrBadCryptoStoreProvider } } return *w.stores[key].handle, nil } // Verify interface conformance. var _ credential = &winKey{}