Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add parameters for sensitive files and sensitive file extensions #267

Merged
merged 1 commit into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,22 @@ dockle -ae pem -ae log [IMAGE_NAME]
or DOCKLE_ACCEPT_FILE_EXTENSIONS=pem,log dockle [IMAGE_NAME]
```

### Reject suspicious `environment variables` / `files` / `file extensions`

```bash
# --sensitive-word value, --sw value You can add acceptable keywords.
dockle -sw PRIVATE [IMAGE_NAME]
or DOCKLE_ACCEPT_KEYS=GPG_KEY,KEYCLOAK_VERSION dockle [IMAGE_NAME]

# --sensitive-file value, --sf value You can add acceptable file names.
dockle -sf .env [IMAGE_NAME]
or DOCKLE_REJECT_FILES=.env dockle [IMAGE_NAME]

# --sensitive-file-extension value, --se value You can add acceptable file extensions.
dockle -se pfx [IMAGE_NAME]
or DOCKLE_REJECT_FILE_EXTENSIONS=pfx dockle [IMAGE_NAME]
```

## Continuous Integration (CI)

You can scan your built image with `Dockle` in Travis CI/CircleCI.
Expand Down
10 changes: 10 additions & 0 deletions pkg/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,21 @@ OPTIONS:
EnvVar: "DOCKLE_ACCEPT_FILES",
Usage: "For CIS-DI-0010. You can add acceptable file names. e.g) -af id_rsa -af config.json",
},
cli.StringSliceFlag{
Name: "sensitive-file, sf",
EnvVar: "DOCKLE_REJECT_FILES",
Usage: "For CIS-DI-0010. You can add sensitive files to look for. e.g) -sf .git",
},
cli.StringSliceFlag{
Name: "accept-file-extension, ae",
EnvVar: "DOCKLE_ACCEPT_FILE_EXTENSIONS",
Usage: "For CIS-DI-0010. You can add acceptable file extensions. e.g) -ae pem -ae log",
},
cli.StringSliceFlag{
Name: "sensitive-file-extension, se",
EnvVar: "DOCKLE_REJECT_FILE_EXTENSIONS",
Usage: "For CIS-DI-0010. You can add sensitive files to look for. e.g) -se .pfx",
},
cli.StringFlag{
Name: "format, f",
Value: "",
Expand Down
22 changes: 18 additions & 4 deletions pkg/assessor/credential/credential.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,21 @@ import (
"github.com/goodwithtech/dockle/pkg/types"
)

var (
suspiciousFiles []string
suspiciousFileExtensions []string
)

type CredentialAssessor struct{}

func AddSensitiveFiles(files []string) {
suspiciousFiles = append(suspiciousFiles, files...)
}

func AddSensitiveFileExtensions(fileExtensions []string) {
suspiciousFileExtensions = append(suspiciousFileExtensions, fileExtensions...)
}

func (a CredentialAssessor) Assess(fileMap deckodertypes.FileMap) ([]*types.Assessment, error) {
log.Logger.Debug("Start scan : credential files")
assesses := []*types.Assessment{}
Expand Down Expand Up @@ -58,7 +71,7 @@ func makeMaps(keys []string) map[string]struct{} {
}

func (a CredentialAssessor) RequiredFiles() []string {
return []string{
return append([]string{
"credentials.json",
"credential.json",
// TODO: Only check .docker/config.json
Expand All @@ -76,11 +89,12 @@ func (a CredentialAssessor) RequiredFiles() []string {
"settings.py",
"database.yml",
"credentials.xml",
}
//".env",
}, suspiciousFiles...)
}

func (a CredentialAssessor) RequiredExtensions() []string {
return []string{
return append([]string{
// reference: https://github.com/eth0izzle/shhgit/blob/master/config.yaml
// TODO: potential sensitive data but they have many false-positives.
// Dockle need to analyze each file.
Expand All @@ -107,7 +121,7 @@ func (a CredentialAssessor) RequiredExtensions() []string {
".keychain",
".pcap",
".gnucache",
}
}, suspiciousFileExtensions...)
}

func (a CredentialAssessor) RequiredPermissions() []os.FileMode {
Expand Down
3 changes: 3 additions & 0 deletions pkg/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"os"
"strings"

"github.com/goodwithtech/dockle/pkg/assessor/credential"
"github.com/goodwithtech/dockle/pkg/assessor/manifest"

"github.com/containers/image/v5/transports/alltransports"
Expand Down Expand Up @@ -81,7 +82,9 @@ func Run(c *cli.Context) (err error) {
}
manifest.AddSensitiveWords(c.StringSlice("sensitive-word"))
manifest.AddAcceptanceKeys(c.StringSlice("accept-key"))
credential.AddSensitiveFiles(c.StringSlice("sensitive-file"))
scanner.AddAcceptanceFiles(c.StringSlice("accept-file"))
credential.AddSensitiveFileExtensions(c.StringSlice("sensitive-file-extension"))
scanner.AddAcceptanceExtensions(c.StringSlice("accept-file-extension"))
log.Logger.Debug("Start assessments...")
assessments, err := scanner.ScanImage(ctx, imageName, filePath, dockerOption)
Expand Down