mirror of
https://github.com/docker/docker-credential-helpers.git
synced 2026-06-28 07:11:36 +05:30
Compare commits
49 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fc9290adbc | |||
| 8369960895 | |||
| e4a625d24b | |||
| f552261f32 | |||
| 7a2694fc98 | |||
| 4b9fe97b79 | |||
| 0232333efa | |||
| 38bea2ce27 | |||
| c9a35c136e | |||
| 431b64c703 | |||
| 951b97d7f5 | |||
| f7d32862eb | |||
| 699f1d6790 | |||
| f4b8a8531e | |||
| f76f0b3f33 | |||
| f78081d1f7 | |||
| 4e7d4a98a4 | |||
| 43d1f2919f | |||
| 7b072d4d2e | |||
| c0c41f47b2 | |||
| 69fb197018 | |||
| 86b653a9f1 | |||
| 88f932172b | |||
| 54f0238b6b | |||
| 2bf42cfd47 | |||
| 1c9f7ede70 | |||
| 87c80bfba5 | |||
| 680ca48e6d | |||
| f6d4261609 | |||
| f755519945 | |||
| 11d9f9dba7 | |||
| beda055c57 | |||
| 22b8706efa | |||
| 8a9f93a99f | |||
| 063cca0a6d | |||
| 152d64310b | |||
| 77e30bd9dd | |||
| 74636a1592 | |||
| a3c1b5b757 | |||
| 6f4b0a7c06 | |||
| 1546024a83 | |||
| ecb01138bd | |||
| df92c83808 | |||
| 123ba1b7cd | |||
| 9c18f033f7 | |||
| d6c1f136e4 | |||
| 73e5f5dbfe | |||
| 302e4ae938 | |||
| 79f93e5e69 |
+3
-34
@@ -3,19 +3,14 @@
|
|||||||
sudo: required
|
sudo: required
|
||||||
language: go
|
language: go
|
||||||
dist: trusty
|
dist: trusty
|
||||||
osx_image: xcode9
|
osx_image: xcode10.1
|
||||||
os:
|
os:
|
||||||
- linux
|
- linux
|
||||||
- osx
|
- osx
|
||||||
notifications:
|
notifications:
|
||||||
email: false
|
email: false
|
||||||
go:
|
go:
|
||||||
- 1.8.1
|
- 1.12.x
|
||||||
before_install:
|
|
||||||
# work-around for issue https://github.com/travis-ci/travis-ci/issues/6307
|
|
||||||
# might not be necessary in the future
|
|
||||||
- command curl -sSL https://rvm.io/mpapis.asc | gpg --import -
|
|
||||||
- rvm get stable
|
|
||||||
addons:
|
addons:
|
||||||
apt:
|
apt:
|
||||||
packages:
|
packages:
|
||||||
@@ -24,32 +19,6 @@
|
|||||||
before_script:
|
before_script:
|
||||||
- make deps
|
- make deps
|
||||||
- "export DISPLAY=:99.0"
|
- "export DISPLAY=:99.0"
|
||||||
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sh ci/before_script_linux.sh; fi
|
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sh ci/before_script_linux.sh; fi
|
||||||
- make validate
|
- make validate
|
||||||
script: make test
|
script: make test
|
||||||
|
|
||||||
before_deploy:
|
|
||||||
- sh ci/before_deploy.sh
|
|
||||||
|
|
||||||
deploy:
|
|
||||||
provider: releases
|
|
||||||
api_key:
|
|
||||||
secure: "cGs5cao/MeVQVnum+Pr/Tpv+w83NsqGVS3wxvi3LYEf2ON4Kkmtd+Alwi0YFkGPJmSY0jZOct8NVK/M70qSnIU4l+AAq9+3KSMv23u4xrmy2sQog3AF+Ve3Rac+iYwZHOWwGs9I67CSuVv0vjJNVsDsTVefc25lHJImjRvXIS4p9xYzRPeUDCoqAo/QMVE+vFiMyxydsvt8fhd0gZCjPYWEpyHe9tjZ1tr1HsHZKFAjVb6AmF45d8rvadPoVUuLaOtr35wDC3XRKEvCZUefQpwLkrNj7j2L1rVGlY1xTE2APpLtvfd7R1Mx6kSfS1Gm3Pwcv3mugadXIhecL0lsdnU+BANjX3VUiv4ryzTPbsge966mv9ZQYwAzgCQTWRtMNJqsAnPZTeAkiOntd+HMQbPpxljOxv1sjDPY+EIZesyB3yQRJI8vMxqFcAjxeRyLcBqEnRFC2nd/Ln0KZ7ZFu16FcpNqRojdBayyypuXKqAiBNwtp4ti/65x8eHfBJuNjJtNZkRsJEYam4CYMRLxds9plKQfkaZ8045PKpyXO8fMpUhrfqSVID4IrYvD+io6XoXtdR4Lk6isZ2EgrjdrqgdG70S5lwKihL4iAi2F2ZCWhngFhkeNVOZunEWE6qZMk5wKODajR9sixGDApGPZQVojHwCNRGILZaHZ39JCIj3s="
|
|
||||||
# upload file artifacts using a glob expression.
|
|
||||||
# It requires both options `file_glob` and `file`:
|
|
||||||
# https://github.com/travis-ci/dpl/blob/master/lib/dpl/provider/releases.rb#L47-L53
|
|
||||||
file_glob: true
|
|
||||||
file: docker-credential-*-${TRAVIS_TAG}-amd64.tar.gz
|
|
||||||
# don't delete the artifacts from previous phases
|
|
||||||
skip_cleanup: true
|
|
||||||
# deploy when a new tag is pushed
|
|
||||||
on:
|
|
||||||
tags: true
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
# Pushes and PR to the master branch
|
|
||||||
- master
|
|
||||||
# IMPORTANT Ruby regex to match tags. Required, or travis won't trigger deploys when a new tag
|
|
||||||
# is pushed. This regex matches semantic versions like v1.2.3-rc4+2016.02.22
|
|
||||||
- /^v\d+\.\d+\.\d+.*$/
|
|
||||||
|
|||||||
Vendored
+83
@@ -0,0 +1,83 @@
|
|||||||
|
pipeline {
|
||||||
|
agent none
|
||||||
|
options {
|
||||||
|
checkoutToSubdirectory('src/github.com/docker/docker-credential-helpers')
|
||||||
|
}
|
||||||
|
stages {
|
||||||
|
stage('build') {
|
||||||
|
parallel {
|
||||||
|
stage('linux') {
|
||||||
|
agent {
|
||||||
|
kubernetes {
|
||||||
|
label 'declarative'
|
||||||
|
containerTemplate {
|
||||||
|
name 'golang'
|
||||||
|
image 'golang:1.12.4'
|
||||||
|
ttyEnabled true
|
||||||
|
command 'cat'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
environment {
|
||||||
|
GOPATH = pwd()
|
||||||
|
PATH = "/usr/local/go/bin:${GOPATH}/bin:$PATH"
|
||||||
|
}
|
||||||
|
steps {
|
||||||
|
container('golang') {
|
||||||
|
dir('src/github.com/docker/docker-credential-helpers') {
|
||||||
|
sh 'apt-get update && apt-get install -y libsecret-1-dev pass'
|
||||||
|
sh 'make deps fmt lint test'
|
||||||
|
sh 'make pass secretservice'
|
||||||
|
sh 'make linuxrelease'
|
||||||
|
archiveArtifacts 'release/docker-credential-*'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stage('mac') {
|
||||||
|
agent {
|
||||||
|
label 'mac-build && go1.12.4'
|
||||||
|
}
|
||||||
|
environment {
|
||||||
|
PATH = "/usr/local/go/bin:${GOPATH}/bin:$PATH"
|
||||||
|
GOPATH = pwd()
|
||||||
|
}
|
||||||
|
steps {
|
||||||
|
dir('src/github.com/docker/docker-credential-helpers') {
|
||||||
|
sh 'make deps fmt lint test'
|
||||||
|
sh 'make osxcodesign'
|
||||||
|
sh 'make osxrelease'
|
||||||
|
archiveArtifacts 'release/docker-credential-*'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stage('windows') {
|
||||||
|
agent {
|
||||||
|
label 'win-build && go1.12.4'
|
||||||
|
}
|
||||||
|
environment {
|
||||||
|
GOPATH = pwd()
|
||||||
|
PATH = "${pwd()}/bin;$PATH"
|
||||||
|
PFX = credentials('windows-build-2019-pfx')
|
||||||
|
PFXPASSWORD = credentials('windows-build-2019-pfx-password')
|
||||||
|
}
|
||||||
|
steps {
|
||||||
|
dir('src/github.com/docker/docker-credential-helpers') {
|
||||||
|
sh 'echo ${PFX} | base64 -d > pfx'
|
||||||
|
|
||||||
|
sh 'make deps fmt lint test'
|
||||||
|
sh 'make wincred'
|
||||||
|
bat """ "C:\\Program Files (x86)\\Windows Kits\\10\\bin\\x86\\signtool.exe" sign /fd SHA256 /a /f pfx /p ${PFXPASSWORD} /d Docker /du https://www.docker.com /t http://timestamp.verisign.com/scripts/timestamp.dll bin\\docker-credential-wincred.exe """
|
||||||
|
archiveArtifacts 'bin/docker-credential-*'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
post {
|
||||||
|
always {
|
||||||
|
sh 'rm -f pfx'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -6,7 +6,7 @@ VERSION := $(shell grep 'const Version' credentials/version.go | awk -F'"' '{ pr
|
|||||||
all: test
|
all: test
|
||||||
|
|
||||||
deps:
|
deps:
|
||||||
go get -u github.com/golang/lint/golint
|
go get -u golang.org/x/lint/golint
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf bin
|
rm -rf bin
|
||||||
@@ -21,26 +21,29 @@ osxcodesign: osxkeychain
|
|||||||
xcrun -log codesign -s $(SIGNINGHASH) --force --verbose bin/docker-credential-osxkeychain
|
xcrun -log codesign -s $(SIGNINGHASH) --force --verbose bin/docker-credential-osxkeychain
|
||||||
xcrun codesign --verify --deep --strict --verbose=2 --display bin/docker-credential-osxkeychain
|
xcrun codesign --verify --deep --strict --verbose=2 --display bin/docker-credential-osxkeychain
|
||||||
|
|
||||||
osxrelease: clean vet_osx lint fmt test osxcodesign
|
|
||||||
mkdir -p release
|
|
||||||
@echo "\nPackaging version ${VERSION}\n"
|
|
||||||
cd bin && tar cvfz ../release/docker-credential-osxkeychain-v$(VERSION)-amd64.tar.gz docker-credential-osxkeychain
|
|
||||||
|
|
||||||
secretservice:
|
secretservice:
|
||||||
mkdir -p bin
|
mkdir -p bin
|
||||||
go build -o bin/docker-credential-secretservice secretservice/cmd/main_linux.go
|
go build -o bin/docker-credential-secretservice secretservice/cmd/main_linux.go
|
||||||
|
|
||||||
pass:
|
pass:
|
||||||
mkdir -p bin
|
mkdir -p bin
|
||||||
go build -o bin/docker-credential-pass pass/cmd/main_linux.go
|
go build -o bin/docker-credential-pass pass/cmd/main.go
|
||||||
|
|
||||||
wincred:
|
wincred:
|
||||||
mkdir -p bin
|
mkdir -p bin
|
||||||
go build -o bin/docker-credential-wincred.exe wincred/cmd/main_windows.go
|
go build -o bin/docker-credential-wincred.exe wincred/cmd/main_windows.go
|
||||||
|
|
||||||
winrelease: clean vet_win lint fmt test wincred
|
linuxrelease:
|
||||||
|
mkdir -p release
|
||||||
|
cd bin && tar cvfz ../release/docker-credential-pass-v$(VERSION)-amd64.tar.gz docker-credential-pass
|
||||||
|
cd bin && tar cvfz ../release/docker-credential-secretservice-v$(VERSION)-amd64.tar.gz docker-credential-secretservice
|
||||||
|
|
||||||
|
osxrelease:
|
||||||
|
mkdir -p release
|
||||||
|
cd bin && tar cvfz ../release/docker-credential-osxkeychain-v$(VERSION)-amd64.tar.gz docker-credential-osxkeychain
|
||||||
|
|
||||||
|
winrelease:
|
||||||
mkdir -p release
|
mkdir -p release
|
||||||
@echo "\nPackaging version ${VERSION}\n"
|
|
||||||
cd bin && zip ../release/docker-credential-wincred-v$(VERSION)-amd64.zip docker-credential-wincred.exe
|
cd bin && zip ../release/docker-credential-wincred-v$(VERSION)-amd64.zip docker-credential-wincred.exe
|
||||||
|
|
||||||
test:
|
test:
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The programs in this repository are written with the Go programming language. Th
|
|||||||
$ go get github.com/docker/docker-credential-helpers
|
$ go get github.com/docker/docker-credential-helpers
|
||||||
```
|
```
|
||||||
|
|
||||||
2 - Use `make` to build the program you want. That will leave any executable in the `bin` directory inside the repository.
|
2 - Use `make` to build the program you want. That will leave an executable in the `bin` directory inside the repository.
|
||||||
|
|
||||||
```
|
```
|
||||||
$ cd $GOPATH/docker/docker-credentials-helpers
|
$ cd $GOPATH/docker/docker-credentials-helpers
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
image: Visual Studio 2015
|
|
||||||
environment:
|
|
||||||
GOPATH: c:\gopath
|
|
||||||
|
|
||||||
stack: go 1.8.7
|
|
||||||
|
|
||||||
clone_folder: c:\gopath\src\github.com\docker\docker-credential-helpers
|
|
||||||
clone_depth: 10
|
|
||||||
|
|
||||||
before_build:
|
|
||||||
- set PATH=%PATH%;C:\MinGW\bin;
|
|
||||||
|
|
||||||
build_script:
|
|
||||||
- mingw32-make vet_win wincred
|
|
||||||
|
|
||||||
test_script:
|
|
||||||
- mingw32-make test
|
|
||||||
|
|
||||||
deploy: off
|
|
||||||
|
|
||||||
artifacts:
|
|
||||||
- path: bin/docker-credential-wincred.exe
|
|
||||||
|
|
||||||
configuration: Release
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
set -ex
|
|
||||||
|
|
||||||
mkdir bin
|
|
||||||
case "$TRAVIS_OS_NAME" in
|
|
||||||
"osx")
|
|
||||||
go build -o bin/docker-credential-osxkeychain osxkeychain/cmd/main_darwin.go
|
|
||||||
cd bin
|
|
||||||
tar czf ../docker-credential-osxkeychain-${TRAVIS_TAG}-amd64.tar.gz docker-credential-osxkeychain
|
|
||||||
;;
|
|
||||||
"linux")
|
|
||||||
go build -o bin/docker-credential-secretservice secretservice/cmd/main_linux.go
|
|
||||||
cd bin
|
|
||||||
tar czf ../docker-credential-secretservice-${TRAVIS_TAG}-amd64.tar.gz docker-credential-secretservice
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
+2
-1
@@ -4,7 +4,8 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
|
||||||
|
exec "golang.org/x/sys/execabs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Program is an interface to execute external programs.
|
// Program is an interface to execute external programs.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
package credentials
|
package credentials
|
||||||
|
|
||||||
// Version holds a string describing the current version
|
// Version holds a string describing the current version
|
||||||
const Version = "0.6.0"
|
const Version = "0.6.4"
|
||||||
|
|||||||
@@ -0,0 +1,8 @@
|
|||||||
|
module github.com/docker/docker-credential-helpers
|
||||||
|
|
||||||
|
go 1.13
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/danieljoos/wincred v1.1.0
|
||||||
|
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4
|
||||||
|
)
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
github.com/danieljoos/wincred v1.1.0 h1:3RNcEpBg4IhIChZdFRSdlQt1QjCp1sMAPIrOnm7Yf8g=
|
||||||
|
github.com/danieljoos/wincred v1.1.0/go.mod h1:XYlo+eRTsVA9aHGp7NGjFkPla4m+DCL7hqDjlFjiygg=
|
||||||
|
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||||
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
|
||||||
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
|
github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
|
||||||
|
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
|
||||||
|
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 h1:myAQVi0cGEoqQVR5POX+8RR2mrocKqNN1hmeMqhX27k=
|
||||||
|
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
|
||||||
|
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||||
@@ -224,5 +224,4 @@ void freeListData(char *** data, unsigned int length) {
|
|||||||
for(int i=0; i<length; i++) {
|
for(int i=0; i<length; i++) {
|
||||||
free((*data)[i]);
|
free((*data)[i]);
|
||||||
}
|
}
|
||||||
free(*data);
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
package osxkeychain
|
package osxkeychain
|
||||||
|
|
||||||
/*
|
/*
|
||||||
#cgo CFLAGS: -x objective-c -mmacosx-version-min=10.10
|
#cgo CFLAGS: -x objective-c -mmacosx-version-min=10.11
|
||||||
#cgo LDFLAGS: -framework Security -framework Foundation -mmacosx-version-min=10.10
|
#cgo LDFLAGS: -framework Security -framework Foundation -mmacosx-version-min=10.11
|
||||||
|
|
||||||
#include "osxkeychain_darwin.h"
|
#include "osxkeychain_darwin.h"
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
@@ -10,18 +10,24 @@ package osxkeychain
|
|||||||
import "C"
|
import "C"
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"net/url"
|
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
|
||||||
"unsafe"
|
"unsafe"
|
||||||
|
|
||||||
"github.com/docker/docker-credential-helpers/credentials"
|
"github.com/docker/docker-credential-helpers/credentials"
|
||||||
|
"github.com/docker/docker-credential-helpers/registryurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
// errCredentialsNotFound is the specific error message returned by OS X
|
// errCredentialsNotFound is the specific error message returned by OS X
|
||||||
// when the credentials are not in the keychain.
|
// when the credentials are not in the keychain.
|
||||||
const errCredentialsNotFound = "The specified item could not be found in the keychain."
|
const errCredentialsNotFound = "The specified item could not be found in the keychain."
|
||||||
|
|
||||||
|
// errCredentialsNotFound is the specific error message returned by OS X
|
||||||
|
// when environment does not allow showing dialog to unlock keychain.
|
||||||
|
const errInteractionNotAllowed = "User interaction is not allowed."
|
||||||
|
|
||||||
|
// ErrInteractionNotAllowed is returned if keychain password prompt can not be shown.
|
||||||
|
var ErrInteractionNotAllowed = errors.New(`keychain cannot be accessed because the current session does not allow user interaction. The keychain may be locked; unlock it by running "security -v unlock-keychain ~/Library/Keychains/login.keychain-db" and try again`)
|
||||||
|
|
||||||
// Osxkeychain handles secrets using the OS X Keychain as store.
|
// Osxkeychain handles secrets using the OS X Keychain as store.
|
||||||
type Osxkeychain struct{}
|
type Osxkeychain struct{}
|
||||||
|
|
||||||
@@ -90,6 +96,9 @@ func (h Osxkeychain) Get(serverURL string) (string, string, error) {
|
|||||||
if goMsg == errCredentialsNotFound {
|
if goMsg == errCredentialsNotFound {
|
||||||
return "", "", credentials.NewErrCredentialsNotFound()
|
return "", "", credentials.NewErrCredentialsNotFound()
|
||||||
}
|
}
|
||||||
|
if goMsg == errInteractionNotAllowed {
|
||||||
|
return "", "", ErrInteractionNotAllowed
|
||||||
|
}
|
||||||
|
|
||||||
return "", "", errors.New(goMsg)
|
return "", "", errors.New(goMsg)
|
||||||
}
|
}
|
||||||
@@ -110,15 +119,21 @@ func (h Osxkeychain) List() (map[string]string, error) {
|
|||||||
defer C.free(unsafe.Pointer(acctsC))
|
defer C.free(unsafe.Pointer(acctsC))
|
||||||
var listLenC C.uint
|
var listLenC C.uint
|
||||||
errMsg := C.keychain_list(credsLabelC, &pathsC, &acctsC, &listLenC)
|
errMsg := C.keychain_list(credsLabelC, &pathsC, &acctsC, &listLenC)
|
||||||
|
defer C.freeListData(&pathsC, listLenC)
|
||||||
|
defer C.freeListData(&acctsC, listLenC)
|
||||||
if errMsg != nil {
|
if errMsg != nil {
|
||||||
defer C.free(unsafe.Pointer(errMsg))
|
defer C.free(unsafe.Pointer(errMsg))
|
||||||
goMsg := C.GoString(errMsg)
|
goMsg := C.GoString(errMsg)
|
||||||
|
if goMsg == errCredentialsNotFound {
|
||||||
|
return make(map[string]string), nil
|
||||||
|
}
|
||||||
|
if goMsg == errInteractionNotAllowed {
|
||||||
|
return nil, ErrInteractionNotAllowed
|
||||||
|
}
|
||||||
|
|
||||||
return nil, errors.New(goMsg)
|
return nil, errors.New(goMsg)
|
||||||
}
|
}
|
||||||
|
|
||||||
defer C.freeListData(&pathsC, listLenC)
|
|
||||||
defer C.freeListData(&acctsC, listLenC)
|
|
||||||
|
|
||||||
var listLen int
|
var listLen int
|
||||||
listLen = int(listLenC)
|
listLen = int(listLenC)
|
||||||
pathTmp := (*[1 << 30]*C.char)(unsafe.Pointer(pathsC))[:listLen:listLen]
|
pathTmp := (*[1 << 30]*C.char)(unsafe.Pointer(pathsC))[:listLen:listLen]
|
||||||
@@ -135,7 +150,7 @@ func (h Osxkeychain) List() (map[string]string, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func splitServer(serverURL string) (*C.struct_Server, error) {
|
func splitServer(serverURL string) (*C.struct_Server, error) {
|
||||||
u, err := parseURL(serverURL)
|
u, err := registryurl.Parse(serverURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -145,7 +160,7 @@ func splitServer(serverURL string) (*C.struct_Server, error) {
|
|||||||
proto = C.kSecProtocolTypeHTTP
|
proto = C.kSecProtocolTypeHTTP
|
||||||
}
|
}
|
||||||
var port int
|
var port int
|
||||||
p := getPort(u)
|
p := registryurl.GetPort(u)
|
||||||
if p != "" {
|
if p != "" {
|
||||||
port, err = strconv.Atoi(p)
|
port, err = strconv.Atoi(p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -155,7 +170,7 @@ func splitServer(serverURL string) (*C.struct_Server, error) {
|
|||||||
|
|
||||||
return &C.struct_Server{
|
return &C.struct_Server{
|
||||||
proto: C.SecProtocolType(proto),
|
proto: C.SecProtocolType(proto),
|
||||||
host: C.CString(getHostname(u)),
|
host: C.CString(registryurl.GetHostname(u)),
|
||||||
port: C.uint(port),
|
port: C.uint(port),
|
||||||
path: C.CString(u.Path),
|
path: C.CString(u.Path),
|
||||||
}, nil
|
}, nil
|
||||||
@@ -165,32 +180,3 @@ func freeServer(s *C.struct_Server) {
|
|||||||
C.free(unsafe.Pointer(s.host))
|
C.free(unsafe.Pointer(s.host))
|
||||||
C.free(unsafe.Pointer(s.path))
|
C.free(unsafe.Pointer(s.path))
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseURL parses and validates a given serverURL to an url.URL, and
|
|
||||||
// returns an error if validation failed. Querystring parameters are
|
|
||||||
// omitted in the resulting URL, because they are not used in the helper.
|
|
||||||
//
|
|
||||||
// If serverURL does not have a valid scheme, `//` is used as scheme
|
|
||||||
// before parsing. This prevents the hostname being used as path,
|
|
||||||
// and the credentials being stored without host.
|
|
||||||
func parseURL(serverURL string) (*url.URL, error) {
|
|
||||||
// Check if serverURL has a scheme, otherwise add `//` as scheme.
|
|
||||||
if !strings.Contains(serverURL, "://") && !strings.HasPrefix(serverURL, "//") {
|
|
||||||
serverURL = "//" + serverURL
|
|
||||||
}
|
|
||||||
|
|
||||||
u, err := url.Parse(serverURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if u.Scheme != "" && u.Scheme != "https" && u.Scheme != "http" {
|
|
||||||
return nil, errors.New("unsupported scheme: " + u.Scheme)
|
|
||||||
}
|
|
||||||
if getHostname(u) == "" {
|
|
||||||
return nil, errors.New("no hostname in URL")
|
|
||||||
}
|
|
||||||
|
|
||||||
u.RawQuery = ""
|
|
||||||
return u, nil
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
package osxkeychain
|
package osxkeychain
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/docker/docker-credential-helpers/credentials"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/docker/docker-credential-helpers/credentials"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestOSXKeychainHelper(t *testing.T) {
|
func TestOSXKeychainHelper(t *testing.T) {
|
||||||
@@ -56,46 +56,6 @@ func TestOSXKeychainHelper(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestOSXKeychainHelperParseURL verifies that a // "scheme" is added to URLs,
|
|
||||||
// and that invalid URLs produce an error.
|
|
||||||
func TestOSXKeychainHelperParseURL(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
url string
|
|
||||||
expectedURL string
|
|
||||||
err error
|
|
||||||
}{
|
|
||||||
{url: "foobar.docker.io", expectedURL: "//foobar.docker.io"},
|
|
||||||
{url: "foobar.docker.io:2376", expectedURL: "//foobar.docker.io:2376"},
|
|
||||||
{url: "//foobar.docker.io:2376", expectedURL: "//foobar.docker.io:2376"},
|
|
||||||
{url: "http://foobar.docker.io:2376", expectedURL: "http://foobar.docker.io:2376"},
|
|
||||||
{url: "https://foobar.docker.io:2376", expectedURL: "https://foobar.docker.io:2376"},
|
|
||||||
{url: "https://foobar.docker.io:2376/some/path", expectedURL: "https://foobar.docker.io:2376/some/path"},
|
|
||||||
{url: "https://foobar.docker.io:2376/some/other/path?foo=bar", expectedURL: "https://foobar.docker.io:2376/some/other/path"},
|
|
||||||
{url: "/foobar.docker.io", err: errors.New("no hostname in URL")},
|
|
||||||
{url: "ftp://foobar.docker.io:2376", err: errors.New("unsupported scheme: ftp")},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, te := range tests {
|
|
||||||
u, err := parseURL(te.url)
|
|
||||||
|
|
||||||
if te.err == nil && err != nil {
|
|
||||||
t.Errorf("Error: failed to parse URL %q: %s", te.url, err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if te.err != nil && err == nil {
|
|
||||||
t.Errorf("Error: expected error %q, got none when parsing URL %q", te.err, te.url)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if te.err != nil && err.Error() != te.err.Error() {
|
|
||||||
t.Errorf("Error: expected error %q, got %q when parsing URL %q", te.err, err, te.url)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if u != nil && u.String() != te.expectedURL {
|
|
||||||
t.Errorf("Error: expected URL: %q, but got %q for URL: %q", te.expectedURL, u.String(), te.url)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestOSXKeychainHelperRetrieveAliases verifies that secrets can be accessed
|
// TestOSXKeychainHelperRetrieveAliases verifies that secrets can be accessed
|
||||||
// through variations on the URL
|
// through variations on the URL
|
||||||
func TestOSXKeychainHelperRetrieveAliases(t *testing.T) {
|
func TestOSXKeychainHelperRetrieveAliases(t *testing.T) {
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
//+build go1.8
|
|
||||||
|
|
||||||
package osxkeychain
|
|
||||||
|
|
||||||
import "net/url"
|
|
||||||
|
|
||||||
func getHostname(u *url.URL) string {
|
|
||||||
return u.Hostname()
|
|
||||||
}
|
|
||||||
|
|
||||||
func getPort(u *url.URL) string {
|
|
||||||
return u.Port()
|
|
||||||
}
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
// A `pass` based credential helper. Passwords are stored as arguments to pass
|
// Package pass implements a `pass` based credential helper. Passwords are stored
|
||||||
// of the form: "$PASS_FOLDER/base64-url(serverURL)/username". We base64-url
|
// as arguments to pass of the form: "$PASS_FOLDER/base64-url(serverURL)/username".
|
||||||
// encode the serverURL, because under the hood pass uses files and folders, so
|
// We base64-url encode the serverURL, because under the hood pass uses files and
|
||||||
// /s will get translated into additional folders.
|
// folders, so /s will get translated into additional folders.
|
||||||
package pass
|
package pass
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -19,7 +19,8 @@ import (
|
|||||||
"github.com/docker/docker-credential-helpers/credentials"
|
"github.com/docker/docker-credential-helpers/credentials"
|
||||||
)
|
)
|
||||||
|
|
||||||
const PASS_FOLDER = "docker-credential-helpers"
|
// PASS_FOLDER contains the directory where credentials are stored
|
||||||
|
const PASS_FOLDER = "docker-credential-helpers" //nolint: golint
|
||||||
|
|
||||||
// Pass handles secrets using Linux secret-service as a store.
|
// Pass handles secrets using Linux secret-service as a store.
|
||||||
type Pass struct{}
|
type Pass struct{}
|
||||||
@@ -46,25 +47,10 @@ func (p Pass) checkInitialized() error {
|
|||||||
if passInitialized {
|
if passInitialized {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
// In principle, we could just run `pass init`. However, pass has a bug
|
// We just run a `pass ls`, if it fails then pass is not initialized.
|
||||||
// where if gpg fails, it doesn't always exit 1. Additionally, pass
|
_, err := p.runPassHelper("", "ls")
|
||||||
// uses gpg2, but gpg is the default, which may be confusing. So let's
|
|
||||||
// just explictily check that pass actually can store and retreive a
|
|
||||||
// password.
|
|
||||||
password := "pass is initialized"
|
|
||||||
name := path.Join(getPassDir(), "docker-pass-initialized-check")
|
|
||||||
|
|
||||||
_, err := p.runPassHelper(password, "insert", "-f", "-m", name)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("error initializing pass: %v", err)
|
return fmt.Errorf("pass not initialized: %v", err)
|
||||||
}
|
|
||||||
|
|
||||||
stored, err := p.runPassHelper("", "show", name)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("error fetching password during initialization: %v", err)
|
|
||||||
}
|
|
||||||
if stored != password {
|
|
||||||
return fmt.Errorf("error round-tripping password during initialization: %q != %q", password, stored)
|
|
||||||
}
|
}
|
||||||
passInitialized = true
|
passInitialized = true
|
||||||
return nil
|
return nil
|
||||||
@@ -94,25 +80,25 @@ func (p Pass) runPassHelper(stdinContent string, args ...string) (string, error)
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Add adds new credentials to the keychain.
|
// Add adds new credentials to the keychain.
|
||||||
func (h Pass) Add(creds *credentials.Credentials) error {
|
func (p Pass) Add(creds *credentials.Credentials) error {
|
||||||
if creds == nil {
|
if creds == nil {
|
||||||
return errors.New("missing credentials")
|
return errors.New("missing credentials")
|
||||||
}
|
}
|
||||||
|
|
||||||
encoded := base64.URLEncoding.EncodeToString([]byte(creds.ServerURL))
|
encoded := base64.URLEncoding.EncodeToString([]byte(creds.ServerURL))
|
||||||
|
|
||||||
_, err := h.runPass(creds.Secret, "insert", "-f", "-m", path.Join(PASS_FOLDER, encoded, creds.Username))
|
_, err := p.runPass(creds.Secret, "insert", "-f", "-m", path.Join(PASS_FOLDER, encoded, creds.Username))
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Delete removes credentials from the store.
|
// Delete removes credentials from the store.
|
||||||
func (h Pass) Delete(serverURL string) error {
|
func (p Pass) Delete(serverURL string) error {
|
||||||
if serverURL == "" {
|
if serverURL == "" {
|
||||||
return errors.New("missing server url")
|
return errors.New("missing server url")
|
||||||
}
|
}
|
||||||
|
|
||||||
encoded := base64.URLEncoding.EncodeToString([]byte(serverURL))
|
encoded := base64.URLEncoding.EncodeToString([]byte(serverURL))
|
||||||
_, err := h.runPass("", "rm", "-rf", path.Join(PASS_FOLDER, encoded))
|
_, err := p.runPass("", "rm", "-rf", path.Join(PASS_FOLDER, encoded))
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -143,7 +129,7 @@ func listPassDir(args ...string) ([]os.FileInfo, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Get returns the username and secret to use for a given registry server URL.
|
// Get returns the username and secret to use for a given registry server URL.
|
||||||
func (h Pass) Get(serverURL string) (string, string, error) {
|
func (p Pass) Get(serverURL string) (string, string, error) {
|
||||||
if serverURL == "" {
|
if serverURL == "" {
|
||||||
return "", "", errors.New("missing server url")
|
return "", "", errors.New("missing server url")
|
||||||
}
|
}
|
||||||
@@ -168,12 +154,12 @@ func (h Pass) Get(serverURL string) (string, string, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
actual := strings.TrimSuffix(usernames[0].Name(), ".gpg")
|
actual := strings.TrimSuffix(usernames[0].Name(), ".gpg")
|
||||||
secret, err := h.runPass("", "show", path.Join(PASS_FOLDER, encoded, actual))
|
secret, err := p.runPass("", "show", path.Join(PASS_FOLDER, encoded, actual))
|
||||||
return actual, secret, err
|
return actual, secret, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// List returns the stored URLs and corresponding usernames for a given credentials label
|
// List returns the stored URLs and corresponding usernames for a given credentials label
|
||||||
func (h Pass) List() (map[string]string, error) {
|
func (p Pass) List() (map[string]string, error) {
|
||||||
servers, err := listPassDir()
|
servers, err := listPassDir()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
package registryurl
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Parse parses and validates a given serverURL to an url.URL, and
|
||||||
|
// returns an error if validation failed. Querystring parameters are
|
||||||
|
// omitted in the resulting URL, because they are not used in the helper.
|
||||||
|
//
|
||||||
|
// If serverURL does not have a valid scheme, `//` is used as scheme
|
||||||
|
// before parsing. This prevents the hostname being used as path,
|
||||||
|
// and the credentials being stored without host.
|
||||||
|
func Parse(registryURL string) (*url.URL, error) {
|
||||||
|
// Check if registryURL has a scheme, otherwise add `//` as scheme.
|
||||||
|
if !strings.Contains(registryURL, "://") && !strings.HasPrefix(registryURL, "//") {
|
||||||
|
registryURL = "//" + registryURL
|
||||||
|
}
|
||||||
|
|
||||||
|
u, err := url.Parse(registryURL)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if u.Scheme != "" && u.Scheme != "https" && u.Scheme != "http" {
|
||||||
|
return nil, errors.New("unsupported scheme: " + u.Scheme)
|
||||||
|
}
|
||||||
|
|
||||||
|
if GetHostname(u) == "" {
|
||||||
|
return nil, errors.New("no hostname in URL")
|
||||||
|
}
|
||||||
|
|
||||||
|
u.RawQuery = ""
|
||||||
|
return u, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package registryurl
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestHelperParseURL verifies that a // "scheme" is added to URLs,
|
||||||
|
// and that invalid URLs produce an error.
|
||||||
|
func TestHelperParseURL(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
url string
|
||||||
|
expectedURL string
|
||||||
|
err error
|
||||||
|
}{
|
||||||
|
{url: "foobar.docker.io", expectedURL: "//foobar.docker.io"},
|
||||||
|
{url: "foobar.docker.io:2376", expectedURL: "//foobar.docker.io:2376"},
|
||||||
|
{url: "//foobar.docker.io:2376", expectedURL: "//foobar.docker.io:2376"},
|
||||||
|
{url: "http://foobar.docker.io:2376", expectedURL: "http://foobar.docker.io:2376"},
|
||||||
|
{url: "https://foobar.docker.io:2376", expectedURL: "https://foobar.docker.io:2376"},
|
||||||
|
{url: "https://foobar.docker.io:2376/some/path", expectedURL: "https://foobar.docker.io:2376/some/path"},
|
||||||
|
{url: "https://foobar.docker.io:2376/some/other/path?foo=bar", expectedURL: "https://foobar.docker.io:2376/some/other/path"},
|
||||||
|
{url: "/foobar.docker.io", err: errors.New("no hostname in URL")},
|
||||||
|
{url: "ftp://foobar.docker.io:2376", err: errors.New("unsupported scheme: ftp")},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, te := range tests {
|
||||||
|
u, err := Parse(te.url)
|
||||||
|
|
||||||
|
if te.err == nil && err != nil {
|
||||||
|
t.Errorf("Error: failed to parse URL %q: %s", te.url, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if te.err != nil && err == nil {
|
||||||
|
t.Errorf("Error: expected error %q, got none when parsing URL %q", te.err, te.url)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if te.err != nil && err.Error() != te.err.Error() {
|
||||||
|
t.Errorf("Error: expected error %q, got %q when parsing URL %q", te.err, err, te.url)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if u != nil && u.String() != te.expectedURL {
|
||||||
|
t.Errorf("Error: expected URL: %q, but got %q for URL: %q", te.expectedURL, u.String(), te.url)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
//+build go1.8
|
||||||
|
|
||||||
|
package registryurl
|
||||||
|
|
||||||
|
import (
|
||||||
|
url "net/url"
|
||||||
|
)
|
||||||
|
|
||||||
|
// GetHostname returns the hostname of the URL
|
||||||
|
func GetHostname(u *url.URL) string {
|
||||||
|
return u.Hostname()
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPort returns the port number of the URL
|
||||||
|
func GetPort(u *url.URL) string {
|
||||||
|
return u.Port()
|
||||||
|
}
|
||||||
@@ -1,17 +1,17 @@
|
|||||||
//+build !go1.8
|
//+build !go1.8
|
||||||
|
|
||||||
package osxkeychain
|
package registryurl
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"net/url"
|
url "net/url"
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
func getHostname(u *url.URL) string {
|
func GetHostname(u *url.URL) string {
|
||||||
return stripPort(u.Host)
|
return stripPort(u.Host)
|
||||||
}
|
}
|
||||||
|
|
||||||
func getPort(u *url.URL) string {
|
func GetPort(u *url.URL) string {
|
||||||
return portOnly(u.Host)
|
return portOnly(u.Host)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,5 +158,4 @@ void freeListData(char *** data, unsigned int length) {
|
|||||||
for(i=0; i<length; i++) {
|
for(i=0; i<length; i++) {
|
||||||
free((*data)[i]);
|
free((*data)[i]);
|
||||||
}
|
}
|
||||||
free(*data);
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -92,12 +92,12 @@ func (h Secretservice) List() (map[string]string, error) {
|
|||||||
defer C.free(unsafe.Pointer(acctsC))
|
defer C.free(unsafe.Pointer(acctsC))
|
||||||
var listLenC C.uint
|
var listLenC C.uint
|
||||||
err := C.list(credsLabelC, &pathsC, &acctsC, &listLenC)
|
err := C.list(credsLabelC, &pathsC, &acctsC, &listLenC)
|
||||||
if err != nil {
|
|
||||||
defer C.free(unsafe.Pointer(err))
|
|
||||||
return nil, errors.New("Error from list function in secretservice_linux.c likely due to error in secretservice library")
|
|
||||||
}
|
|
||||||
defer C.freeListData(&pathsC, listLenC)
|
defer C.freeListData(&pathsC, listLenC)
|
||||||
defer C.freeListData(&acctsC, listLenC)
|
defer C.freeListData(&acctsC, listLenC)
|
||||||
|
if err != nil {
|
||||||
|
defer C.g_error_free(err)
|
||||||
|
return nil, errors.New("Error from list function in secretservice_linux.c likely due to error in secretservice library")
|
||||||
|
}
|
||||||
|
|
||||||
resp := make(map[string]string)
|
resp := make(map[string]string)
|
||||||
|
|
||||||
|
|||||||
@@ -19,14 +19,14 @@ func TestSecretServiceHelper(t *testing.T) {
|
|||||||
helper := Secretservice{}
|
helper := Secretservice{}
|
||||||
|
|
||||||
// Check how many docker credentials we have when starting the test
|
// Check how many docker credentials we have when starting the test
|
||||||
old_auths, err := helper.List()
|
oldAuths, err := helper.List()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// If any docker credentials with the tests values we are providing, we
|
// If any docker credentials with the tests values we are providing, we
|
||||||
// remove them as they probably come from a previous failed test
|
// remove them as they probably come from a previous failed test
|
||||||
for k, v := range old_auths {
|
for k, v := range oldAuths {
|
||||||
if strings.Compare(k, creds.ServerURL) == 0 && strings.Compare(v, creds.Username) == 0 {
|
if strings.Compare(k, creds.ServerURL) == 0 && strings.Compare(v, creds.Username) == 0 {
|
||||||
|
|
||||||
if err := helper.Delete(creds.ServerURL); err != nil {
|
if err := helper.Delete(creds.ServerURL); err != nil {
|
||||||
@@ -36,7 +36,7 @@ func TestSecretServiceHelper(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check again how many docker credentials we have when starting the test
|
// Check again how many docker credentials we have when starting the test
|
||||||
old_auths, err = helper.List()
|
oldAuths, err = helper.List()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -61,11 +61,11 @@ func TestSecretServiceHelper(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// We should have one more credential than before adding
|
// We should have one more credential than before adding
|
||||||
new_auths, err := helper.List()
|
newAuths, err := helper.List()
|
||||||
if err != nil || (len(new_auths)-len(old_auths) != 1) {
|
if err != nil || (len(newAuths)-len(oldAuths) != 1) {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
old_auths = new_auths
|
oldAuths = newAuths
|
||||||
|
|
||||||
// Deleting the credentials associated to current server url should succeed
|
// Deleting the credentials associated to current server url should succeed
|
||||||
if err := helper.Delete(creds.ServerURL); err != nil {
|
if err := helper.Delete(creds.ServerURL); err != nil {
|
||||||
@@ -73,8 +73,8 @@ func TestSecretServiceHelper(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// We should have one less credential than before deleting
|
// We should have one less credential than before deleting
|
||||||
new_auths, err = helper.List()
|
newAuths, err = helper.List()
|
||||||
if err != nil || (len(old_auths)-len(new_auths) != 1) {
|
if err != nil || (len(oldAuths)-len(newAuths) != 1) {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
*.go text eol=lf
|
||||||
+23
@@ -0,0 +1,23 @@
|
|||||||
|
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
||||||
|
*.o
|
||||||
|
*.a
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# Folders
|
||||||
|
_obj
|
||||||
|
_test
|
||||||
|
|
||||||
|
# Architecture specific extensions/prefixes
|
||||||
|
*.[568vq]
|
||||||
|
[568vq].out
|
||||||
|
|
||||||
|
*.cgo1.go
|
||||||
|
*.cgo2.c
|
||||||
|
_cgo_defun.c
|
||||||
|
_cgo_gotypes.go
|
||||||
|
_cgo_export.*
|
||||||
|
|
||||||
|
_testmain.go
|
||||||
|
|
||||||
|
*.exe
|
||||||
|
*.test
|
||||||
+98
@@ -0,0 +1,98 @@
|
|||||||
|
wincred
|
||||||
|
=======
|
||||||
|
|
||||||
|
Go wrapper around the Windows Credential Manager API functions.
|
||||||
|
|
||||||
|

|
||||||
|
[](https://godoc.org/github.com/danieljoos/wincred)
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
```Go
|
||||||
|
go get github.com/danieljoos/wincred
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
See the following examples:
|
||||||
|
|
||||||
|
### Create and store a new generic credential object
|
||||||
|
```Go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/danieljoos/wincred"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
cred := wincred.NewGenericCredential("myGoApplication")
|
||||||
|
cred.CredentialBlob = []byte("my secret")
|
||||||
|
err := cred.Write()
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Retrieve a credential object
|
||||||
|
```Go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/danieljoos/wincred"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
cred, err := wincred.GetGenericCredential("myGoApplication")
|
||||||
|
if err == nil {
|
||||||
|
fmt.Println(string(cred.CredentialBlob))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Remove a credential object
|
||||||
|
```Go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/danieljoos/wincred"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
cred, err := wincred.GetGenericCredential("myGoApplication")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
cred.Delete()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### List all available credentials
|
||||||
|
```Go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/danieljoos/wincred"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
creds, err := wincred.List()
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for i := range(creds) {
|
||||||
|
fmt.Println(creds[i].TargetName)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
+40
-30
@@ -1,3 +1,5 @@
|
|||||||
|
// +build windows
|
||||||
|
|
||||||
package wincred
|
package wincred
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -9,48 +11,57 @@ import (
|
|||||||
"unsafe"
|
"unsafe"
|
||||||
)
|
)
|
||||||
|
|
||||||
var nullPointer = unsafe.Pointer(uintptr(0))
|
// uf16PtrToString creates a Go string from a pointer to a UTF16 encoded zero-terminated string.
|
||||||
|
// Such pointers are returned from the Windows API calls.
|
||||||
// Create a Go string using a pointer to a zero-terminated UTF 16 encoded string.
|
// The function creates a copy of the string.
|
||||||
// See github.com/AllenDang/w32
|
|
||||||
func utf16PtrToString(wstr *uint16) string {
|
func utf16PtrToString(wstr *uint16) string {
|
||||||
if wstr != nil {
|
if wstr != nil {
|
||||||
buf := make([]uint16, 0, 256)
|
for len := 0; ; len++ {
|
||||||
for ptr := uintptr(unsafe.Pointer(wstr)); ; ptr += 2 {
|
ptr := unsafe.Pointer(uintptr(unsafe.Pointer(wstr)) + uintptr(len)*unsafe.Sizeof(*wstr)) // see https://golang.org/pkg/unsafe/#Pointer (3)
|
||||||
rune := *(*uint16)(unsafe.Pointer(ptr))
|
if *(*uint16)(ptr) == 0 {
|
||||||
if rune == 0 {
|
return string(utf16.Decode(*(*[]uint16)(unsafe.Pointer(&reflect.SliceHeader{
|
||||||
return string(utf16.Decode(buf))
|
Data: uintptr(unsafe.Pointer(wstr)),
|
||||||
|
Len: len,
|
||||||
|
Cap: len,
|
||||||
|
}))))
|
||||||
}
|
}
|
||||||
buf = append(buf, rune)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a byte array from a given UTF 16 char array
|
// utf16ToByte creates a byte array from a given UTF 16 char array.
|
||||||
func utf16ToByte(wstr []uint16) (result []byte) {
|
func utf16ToByte(wstr []uint16) (result []byte) {
|
||||||
result = make([]byte, len(wstr)*2)
|
result = make([]byte, len(wstr)*2)
|
||||||
for i, _ := range wstr {
|
for i := range wstr {
|
||||||
binary.LittleEndian.PutUint16(result[(i*2):(i*2)+2], wstr[i])
|
binary.LittleEndian.PutUint16(result[(i*2):(i*2)+2], wstr[i])
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Copies the given C byte array to a Go byte array (see `C.GoBytes`)
|
// utf16FromString creates a UTF16 char array from a string.
|
||||||
func goBytes(src unsafe.Pointer, len uint32) []byte {
|
func utf16FromString(str string) []uint16 {
|
||||||
if src == nullPointer {
|
return syscall.StringToUTF16(str)
|
||||||
|
}
|
||||||
|
|
||||||
|
// goBytes copies the given C byte array to a Go byte array (see `C.GoBytes`).
|
||||||
|
// This function avoids having cgo as dependency.
|
||||||
|
func goBytes(src uintptr, len uint32) []byte {
|
||||||
|
if src == uintptr(0) {
|
||||||
return []byte{}
|
return []byte{}
|
||||||
}
|
}
|
||||||
slice := (*[1 << 30]byte)(src)[0:len]
|
|
||||||
rv := make([]byte, len)
|
rv := make([]byte, len)
|
||||||
copy(rv, slice)
|
copy(rv, *(*[]byte)(unsafe.Pointer(&reflect.SliceHeader{
|
||||||
return rv[:]
|
Data: src,
|
||||||
|
Len: int(len),
|
||||||
|
Cap: int(len),
|
||||||
|
})))
|
||||||
|
return rv
|
||||||
}
|
}
|
||||||
|
|
||||||
// Convert the given CREDENTIAL struct to a more usable structure
|
// Convert the given CREDENTIAL struct to a more usable structure
|
||||||
func nativeToCredential(cred *nativeCREDENTIAL) (result *Credential) {
|
func sysToCredential(cred *sysCREDENTIAL) (result *Credential) {
|
||||||
if unsafe.Pointer(cred) == nullPointer {
|
if cred == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
result = new(Credential)
|
result = new(Credential)
|
||||||
@@ -60,29 +71,28 @@ func nativeToCredential(cred *nativeCREDENTIAL) (result *Credential) {
|
|||||||
result.UserName = utf16PtrToString(cred.UserName)
|
result.UserName = utf16PtrToString(cred.UserName)
|
||||||
result.LastWritten = time.Unix(0, cred.LastWritten.Nanoseconds())
|
result.LastWritten = time.Unix(0, cred.LastWritten.Nanoseconds())
|
||||||
result.Persist = CredentialPersistence(cred.Persist)
|
result.Persist = CredentialPersistence(cred.Persist)
|
||||||
result.CredentialBlob = goBytes(unsafe.Pointer(cred.CredentialBlob), cred.CredentialBlobSize)
|
result.CredentialBlob = goBytes(cred.CredentialBlob, cred.CredentialBlobSize)
|
||||||
result.Attributes = make([]CredentialAttribute, cred.AttributeCount)
|
result.Attributes = make([]CredentialAttribute, cred.AttributeCount)
|
||||||
attrSliceHeader := reflect.SliceHeader{
|
attrSlice := *(*[]sysCREDENTIAL_ATTRIBUTE)(unsafe.Pointer(&reflect.SliceHeader{
|
||||||
Data: cred.Attributes,
|
Data: cred.Attributes,
|
||||||
Len: int(cred.AttributeCount),
|
Len: int(cred.AttributeCount),
|
||||||
Cap: int(cred.AttributeCount),
|
Cap: int(cred.AttributeCount),
|
||||||
}
|
}))
|
||||||
attrSlice := *(*[]nativeCREDENTIAL_ATTRIBUTE)(unsafe.Pointer(&attrSliceHeader))
|
|
||||||
for i, attr := range attrSlice {
|
for i, attr := range attrSlice {
|
||||||
resultAttr := &result.Attributes[i]
|
resultAttr := &result.Attributes[i]
|
||||||
resultAttr.Keyword = utf16PtrToString(attr.Keyword)
|
resultAttr.Keyword = utf16PtrToString(attr.Keyword)
|
||||||
resultAttr.Value = goBytes(unsafe.Pointer(attr.Value), attr.ValueSize)
|
resultAttr.Value = goBytes(attr.Value, attr.ValueSize)
|
||||||
}
|
}
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
// Convert the given Credential object back to a CREDENTIAL struct, which can be used for calling the
|
// Convert the given Credential object back to a CREDENTIAL struct, which can be used for calling the
|
||||||
// Windows APIs
|
// Windows APIs
|
||||||
func nativeFromCredential(cred *Credential) (result *nativeCREDENTIAL) {
|
func sysFromCredential(cred *Credential) (result *sysCREDENTIAL) {
|
||||||
if cred == nil {
|
if cred == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
result = new(nativeCREDENTIAL)
|
result = new(sysCREDENTIAL)
|
||||||
result.Flags = 0
|
result.Flags = 0
|
||||||
result.Type = 0
|
result.Type = 0
|
||||||
result.TargetName, _ = syscall.UTF16PtrFromString(cred.TargetName)
|
result.TargetName, _ = syscall.UTF16PtrFromString(cred.TargetName)
|
||||||
@@ -96,13 +106,13 @@ func nativeFromCredential(cred *Credential) (result *nativeCREDENTIAL) {
|
|||||||
}
|
}
|
||||||
result.Persist = uint32(cred.Persist)
|
result.Persist = uint32(cred.Persist)
|
||||||
result.AttributeCount = uint32(len(cred.Attributes))
|
result.AttributeCount = uint32(len(cred.Attributes))
|
||||||
attributes := make([]nativeCREDENTIAL_ATTRIBUTE, len(cred.Attributes))
|
attributes := make([]sysCREDENTIAL_ATTRIBUTE, len(cred.Attributes))
|
||||||
if len(attributes) > 0 {
|
if len(attributes) > 0 {
|
||||||
result.Attributes = uintptr(unsafe.Pointer(&attributes[0]))
|
result.Attributes = uintptr(unsafe.Pointer(&attributes[0]))
|
||||||
} else {
|
} else {
|
||||||
result.Attributes = 0
|
result.Attributes = 0
|
||||||
}
|
}
|
||||||
for i, _ := range cred.Attributes {
|
for i := range cred.Attributes {
|
||||||
inAttr := &cred.Attributes[i]
|
inAttr := &cred.Attributes[i]
|
||||||
outAttr := &attributes[i]
|
outAttr := &attributes[i]
|
||||||
outAttr.Keyword, _ = syscall.UTF16PtrFromString(inAttr.Keyword)
|
outAttr.Keyword, _ = syscall.UTF16PtrFromString(inAttr.Keyword)
|
||||||
|
|||||||
+11
@@ -0,0 +1,11 @@
|
|||||||
|
// +build !windows
|
||||||
|
|
||||||
|
package wincred
|
||||||
|
|
||||||
|
func utf16ToByte(...interface{}) []byte {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func utf16FromString(...interface{}) []uint16 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
module github.com/danieljoos/wincred
|
||||||
|
|
||||||
|
go 1.13
|
||||||
|
|
||||||
|
require github.com/stretchr/testify v1.5.1
|
||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||||
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
|
||||||
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
|
github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
|
||||||
|
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
|
||||||
|
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||||
-137
@@ -1,137 +0,0 @@
|
|||||||
package wincred
|
|
||||||
|
|
||||||
import (
|
|
||||||
"syscall"
|
|
||||||
"unsafe"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
modadvapi32 = syscall.NewLazyDLL("advapi32.dll")
|
|
||||||
|
|
||||||
procCredRead proc = modadvapi32.NewProc("CredReadW")
|
|
||||||
procCredWrite proc = modadvapi32.NewProc("CredWriteW")
|
|
||||||
procCredDelete proc = modadvapi32.NewProc("CredDeleteW")
|
|
||||||
procCredFree proc = modadvapi32.NewProc("CredFree")
|
|
||||||
procCredEnumerate proc = modadvapi32.NewProc("CredEnumerateW")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Interface for syscall.Proc: helps testing
|
|
||||||
type proc interface {
|
|
||||||
Call(a ...uintptr) (r1, r2 uintptr, lastErr error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa374788(v=vs.85).aspx
|
|
||||||
type nativeCREDENTIAL struct {
|
|
||||||
Flags uint32
|
|
||||||
Type uint32
|
|
||||||
TargetName *uint16
|
|
||||||
Comment *uint16
|
|
||||||
LastWritten syscall.Filetime
|
|
||||||
CredentialBlobSize uint32
|
|
||||||
CredentialBlob uintptr
|
|
||||||
Persist uint32
|
|
||||||
AttributeCount uint32
|
|
||||||
Attributes uintptr
|
|
||||||
TargetAlias *uint16
|
|
||||||
UserName *uint16
|
|
||||||
}
|
|
||||||
|
|
||||||
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa374790(v=vs.85).aspx
|
|
||||||
type nativeCREDENTIAL_ATTRIBUTE struct {
|
|
||||||
Keyword *uint16
|
|
||||||
Flags uint32
|
|
||||||
ValueSize uint32
|
|
||||||
Value uintptr
|
|
||||||
}
|
|
||||||
|
|
||||||
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa374788(v=vs.85).aspx
|
|
||||||
type nativeCRED_TYPE uint32
|
|
||||||
|
|
||||||
const (
|
|
||||||
naCRED_TYPE_GENERIC nativeCRED_TYPE = 0x1
|
|
||||||
naCRED_TYPE_DOMAIN_PASSWORD nativeCRED_TYPE = 0x2
|
|
||||||
naCRED_TYPE_DOMAIN_CERTIFICATE nativeCRED_TYPE = 0x3
|
|
||||||
naCRED_TYPE_DOMAIN_VISIBLE_PASSWORD nativeCRED_TYPE = 0x4
|
|
||||||
naCRED_TYPE_GENERIC_CERTIFICATE nativeCRED_TYPE = 0x5
|
|
||||||
naCRED_TYPE_DOMAIN_EXTENDED nativeCRED_TYPE = 0x6
|
|
||||||
|
|
||||||
naERROR_NOT_FOUND = "Element not found."
|
|
||||||
)
|
|
||||||
|
|
||||||
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa374804(v=vs.85).aspx
|
|
||||||
func nativeCredRead(targetName string, typ nativeCRED_TYPE) (*Credential, error) {
|
|
||||||
var pcred uintptr
|
|
||||||
targetNamePtr, _ := syscall.UTF16PtrFromString(targetName)
|
|
||||||
ret, _, err := procCredRead.Call(
|
|
||||||
uintptr(unsafe.Pointer(targetNamePtr)),
|
|
||||||
uintptr(typ),
|
|
||||||
0,
|
|
||||||
uintptr(unsafe.Pointer(&pcred)),
|
|
||||||
)
|
|
||||||
if ret == 0 {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer procCredFree.Call(pcred)
|
|
||||||
|
|
||||||
return nativeToCredential((*nativeCREDENTIAL)(unsafe.Pointer(pcred))), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa375187(v=vs.85).aspx
|
|
||||||
func nativeCredWrite(cred *Credential, typ nativeCRED_TYPE) error {
|
|
||||||
ncred := nativeFromCredential(cred)
|
|
||||||
ncred.Type = uint32(typ)
|
|
||||||
ret, _, err := procCredWrite.Call(
|
|
||||||
uintptr(unsafe.Pointer(ncred)),
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
if ret == 0 {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa374787(v=vs.85).aspx
|
|
||||||
func nativeCredDelete(cred *Credential, typ nativeCRED_TYPE) error {
|
|
||||||
targetNamePtr, _ := syscall.UTF16PtrFromString(cred.TargetName)
|
|
||||||
ret, _, err := procCredDelete.Call(
|
|
||||||
uintptr(unsafe.Pointer(targetNamePtr)),
|
|
||||||
uintptr(typ),
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
if ret == 0 {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// https://msdn.microsoft.com/en-us/library/windows/desktop/aa374794(v=vs.85).aspx
|
|
||||||
func nativeCredEnumerate(filter string, all bool) ([]*Credential, error) {
|
|
||||||
var count int
|
|
||||||
var pcreds uintptr
|
|
||||||
var filterPtr uintptr
|
|
||||||
if !all {
|
|
||||||
filterUtf16Ptr, _ := syscall.UTF16PtrFromString(filter)
|
|
||||||
filterPtr = uintptr(unsafe.Pointer(filterUtf16Ptr))
|
|
||||||
} else {
|
|
||||||
filterPtr = 0
|
|
||||||
}
|
|
||||||
ret, _, err := procCredEnumerate.Call(
|
|
||||||
filterPtr,
|
|
||||||
0,
|
|
||||||
uintptr(unsafe.Pointer(&count)),
|
|
||||||
uintptr(unsafe.Pointer(&pcreds)),
|
|
||||||
)
|
|
||||||
if ret == 0 {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer procCredFree.Call(pcreds)
|
|
||||||
pcredsSlice := (*[1 << 30]uintptr)(unsafe.Pointer(pcreds))[:count:count]
|
|
||||||
creds := make([]*Credential, count)
|
|
||||||
for i := range creds {
|
|
||||||
creds[i] = nativeToCredential((*nativeCREDENTIAL)(unsafe.Pointer(pcredsSlice[i])))
|
|
||||||
}
|
|
||||||
|
|
||||||
return creds, nil
|
|
||||||
}
|
|
||||||
+143
@@ -0,0 +1,143 @@
|
|||||||
|
// +build windows
|
||||||
|
|
||||||
|
package wincred
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"syscall"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
modadvapi32 = syscall.NewLazyDLL("advapi32.dll")
|
||||||
|
|
||||||
|
procCredRead proc = modadvapi32.NewProc("CredReadW")
|
||||||
|
procCredWrite proc = modadvapi32.NewProc("CredWriteW")
|
||||||
|
procCredDelete proc = modadvapi32.NewProc("CredDeleteW")
|
||||||
|
procCredFree proc = modadvapi32.NewProc("CredFree")
|
||||||
|
procCredEnumerate proc = modadvapi32.NewProc("CredEnumerateW")
|
||||||
|
)
|
||||||
|
|
||||||
|
// Interface for syscall.Proc: helps testing
|
||||||
|
type proc interface {
|
||||||
|
Call(a ...uintptr) (r1, r2 uintptr, lastErr error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credentialw
|
||||||
|
type sysCREDENTIAL struct {
|
||||||
|
Flags uint32
|
||||||
|
Type uint32
|
||||||
|
TargetName *uint16
|
||||||
|
Comment *uint16
|
||||||
|
LastWritten syscall.Filetime
|
||||||
|
CredentialBlobSize uint32
|
||||||
|
CredentialBlob uintptr
|
||||||
|
Persist uint32
|
||||||
|
AttributeCount uint32
|
||||||
|
Attributes uintptr
|
||||||
|
TargetAlias *uint16
|
||||||
|
UserName *uint16
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credential_attributew
|
||||||
|
type sysCREDENTIAL_ATTRIBUTE struct {
|
||||||
|
Keyword *uint16
|
||||||
|
Flags uint32
|
||||||
|
ValueSize uint32
|
||||||
|
Value uintptr
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credentialw
|
||||||
|
type sysCRED_TYPE uint32
|
||||||
|
|
||||||
|
const (
|
||||||
|
sysCRED_TYPE_GENERIC sysCRED_TYPE = 0x1
|
||||||
|
sysCRED_TYPE_DOMAIN_PASSWORD sysCRED_TYPE = 0x2
|
||||||
|
sysCRED_TYPE_DOMAIN_CERTIFICATE sysCRED_TYPE = 0x3
|
||||||
|
sysCRED_TYPE_DOMAIN_VISIBLE_PASSWORD sysCRED_TYPE = 0x4
|
||||||
|
sysCRED_TYPE_GENERIC_CERTIFICATE sysCRED_TYPE = 0x5
|
||||||
|
sysCRED_TYPE_DOMAIN_EXTENDED sysCRED_TYPE = 0x6
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/Debug/system-error-codes
|
||||||
|
sysERROR_NOT_FOUND = syscall.Errno(1168)
|
||||||
|
sysERROR_INVALID_PARAMETER = syscall.Errno(87)
|
||||||
|
)
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/nf-wincred-credreadw
|
||||||
|
func sysCredRead(targetName string, typ sysCRED_TYPE) (*Credential, error) {
|
||||||
|
var pcred *sysCREDENTIAL
|
||||||
|
targetNamePtr, _ := syscall.UTF16PtrFromString(targetName)
|
||||||
|
ret, _, err := procCredRead.Call(
|
||||||
|
uintptr(unsafe.Pointer(targetNamePtr)),
|
||||||
|
uintptr(typ),
|
||||||
|
0,
|
||||||
|
uintptr(unsafe.Pointer(&pcred)),
|
||||||
|
)
|
||||||
|
if ret == 0 {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer procCredFree.Call(uintptr(unsafe.Pointer(pcred)))
|
||||||
|
|
||||||
|
return sysToCredential(pcred), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/nf-wincred-credwritew
|
||||||
|
func sysCredWrite(cred *Credential, typ sysCRED_TYPE) error {
|
||||||
|
ncred := sysFromCredential(cred)
|
||||||
|
ncred.Type = uint32(typ)
|
||||||
|
ret, _, err := procCredWrite.Call(
|
||||||
|
uintptr(unsafe.Pointer(ncred)),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
if ret == 0 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/nf-wincred-creddeletew
|
||||||
|
func sysCredDelete(cred *Credential, typ sysCRED_TYPE) error {
|
||||||
|
targetNamePtr, _ := syscall.UTF16PtrFromString(cred.TargetName)
|
||||||
|
ret, _, err := procCredDelete.Call(
|
||||||
|
uintptr(unsafe.Pointer(targetNamePtr)),
|
||||||
|
uintptr(typ),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
if ret == 0 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/api/wincred/nf-wincred-credenumeratew
|
||||||
|
func sysCredEnumerate(filter string, all bool) ([]*Credential, error) {
|
||||||
|
var count int
|
||||||
|
var pcreds uintptr
|
||||||
|
var filterPtr *uint16
|
||||||
|
if !all {
|
||||||
|
filterPtr, _ = syscall.UTF16PtrFromString(filter)
|
||||||
|
}
|
||||||
|
ret, _, err := procCredEnumerate.Call(
|
||||||
|
uintptr(unsafe.Pointer(filterPtr)),
|
||||||
|
0,
|
||||||
|
uintptr(unsafe.Pointer(&count)),
|
||||||
|
uintptr(unsafe.Pointer(&pcreds)),
|
||||||
|
)
|
||||||
|
if ret == 0 {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer procCredFree.Call(pcreds)
|
||||||
|
credsSlice := *(*[]*sysCREDENTIAL)(unsafe.Pointer(&reflect.SliceHeader{
|
||||||
|
Data: pcreds,
|
||||||
|
Len: count,
|
||||||
|
Cap: count,
|
||||||
|
}))
|
||||||
|
creds := make([]*Credential, count, count)
|
||||||
|
for i, cred := range credsSlice {
|
||||||
|
creds[i] = sysToCredential(cred)
|
||||||
|
}
|
||||||
|
|
||||||
|
return creds, nil
|
||||||
|
}
|
||||||
+36
@@ -0,0 +1,36 @@
|
|||||||
|
// +build !windows
|
||||||
|
|
||||||
|
package wincred
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"syscall"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
sysCRED_TYPE_GENERIC = 0
|
||||||
|
sysCRED_TYPE_DOMAIN_PASSWORD = 0
|
||||||
|
sysCRED_TYPE_DOMAIN_CERTIFICATE = 0
|
||||||
|
sysCRED_TYPE_DOMAIN_VISIBLE_PASSWORD = 0
|
||||||
|
sysCRED_TYPE_GENERIC_CERTIFICATE = 0
|
||||||
|
sysCRED_TYPE_DOMAIN_EXTENDED = 0
|
||||||
|
|
||||||
|
sysERROR_NOT_FOUND = syscall.Errno(1)
|
||||||
|
sysERROR_INVALID_PARAMETER = syscall.Errno(1)
|
||||||
|
)
|
||||||
|
|
||||||
|
func sysCredRead(...interface{}) (*Credential, error) {
|
||||||
|
return nil, errors.New("Operation not supported")
|
||||||
|
}
|
||||||
|
|
||||||
|
func sysCredWrite(...interface{}) error {
|
||||||
|
return errors.New("Operation not supported")
|
||||||
|
}
|
||||||
|
|
||||||
|
func sysCredDelete(...interface{}) error {
|
||||||
|
return errors.New("Operation not supported")
|
||||||
|
}
|
||||||
|
|
||||||
|
func sysCredEnumerate(...interface{}) ([]*Credential, error) {
|
||||||
|
return nil, errors.New("Operation not supported")
|
||||||
|
}
|
||||||
+34
-2
@@ -4,19 +4,38 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// CredentialPersistence describes one of three persistence modes of a credential.
|
||||||
|
// A detailed description of the available modes can be found on
|
||||||
|
// Docs: https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credentialw
|
||||||
type CredentialPersistence uint32
|
type CredentialPersistence uint32
|
||||||
|
|
||||||
const (
|
const (
|
||||||
PersistSession CredentialPersistence = 0x1
|
// PersistSession indicates that the credential only persists for the life
|
||||||
|
// of the current Windows login session. Such a credential is not visible in
|
||||||
|
// any other logon session, even from the same user.
|
||||||
|
PersistSession CredentialPersistence = 0x1
|
||||||
|
|
||||||
|
// PersistLocalMachine indicates that the credential persists for this and
|
||||||
|
// all subsequent logon sessions on this local machine/computer. It is
|
||||||
|
// however not visible for logon sessions of this user on a different
|
||||||
|
// machine.
|
||||||
PersistLocalMachine CredentialPersistence = 0x2
|
PersistLocalMachine CredentialPersistence = 0x2
|
||||||
PersistEnterprise CredentialPersistence = 0x3
|
|
||||||
|
// PersistEnterprise indicates that the credential persists for this and all
|
||||||
|
// subsequent logon sessions for this user. It is also visible for logon
|
||||||
|
// sessions on different computers.
|
||||||
|
PersistEnterprise CredentialPersistence = 0x3
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// CredentialAttribute represents an application-specific attribute of a credential.
|
||||||
type CredentialAttribute struct {
|
type CredentialAttribute struct {
|
||||||
Keyword string
|
Keyword string
|
||||||
Value []byte
|
Value []byte
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Credential is the basic credential structure.
|
||||||
|
// A credential is identified by its target name.
|
||||||
|
// The actual credential secret is available in the CredentialBlob field.
|
||||||
type Credential struct {
|
type Credential struct {
|
||||||
TargetName string
|
TargetName string
|
||||||
Comment string
|
Comment string
|
||||||
@@ -28,10 +47,23 @@ type Credential struct {
|
|||||||
Persist CredentialPersistence
|
Persist CredentialPersistence
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GenericCredential holds a credential for generic usage.
|
||||||
|
// It is typically defined and used by applications that need to manage user
|
||||||
|
// secrets.
|
||||||
|
//
|
||||||
|
// More information about the available kinds of credentials of the Windows
|
||||||
|
// Credential Management API can be found on Docs:
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/SecAuthN/kinds-of-credentials
|
||||||
type GenericCredential struct {
|
type GenericCredential struct {
|
||||||
Credential
|
Credential
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DomainPassword holds a domain credential that is typically used by the
|
||||||
|
// operating system for user logon.
|
||||||
|
//
|
||||||
|
// More information about the available kinds of credentials of the Windows
|
||||||
|
// Credential Management API can be found on Docs:
|
||||||
|
// https://docs.microsoft.com/en-us/windows/desktop/SecAuthN/kinds-of-credentials
|
||||||
type DomainPassword struct {
|
type DomainPassword struct {
|
||||||
Credential
|
Credential
|
||||||
}
|
}
|
||||||
|
|||||||
+53
-22
@@ -1,19 +1,36 @@
|
|||||||
|
// Package wincred provides primitives for accessing the Windows Credentials Management API.
|
||||||
|
// This includes functions for retrieval, listing and storage of credentials as well as Go structures for convenient access to the credential data.
|
||||||
|
//
|
||||||
|
// A more detailed description of Windows Credentials Management can be found on
|
||||||
|
// Docs: https://docs.microsoft.com/en-us/windows/desktop/SecAuthN/credentials-management
|
||||||
package wincred
|
package wincred
|
||||||
|
|
||||||
import (
|
import "errors"
|
||||||
"syscall"
|
|
||||||
|
const (
|
||||||
|
// ErrElementNotFound is the error that is returned if a requested element cannot be found.
|
||||||
|
// This error constant can be used to check if a credential could not be found.
|
||||||
|
ErrElementNotFound = sysERROR_NOT_FOUND
|
||||||
|
|
||||||
|
// ErrInvalidParameter is the error that is returned for invalid parameters.
|
||||||
|
// This error constant can be used to check if the given function parameters were invalid.
|
||||||
|
// For example when trying to create a new generic credential with an empty target name.
|
||||||
|
ErrInvalidParameter = sysERROR_INVALID_PARAMETER
|
||||||
)
|
)
|
||||||
|
|
||||||
// Get the generic credential with the given name from Windows credential manager
|
// GetGenericCredential fetches the generic credential with the given name from Windows credential manager.
|
||||||
|
// It returns nil and an error if the credential could not be found or an error occurred.
|
||||||
func GetGenericCredential(targetName string) (*GenericCredential, error) {
|
func GetGenericCredential(targetName string) (*GenericCredential, error) {
|
||||||
cred, err := nativeCredRead(targetName, naCRED_TYPE_GENERIC)
|
cred, err := sysCredRead(targetName, sysCRED_TYPE_GENERIC)
|
||||||
if cred != nil {
|
if cred != nil {
|
||||||
return &GenericCredential{*cred}, err
|
return &GenericCredential{*cred}, err
|
||||||
}
|
}
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a new generic credential with the given name
|
// NewGenericCredential creates a new generic credential object with the given name.
|
||||||
|
// The persist mode of the newly created object is set to a default value that indicates local-machine-wide storage.
|
||||||
|
// The credential object is NOT yet persisted to the Windows credential vault.
|
||||||
func NewGenericCredential(targetName string) (result *GenericCredential) {
|
func NewGenericCredential(targetName string) (result *GenericCredential) {
|
||||||
result = new(GenericCredential)
|
result = new(GenericCredential)
|
||||||
result.TargetName = targetName
|
result.TargetName = targetName
|
||||||
@@ -21,28 +38,31 @@ func NewGenericCredential(targetName string) (result *GenericCredential) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Persist the credential to Windows credential manager
|
// Write persists the generic credential object to Windows credential manager.
|
||||||
func (t *GenericCredential) Write() (err error) {
|
func (t *GenericCredential) Write() (err error) {
|
||||||
err = nativeCredWrite(&t.Credential, naCRED_TYPE_GENERIC)
|
err = sysCredWrite(&t.Credential, sysCRED_TYPE_GENERIC)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Delete the credential from Windows credential manager
|
// Delete removes the credential object from Windows credential manager.
|
||||||
func (t *GenericCredential) Delete() (err error) {
|
func (t *GenericCredential) Delete() (err error) {
|
||||||
err = nativeCredDelete(&t.Credential, naCRED_TYPE_GENERIC)
|
err = sysCredDelete(&t.Credential, sysCRED_TYPE_GENERIC)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get the domain password credential with the given target host name
|
// GetDomainPassword fetches the domain-password credential with the given target host name from Windows credential manager.
|
||||||
|
// It returns nil and an error if the credential could not be found or an error occurred.
|
||||||
func GetDomainPassword(targetName string) (*DomainPassword, error) {
|
func GetDomainPassword(targetName string) (*DomainPassword, error) {
|
||||||
cred, err := nativeCredRead(targetName, naCRED_TYPE_DOMAIN_PASSWORD)
|
cred, err := sysCredRead(targetName, sysCRED_TYPE_DOMAIN_PASSWORD)
|
||||||
if cred != nil {
|
if cred != nil {
|
||||||
return &DomainPassword{*cred}, err
|
return &DomainPassword{*cred}, err
|
||||||
}
|
}
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a new domain password credential used for login to the given target host name
|
// NewDomainPassword creates a new domain-password credential used for login to the given target host name.
|
||||||
|
// The persist mode of the newly created object is set to a default value that indicates local-machine-wide storage.
|
||||||
|
// The credential object is NOT yet persisted to the Windows credential vault.
|
||||||
func NewDomainPassword(targetName string) (result *DomainPassword) {
|
func NewDomainPassword(targetName string) (result *DomainPassword) {
|
||||||
result = new(DomainPassword)
|
result = new(DomainPassword)
|
||||||
result.TargetName = targetName
|
result.TargetName = targetName
|
||||||
@@ -50,28 +70,39 @@ func NewDomainPassword(targetName string) (result *DomainPassword) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Persist the domain password credential to Windows credential manager
|
// Write persists the domain-password credential to Windows credential manager.
|
||||||
func (t *DomainPassword) Write() (err error) {
|
func (t *DomainPassword) Write() (err error) {
|
||||||
err = nativeCredWrite(&t.Credential, naCRED_TYPE_DOMAIN_PASSWORD)
|
err = sysCredWrite(&t.Credential, sysCRED_TYPE_DOMAIN_PASSWORD)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Delete the domain password credential from Windows credential manager
|
// Delete removes the domain-password credential from Windows credential manager.
|
||||||
func (t *DomainPassword) Delete() (err error) {
|
func (t *DomainPassword) Delete() (err error) {
|
||||||
err = nativeCredDelete(&t.Credential, naCRED_TYPE_DOMAIN_PASSWORD)
|
err = sysCredDelete(&t.Credential, sysCRED_TYPE_DOMAIN_PASSWORD)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set the CredentialBlob field of a domain password credential
|
// SetPassword sets the CredentialBlob field of a domain password credential to the given string.
|
||||||
// using an UTF16 encoded password string
|
|
||||||
func (t *DomainPassword) SetPassword(pw string) {
|
func (t *DomainPassword) SetPassword(pw string) {
|
||||||
t.CredentialBlob = utf16ToByte(syscall.StringToUTF16(pw))
|
t.CredentialBlob = utf16ToByte(utf16FromString(pw))
|
||||||
}
|
}
|
||||||
|
|
||||||
// List the contents of the Credentials store
|
// List retrieves all credentials of the Credentials store.
|
||||||
func List() ([]*Credential, error) {
|
func List() ([]*Credential, error) {
|
||||||
creds, err := nativeCredEnumerate("", true)
|
creds, err := sysCredEnumerate("", true)
|
||||||
if err != nil && err.Error() == naERROR_NOT_FOUND {
|
if err != nil && errors.Is(err, ErrElementNotFound) {
|
||||||
|
// Ignore ERROR_NOT_FOUND and return an empty list instead
|
||||||
|
creds = []*Credential{}
|
||||||
|
err = nil
|
||||||
|
}
|
||||||
|
return creds, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// FilteredList retrieves the list of credentials from the Credentials store that match the given filter.
|
||||||
|
// The filter string defines the prefix followed by an asterisk for the `TargetName` attribute of the credentials.
|
||||||
|
func FilteredList(filter string) ([]*Credential, error) {
|
||||||
|
creds, err := sysCredEnumerate(filter, false)
|
||||||
|
if err != nil && errors.Is(err, ErrElementNotFound) {
|
||||||
// Ignore ERROR_NOT_FOUND and return an empty list instead
|
// Ignore ERROR_NOT_FOUND and return an empty list instead
|
||||||
creds = []*Credential{}
|
creds = []*Credential{}
|
||||||
err = nil
|
err = nil
|
||||||
|
|||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
# This source code refers to The Go Authors for copyright purposes.
|
||||||
|
# The master list of authors is in the main Go distribution,
|
||||||
|
# visible at http://tip.golang.org/AUTHORS.
|
||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
# This source code was written by the Go contributors.
|
||||||
|
# The master list of contributors is in the main Go distribution,
|
||||||
|
# visible at http://tip.golang.org/CONTRIBUTORS.
|
||||||
+27
@@ -0,0 +1,27 @@
|
|||||||
|
Copyright (c) 2009 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google Inc. nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
+22
@@ -0,0 +1,22 @@
|
|||||||
|
Additional IP Rights Grant (Patents)
|
||||||
|
|
||||||
|
"This implementation" means the copyrightable works distributed by
|
||||||
|
Google as part of the Go project.
|
||||||
|
|
||||||
|
Google hereby grants to You a perpetual, worldwide, non-exclusive,
|
||||||
|
no-charge, royalty-free, irrevocable (except as stated in this section)
|
||||||
|
patent license to make, have made, use, offer to sell, sell, import,
|
||||||
|
transfer and otherwise run, modify and propagate the contents of this
|
||||||
|
implementation of Go, where such license applies only to those patent
|
||||||
|
claims, both currently owned or controlled by Google and acquired in
|
||||||
|
the future, licensable by Google that are necessarily infringed by this
|
||||||
|
implementation of Go. This grant does not include claims that would be
|
||||||
|
infringed only as a consequence of further modification of this
|
||||||
|
implementation. If you or your agent or exclusive licensee institute or
|
||||||
|
order or agree to the institution of patent litigation against any
|
||||||
|
entity (including a cross-claim or counterclaim in a lawsuit) alleging
|
||||||
|
that this implementation of Go or any code incorporated within this
|
||||||
|
implementation of Go constitutes direct or contributory patent
|
||||||
|
infringement, or inducement of patent infringement, then any patent
|
||||||
|
rights granted to you under this License for this implementation of Go
|
||||||
|
shall terminate as of the date such litigation is filed.
|
||||||
+102
@@ -0,0 +1,102 @@
|
|||||||
|
// Copyright 2020 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// Package execabs is a drop-in replacement for os/exec
|
||||||
|
// that requires PATH lookups to find absolute paths.
|
||||||
|
// That is, execabs.Command("cmd") runs the same PATH lookup
|
||||||
|
// as exec.Command("cmd"), but if the result is a path
|
||||||
|
// which is relative, the Run and Start methods will report
|
||||||
|
// an error instead of running the executable.
|
||||||
|
//
|
||||||
|
// See https://blog.golang.org/path-security for more information
|
||||||
|
// about when it may be necessary or appropriate to use this package.
|
||||||
|
package execabs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNotFound is the error resulting if a path search failed to find an executable file.
|
||||||
|
// It is an alias for exec.ErrNotFound.
|
||||||
|
var ErrNotFound = exec.ErrNotFound
|
||||||
|
|
||||||
|
// Cmd represents an external command being prepared or run.
|
||||||
|
// It is an alias for exec.Cmd.
|
||||||
|
type Cmd = exec.Cmd
|
||||||
|
|
||||||
|
// Error is returned by LookPath when it fails to classify a file as an executable.
|
||||||
|
// It is an alias for exec.Error.
|
||||||
|
type Error = exec.Error
|
||||||
|
|
||||||
|
// An ExitError reports an unsuccessful exit by a command.
|
||||||
|
// It is an alias for exec.ExitError.
|
||||||
|
type ExitError = exec.ExitError
|
||||||
|
|
||||||
|
func relError(file, path string) error {
|
||||||
|
return fmt.Errorf("%s resolves to executable in current directory (.%c%s)", file, filepath.Separator, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LookPath searches for an executable named file in the directories
|
||||||
|
// named by the PATH environment variable. If file contains a slash,
|
||||||
|
// it is tried directly and the PATH is not consulted. The result will be
|
||||||
|
// an absolute path.
|
||||||
|
//
|
||||||
|
// LookPath differs from exec.LookPath in its handling of PATH lookups,
|
||||||
|
// which are used for file names without slashes. If exec.LookPath's
|
||||||
|
// PATH lookup would have returned an executable from the current directory,
|
||||||
|
// LookPath instead returns an error.
|
||||||
|
func LookPath(file string) (string, error) {
|
||||||
|
path, err := exec.LookPath(file)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if filepath.Base(file) == file && !filepath.IsAbs(path) {
|
||||||
|
return "", relError(file, path)
|
||||||
|
}
|
||||||
|
return path, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fixCmd(name string, cmd *exec.Cmd) {
|
||||||
|
if filepath.Base(name) == name && !filepath.IsAbs(cmd.Path) {
|
||||||
|
// exec.Command was called with a bare binary name and
|
||||||
|
// exec.LookPath returned a path which is not absolute.
|
||||||
|
// Set cmd.lookPathErr and clear cmd.Path so that it
|
||||||
|
// cannot be run.
|
||||||
|
lookPathErr := (*error)(unsafe.Pointer(reflect.ValueOf(cmd).Elem().FieldByName("lookPathErr").Addr().Pointer()))
|
||||||
|
if *lookPathErr == nil {
|
||||||
|
*lookPathErr = relError(name, cmd.Path)
|
||||||
|
}
|
||||||
|
cmd.Path = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// CommandContext is like Command but includes a context.
|
||||||
|
//
|
||||||
|
// The provided context is used to kill the process (by calling os.Process.Kill)
|
||||||
|
// if the context becomes done before the command completes on its own.
|
||||||
|
func CommandContext(ctx context.Context, name string, arg ...string) *exec.Cmd {
|
||||||
|
cmd := exec.CommandContext(ctx, name, arg...)
|
||||||
|
fixCmd(name, cmd)
|
||||||
|
return cmd
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// Command returns the Cmd struct to execute the named program with the given arguments.
|
||||||
|
// See exec.Command for most details.
|
||||||
|
//
|
||||||
|
// Command differs from exec.Command in its handling of PATH lookups,
|
||||||
|
// which are used when the program name contains no slashes.
|
||||||
|
// If exec.Command would have returned an exec.Cmd configured to run an
|
||||||
|
// executable from the current directory, Command instead
|
||||||
|
// returns an exec.Cmd that will return an error from Start or Run.
|
||||||
|
func Command(name string, arg ...string) *exec.Cmd {
|
||||||
|
cmd := exec.Command(name, arg...)
|
||||||
|
fixCmd(name, cmd)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
Vendored
+4
@@ -0,0 +1,4 @@
|
|||||||
|
# github.com/danieljoos/wincred v1.1.0
|
||||||
|
github.com/danieljoos/wincred
|
||||||
|
# golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4
|
||||||
|
golang.org/x/sys/execabs
|
||||||
@@ -2,10 +2,12 @@ package wincred
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
winc "github.com/danieljoos/wincred"
|
winc "github.com/danieljoos/wincred"
|
||||||
"github.com/docker/docker-credential-helpers/credentials"
|
"github.com/docker/docker-credential-helpers/credentials"
|
||||||
|
"github.com/docker/docker-credential-helpers/registryurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Wincred handles secrets using the Windows credential service.
|
// Wincred handles secrets using the Windows credential service.
|
||||||
@@ -37,10 +39,18 @@ func (h Wincred) Delete(serverURL string) error {
|
|||||||
|
|
||||||
// Get retrieves credentials from the windows credentials manager.
|
// Get retrieves credentials from the windows credentials manager.
|
||||||
func (h Wincred) Get(serverURL string) (string, string, error) {
|
func (h Wincred) Get(serverURL string) (string, string, error) {
|
||||||
g, _ := winc.GetGenericCredential(serverURL)
|
target, err := getTarget(serverURL)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
} else if target == "" {
|
||||||
|
return "", "", credentials.NewErrCredentialsNotFound()
|
||||||
|
}
|
||||||
|
|
||||||
|
g, _ := winc.GetGenericCredential(target)
|
||||||
if g == nil {
|
if g == nil {
|
||||||
return "", "", credentials.NewErrCredentialsNotFound()
|
return "", "", credentials.NewErrCredentialsNotFound()
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, attr := range g.Attributes {
|
for _, attr := range g.Attributes {
|
||||||
if strings.Compare(attr.Keyword, "label") == 0 &&
|
if strings.Compare(attr.Keyword, "label") == 0 &&
|
||||||
bytes.Compare(attr.Value, []byte(credentials.CredsLabel)) == 0 {
|
bytes.Compare(attr.Value, []byte(credentials.CredsLabel)) == 0 {
|
||||||
@@ -51,6 +61,71 @@ func (h Wincred) Get(serverURL string) (string, string, error) {
|
|||||||
return "", "", credentials.NewErrCredentialsNotFound()
|
return "", "", credentials.NewErrCredentialsNotFound()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func getTarget(serverURL string) (string, error) {
|
||||||
|
s, err := registryurl.Parse(serverURL)
|
||||||
|
if err != nil {
|
||||||
|
return serverURL, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
creds, err := winc.List()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
var targets []string
|
||||||
|
for i := range creds {
|
||||||
|
attrs := creds[i].Attributes
|
||||||
|
for _, attr := range attrs {
|
||||||
|
if attr.Keyword == "label" && bytes.Equal(attr.Value, []byte(credentials.CredsLabel)) {
|
||||||
|
targets = append(targets, creds[i].TargetName)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if target, found := findMatch(s, targets, exactMatch); found {
|
||||||
|
return target, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if target, found := findMatch(s, targets, approximateMatch); found {
|
||||||
|
return target, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func findMatch(serverUrl *url.URL, targets []string, matches func(url.URL, url.URL) bool) (string, bool) {
|
||||||
|
for _, target := range targets {
|
||||||
|
tURL, err := registryurl.Parse(target)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if matches(*serverUrl, *tURL) {
|
||||||
|
return target, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
func exactMatch(serverURL, target url.URL) bool {
|
||||||
|
return serverURL.String() == target.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func approximateMatch(serverURL, target url.URL) bool {
|
||||||
|
//if scheme is missing assume it is the same as target
|
||||||
|
if serverURL.Scheme == "" {
|
||||||
|
serverURL.Scheme = target.Scheme
|
||||||
|
}
|
||||||
|
//if port is missing assume it is the same as target
|
||||||
|
if serverURL.Port() == "" && target.Port() != "" {
|
||||||
|
serverURL.Host = serverURL.Host + ":" + target.Port()
|
||||||
|
}
|
||||||
|
//if path is missing assume it is the same as target
|
||||||
|
if serverURL.Path == "" {
|
||||||
|
serverURL.Path = target.Path
|
||||||
|
}
|
||||||
|
return serverURL.String() == target.String()
|
||||||
|
}
|
||||||
|
|
||||||
// List returns the stored URLs and corresponding usernames for a given credentials label.
|
// List returns the stored URLs and corresponding usernames for a given credentials label.
|
||||||
func (h Wincred) List() (map[string]string, error) {
|
func (h Wincred) List() (map[string]string, error) {
|
||||||
creds, err := winc.List()
|
creds, err := winc.List()
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package wincred
|
package wincred
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -86,6 +87,154 @@ func TestWinCredHelper(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestWinCredHelperRetrieveAliases verifies that secrets can be accessed
|
||||||
|
// through variations on the URL
|
||||||
|
func TestWinCredHelperRetrieveAliases(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
storeURL string
|
||||||
|
readURL string
|
||||||
|
}{
|
||||||
|
// stored with port, retrieved without
|
||||||
|
{"https://foobar.docker.io:2376", "https://foobar.docker.io"},
|
||||||
|
|
||||||
|
// stored as https, retrieved without scheme
|
||||||
|
{"https://foobar.docker.io", "foobar.docker.io"},
|
||||||
|
|
||||||
|
// stored with path, retrieved without
|
||||||
|
{"https://foobar.docker.io/one/two", "https://foobar.docker.io"},
|
||||||
|
}
|
||||||
|
|
||||||
|
helper := Wincred{}
|
||||||
|
defer func() {
|
||||||
|
for _, te := range tests {
|
||||||
|
helper.Delete(te.storeURL)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Clean store before testing.
|
||||||
|
for _, te := range tests {
|
||||||
|
helper.Delete(te.storeURL)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, te := range tests {
|
||||||
|
c := &credentials.Credentials{ServerURL: te.storeURL, Username: "hello", Secret: "world"}
|
||||||
|
if err := helper.Add(c); err != nil {
|
||||||
|
t.Errorf("Error: failed to store secret for URL %q: %s", te.storeURL, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, _, err := helper.Get(te.readURL); err != nil {
|
||||||
|
t.Errorf("Error: failed to read secret for URL %q using %q", te.storeURL, te.readURL)
|
||||||
|
}
|
||||||
|
helper.Delete(te.storeURL)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWinCredHelperRetrieveStrict verifies that only matching secrets are
|
||||||
|
// returned.
|
||||||
|
func TestWinCredHelperRetrieveStrict(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
storeURL string
|
||||||
|
readURL string
|
||||||
|
}{
|
||||||
|
// stored as https, retrieved using http
|
||||||
|
{"https://foobar.docker.io:2376", "http://foobar.docker.io:2376"},
|
||||||
|
|
||||||
|
// stored as http, retrieved using https
|
||||||
|
{"http://foobar.docker.io:2376", "https://foobar.docker.io:2376"},
|
||||||
|
|
||||||
|
// same: stored as http, retrieved without a scheme specified (hence, using the default https://)
|
||||||
|
{"http://foobar.docker.io", "foobar.docker.io:5678"},
|
||||||
|
|
||||||
|
// non-matching ports
|
||||||
|
{"https://foobar.docker.io:1234", "https://foobar.docker.io:5678"},
|
||||||
|
|
||||||
|
// non-matching ports TODO is this desired behavior? The other way round does work
|
||||||
|
//{"https://foobar.docker.io", "https://foobar.docker.io:5678"},
|
||||||
|
|
||||||
|
// non-matching paths
|
||||||
|
{"https://foobar.docker.io:1234/one/two", "https://foobar.docker.io:1234/five/six"},
|
||||||
|
}
|
||||||
|
|
||||||
|
helper := Wincred{}
|
||||||
|
defer func() {
|
||||||
|
for _, te := range tests {
|
||||||
|
helper.Delete(te.storeURL)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Clean store before testing.
|
||||||
|
for _, te := range tests {
|
||||||
|
helper.Delete(te.storeURL)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, te := range tests {
|
||||||
|
c := &credentials.Credentials{ServerURL: te.storeURL, Username: "hello", Secret: "world"}
|
||||||
|
if err := helper.Add(c); err != nil {
|
||||||
|
t.Errorf("Error: failed to store secret for URL %q: %s", te.storeURL, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, _, err := helper.Get(te.readURL); err == nil {
|
||||||
|
t.Errorf("Error: managed to read secret for URL %q using %q, but should not be able to", te.storeURL, te.readURL)
|
||||||
|
}
|
||||||
|
helper.Delete(te.storeURL)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWinCredHelperStoreRetrieve verifies that secrets stored in the
|
||||||
|
// the keychain can be read back using the URL that was used to store them.
|
||||||
|
func TestWinCredHelperStoreRetrieve(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
url string
|
||||||
|
}{
|
||||||
|
{url: "foobar.docker.io"},
|
||||||
|
{url: "foobar.docker.io:2376"},
|
||||||
|
{url: "//foobar.docker.io:2376"},
|
||||||
|
{url: "https://foobar.docker.io:2376"},
|
||||||
|
{url: "http://foobar.docker.io:2376"},
|
||||||
|
{url: "https://foobar.docker.io:2376/some/path"},
|
||||||
|
{url: "https://foobar.docker.io:2376/some/other/path"},
|
||||||
|
{url: "https://foobar.docker.io:2376/some/other/path?foo=bar"},
|
||||||
|
}
|
||||||
|
|
||||||
|
helper := Wincred{}
|
||||||
|
defer func() {
|
||||||
|
for _, te := range tests {
|
||||||
|
helper.Delete(te.url)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Clean store before testing.
|
||||||
|
for _, te := range tests {
|
||||||
|
helper.Delete(te.url)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note that we don't delete between individual tests here, to verify that
|
||||||
|
// subsequent stores/overwrites don't affect storing / retrieving secrets.
|
||||||
|
for i, te := range tests {
|
||||||
|
c := &credentials.Credentials{
|
||||||
|
ServerURL: te.url,
|
||||||
|
Username: fmt.Sprintf("user-%d", i),
|
||||||
|
Secret: fmt.Sprintf("secret-%d", i),
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := helper.Add(c); err != nil {
|
||||||
|
t.Errorf("Error: failed to store secret for URL: %s: %s", te.url, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
user, secret, err := helper.Get(te.url)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Error: failed to read secret for URL %q: %s", te.url, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if user != c.Username {
|
||||||
|
t.Errorf("Error: expected username %s, got username %s for URL: %s", c.Username, user, te.url)
|
||||||
|
}
|
||||||
|
if secret != c.Secret {
|
||||||
|
t.Errorf("Error: expected secret %s, got secret %s for URL: %s", c.Secret, secret, te.url)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestMissingCredentials(t *testing.T) {
|
func TestMissingCredentials(t *testing.T) {
|
||||||
helper := Wincred{}
|
helper := Wincred{}
|
||||||
_, _, err := helper.Get("https://adsfasdf.wrewerwer.com/asdfsdddd")
|
_, _, err := helper.Get("https://adsfasdf.wrewerwer.com/asdfsdddd")
|
||||||
|
|||||||
Reference in New Issue
Block a user