docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Support aliasMap for pretty printing on PhraseRetrieval. Better keyID printing 

Signed-off-by: Nathan McCauley <nathan.mccauley@docker.com>
This commit is contained in:
Nathan McCauley 2015-07-31 12:32:44 -07:00
parent 056622d801
commit bbacddb539
1 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
pkg/passphrase/passphrase.go
View File

@ -22,7 +22,7 @@ import (
type Retriever func(keyName, alias string, createNew bool, attempts int) (passphrase string, giveup bool, err error) type Retriever func(keyName, alias string, createNew bool, attempts int) (passphrase string, giveup bool, err error)
const ( const (
idBytesToDisplay = 5 idBytesToDisplay = 7
tufRootAlias = "root" tufRootAlias = "root"
tufTargetsAlias = "targets" tufTargetsAlias = "targets"
tufSnapshotAlias = "snapshot" tufSnapshotAlias = "snapshot"
@ -46,23 +46,35 @@ var (
// ErrTooManyAttempts is returned if the maximum number of passphrase // ErrTooManyAttempts is returned if the maximum number of passphrase
// entry attempts is reached. // entry attempts is reached.
ErrTooManyAttempts = errors.New("Too many attempts") ErrTooManyAttempts = errors.New("Too many attempts")
defaultAliasMap = map[string]string{
"root": "root",
"targets": "targets",
"snapshot": "snapshot",
"timestamps": "timestamps",
}
) )
// PromptRetriever returns a new Retriever which will provide a prompt on stdin // PromptRetriever returns a new Retriever which will provide a prompt on stdin
// and stdout to retrieve a passphrase. The passphrase will be cached such that // and stdout to retrieve a passphrase. The passphrase will be cached such that
// subsequent prompts will produce the same passphrase. // subsequent prompts will produce the same passphrase.
func PromptRetriever() Retriever { func PromptRetriever() Retriever {
return PromptRetrieverWithInOut(os.Stdin, os.Stdout) return PromptRetrieverWithInOut(os.Stdin, os.Stdout, nil)
} }
// PromptRetrieverWithInOut returns a new Retriever which will provide a // PromptRetrieverWithInOut returns a new Retriever which will provide a
// prompt using the given in and out readers. The passphrase will be cached // prompt using the given in and out readers. The passphrase will be cached
// such that subsequent prompts will produce the same passphrase. // such that subsequent prompts will produce the same passphrase.
func PromptRetrieverWithInOut(in io.Reader, out io.Writer) Retriever { // aliasMap can be used to specify display names for TUF key aliases. If aliasMap
// is nil, a sensible default will be used.
func PromptRetrieverWithInOut(in io.Reader, out io.Writer, aliasMap map[string]string) Retriever {
userEnteredTargetsSnapshotsPass := false userEnteredTargetsSnapshotsPass := false
targetsSnapshotsPass := "" targetsSnapshotsPass := ""
userEnteredRootsPass := false userEnteredRootsPass := false
rootsPass := "" rootsPass := ""
if aliasMap == nil {
aliasMap = defaultAliasMap
}
return func(keyName string, alias string, createNew bool, numAttempts int) (string, bool, error) { return func(keyName string, alias string, createNew bool, numAttempts int) (string, bool, error) {
if alias == tufRootAlias && createNew && numAttempts == 0 { if alias == tufRootAlias && createNew && numAttempts == 0 {
@ -98,15 +110,24 @@ func PromptRetrieverWithInOut(in io.Reader, out io.Writer) Retriever {
stdin := bufio.NewReader(in) stdin := bufio.NewReader(in)
indexOfLastSeparator := strings.LastIndex(keyName, string(filepath.Separator)) indexOfLastSeparator := strings.LastIndex(keyName, string(filepath.Separator))
if indexOfLastSeparator == -1 {
indexOfLastSeparator = 0
}
if len(keyName) > indexOfLastSeparator+idBytesToDisplay+1 { if len(keyName) > indexOfLastSeparator+idBytesToDisplay {
keyName = keyName[:indexOfLastSeparator+idBytesToDisplay+1] if indexOfLastSeparator > 0 {
keyNamePrefix := keyName[:indexOfLastSeparator]
keyNameID := keyName[indexOfLastSeparator+1 : indexOfLastSeparator+idBytesToDisplay+1]
keyName = keyNamePrefix + " (" + keyNameID + ")"
} else {
keyName = keyName[indexOfLastSeparator : indexOfLastSeparator+idBytesToDisplay]
}
} }
if createNew { if createNew {
fmt.Fprintf(out, "Enter passphrase for new %s key with id %s: ", alias, keyName) fmt.Fprintf(out, "Enter passphrase for new %s key with id %s: ", aliasMap[alias], keyName)
} else { } else {
fmt.Fprintf(out, "Enter key passphrase for %s key with id %s: ", alias, keyName) fmt.Fprintf(out, "Enter key passphrase for %s key with id %s: ", aliasMap[alias], keyName)
} }
passphrase, err := stdin.ReadBytes('\n') passphrase, err := stdin.ReadBytes('\n')
@ -134,7 +155,7 @@ func PromptRetrieverWithInOut(in io.Reader, out io.Writer) Retriever {
return "", false, ErrTooShort return "", false, ErrTooShort
} }
fmt.Fprintf(out, "Repeat passphrase for new %s key with id %s: ", alias, keyName) fmt.Fprintf(out, "Repeat passphrase for new %s key with id %s: ", aliasMap[alias], keyName)
confirmation, err := stdin.ReadBytes('\n') confirmation, err := stdin.ReadBytes('\n')
fmt.Fprintln(out) fmt.Fprintln(out)
if err != nil { if err != nil {