-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cert Store (aka wincert) #4268
Merged
Merged
Cert Store (aka wincert) #4268
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
// 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. | ||
|
||
package certstore | ||
|
||
import ( | ||
"crypto" | ||
"io" | ||
"runtime" | ||
"strings" | ||
) | ||
|
||
type StoreType int | ||
|
||
const MATCHBYEMPTY = 0 | ||
const STOREEMPTY = 0 | ||
|
||
const ( | ||
windowsCurrentUser StoreType = iota + 1 | ||
windowsLocalMachine | ||
) | ||
|
||
var StoreMap = map[string]StoreType{ | ||
"windowscurrentuser": windowsCurrentUser, | ||
"windowslocalmachine": windowsLocalMachine, | ||
} | ||
|
||
var StoreOSMap = map[StoreType]string{ | ||
windowsCurrentUser: "windows", | ||
windowsLocalMachine: "windows", | ||
} | ||
|
||
type MatchByType int | ||
|
||
const ( | ||
matchByIssuer MatchByType = iota + 1 | ||
matchBySubject | ||
) | ||
|
||
var MatchByMap = map[string]MatchByType{ | ||
"issuer": matchByIssuer, | ||
"subject": matchBySubject, | ||
} | ||
|
||
var Usage = ` | ||
In place of cert_file and key_file you may use the windows certificate store: | ||
|
||
tls { | ||
cert_store: "WindowsCurrentUser" | ||
cert_match_by: "Subject" | ||
cert_match: "MyServer123" | ||
} | ||
` | ||
|
||
func ParseCertStore(certStore string) (StoreType, error) { | ||
certStoreType, exists := StoreMap[strings.ToLower(certStore)] | ||
if !exists { | ||
return 0, ErrBadCertStore | ||
} | ||
validOS, exists := StoreOSMap[certStoreType] | ||
if !exists || validOS != runtime.GOOS { | ||
return 0, ErrOSNotCompatCertStore | ||
} | ||
return certStoreType, nil | ||
} | ||
|
||
func ParseCertMatchBy(certMatchBy string) (MatchByType, error) { | ||
certMatchByType, exists := MatchByMap[strings.ToLower(certMatchBy)] | ||
if !exists { | ||
return 0, ErrBadMatchByType | ||
} | ||
return certMatchByType, nil | ||
} | ||
|
||
// credential provides access to a public key and is a crypto.Signer. | ||
type credential interface { | ||
// Public returns the public key corresponding to the leaf certificate. | ||
Public() crypto.PublicKey | ||
// Sign signs digest with the private key. | ||
Sign(rand io.Reader, digest []byte, opts crypto.SignerOpts) (signature []byte, err error) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
// 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. | ||
|
||
//go:build !windows | ||
|
||
package certstore | ||
|
||
import ( | ||
"crypto" | ||
"crypto/tls" | ||
"io" | ||
) | ||
|
||
var _ = MATCHBYEMPTY | ||
|
||
// otherKey implements crypto.Signer and crypto.Decrypter to satisfy linter on platforms that don't implement certstore | ||
type otherKey struct{} | ||
|
||
func TLSConfig(certStore StoreType, certMatchBy MatchByType, certMatch string, config *tls.Config) error { | ||
_, _, _, _ = certStore, certMatchBy, certMatch, config | ||
return ErrOSNotCompatCertStore | ||
} | ||
|
||
// Public always returns nil public key since this is a stub on non-supported platform | ||
func (k otherKey) Public() crypto.PublicKey { | ||
return nil | ||
} | ||
|
||
// Sign always returns a nil signature since this is a stub on non-supported platform | ||
func (k otherKey) Sign(rand io.Reader, digest []byte, opts crypto.SignerOpts) (signature []byte, err error) { | ||
_, _, _ = rand, digest, opts | ||
return nil, nil | ||
} | ||
|
||
// Verify interface conformance. | ||
var _ credential = &otherKey{} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stub implementation for non-Windows ties back to L26 comment and root avoidance of creating a Windows platform copy of
opts.go
since that is such a special source code file to keep maintained.L40-41 in particular could be alternately phrased as:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops. Gave an alternate phrasing example for L29-32, not L40-41 but same thing. Linters complaining about unused variables...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For more background, this code in
opts.go
is cross-platform:nats-server/server/opts.go
Line 4342 in f854e95
The options and interface potentially directly usable if we want to tie into other 3rd-party stores in future...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the better pattern is to change the args to the functions as
_