|
| 1 | +# Nancy Vulnerability Scanner Setup |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +Nancy is an optional vulnerability scanner from Sonatype that checks your Go dependencies against the OSS Index for known security vulnerabilities. It's integrated into the CI/CD pipeline but requires authentication to function. |
| 6 | + |
| 7 | +## Current Configuration |
| 8 | + |
| 9 | +Nancy is configured with `continue-on-error: true` in the GitHub Actions workflow, meaning: |
| 10 | +- ✅ The CI pipeline will **not fail** if Nancy authentication is missing |
| 11 | +- ✅ Gosec security scanner still runs and provides security scanning |
| 12 | +- ⚠️ Nancy will show a warning but won't block your builds |
| 13 | + |
| 14 | +## Why Nancy Requires Authentication |
| 15 | + |
| 16 | +Nancy connects to the [Sonatype OSS Index](https://ossindex.sonatype.org/) which requires a free account to prevent abuse and rate limiting. |
| 17 | + |
| 18 | +## How to Enable Nancy (Optional) |
| 19 | + |
| 20 | +If you want to enable full vulnerability scanning with Nancy, follow these steps: |
| 21 | + |
| 22 | +### 1. Create a Free OSS Index Account |
| 23 | + |
| 24 | +1. Go to https://ossindex.sonatype.org/ |
| 25 | +2. Click "Sign Up" and create a free account |
| 26 | +3. Verify your email address |
| 27 | + |
| 28 | +### 2. Get Your API Token |
| 29 | + |
| 30 | +1. Log in to OSS Index |
| 31 | +2. Go to your account settings |
| 32 | +3. Generate an API token |
| 33 | +4. Copy your username and token |
| 34 | + |
| 35 | +### 3. Add GitHub Secrets |
| 36 | + |
| 37 | +Add the following secrets to your GitHub repository: |
| 38 | + |
| 39 | +1. Go to your repository on GitHub |
| 40 | +2. Navigate to **Settings** → **Secrets and variables** → **Actions** |
| 41 | +3. Click **New repository secret** |
| 42 | +4. Add these two secrets: |
| 43 | + - Name: `NANCY_USERNAME`, Value: your OSS Index username |
| 44 | + - Name: `NANCY_TOKEN`, Value: your OSS Index API token |
| 45 | + |
| 46 | +### 4. Update the Workflow (Optional) |
| 47 | + |
| 48 | +If you added the secrets, you can update `.github/workflows/ci.yml` to use them: |
| 49 | + |
| 50 | +```yaml |
| 51 | + - name: Run Nancy vulnerability scanner |
| 52 | + if: ${{ !env.ACT }} |
| 53 | + continue-on-error: true |
| 54 | + env: |
| 55 | + NANCY_USERNAME: ${{ secrets.NANCY_USERNAME }} |
| 56 | + NANCY_TOKEN: ${{ secrets.NANCY_TOKEN }} |
| 57 | + run: | |
| 58 | + go install github.com/sonatype-nexus-community/nancy@latest |
| 59 | + if [ -n "$NANCY_TOKEN" ]; then |
| 60 | + go list -json -deps ./... | nancy sleuth --username "$NANCY_USERNAME" --token "$NANCY_TOKEN" |
| 61 | + else |
| 62 | + go list -json -deps ./... | nancy sleuth || echo "⚠️ Nancy scan skipped - requires OSS Index authentication." |
| 63 | + fi |
| 64 | +``` |
| 65 | +
|
| 66 | +## Local Usage |
| 67 | +
|
| 68 | +To run Nancy locally: |
| 69 | +
|
| 70 | +### Without Authentication (Limited) |
| 71 | +```bash |
| 72 | +go install github.com/sonatype-nexus-community/nancy@latest |
| 73 | +go list -json -deps ./... | nancy sleuth |
| 74 | +``` |
| 75 | + |
| 76 | +### With Authentication (Recommended) |
| 77 | +```bash |
| 78 | +# Set environment variables |
| 79 | +export NANCY_USERNAME="your_username" |
| 80 | +export NANCY_TOKEN="your_token" |
| 81 | + |
| 82 | +# Run Nancy |
| 83 | +go list -json -deps ./... | nancy sleuth --username "$NANCY_USERNAME" --token "$NANCY_TOKEN" |
| 84 | +``` |
| 85 | + |
| 86 | +Or add to your `.env` file (don't commit this): |
| 87 | +```bash |
| 88 | +NANCY_USERNAME=your_username |
| 89 | +NANCY_TOKEN=your_token |
| 90 | +``` |
| 91 | + |
| 92 | +## Alternative: Use Make Command |
| 93 | + |
| 94 | +The Makefile includes a vulnerability scan command: |
| 95 | + |
| 96 | +```bash |
| 97 | +make vulnerability-scan |
| 98 | +``` |
| 99 | + |
| 100 | +This will attempt to run Nancy. If you have credentials configured, it will use them. |
| 101 | + |
| 102 | +## What Nancy Checks |
| 103 | + |
| 104 | +Nancy scans your Go dependencies (`go.mod` and transitive dependencies) against the OSS Index database for: |
| 105 | +- Known CVEs (Common Vulnerabilities and Exposures) |
| 106 | +- Security advisories |
| 107 | +- Vulnerability severity scores |
| 108 | +- Affected version ranges |
| 109 | +- Remediation recommendations |
| 110 | + |
| 111 | +## Current Security Coverage |
| 112 | + |
| 113 | +Even without Nancy, your CI pipeline includes: |
| 114 | +- ✅ **Gosec** - Static analysis security scanner for Go code |
| 115 | +- ✅ **Go Module Checksums** - Ensures dependency integrity |
| 116 | +- ✅ **Unit Tests** - Including security-focused tests |
| 117 | +- ✅ **Code Review** - Manual security review process |
| 118 | + |
| 119 | +Nancy adds an additional layer by checking for known vulnerabilities in dependencies. |
| 120 | + |
| 121 | +## Troubleshooting |
| 122 | + |
| 123 | +### "401 Unauthorized" Error |
| 124 | +This means Nancy couldn't authenticate with OSS Index. Either: |
| 125 | +- You haven't set up credentials (this is fine - it won't break CI) |
| 126 | +- Your credentials are incorrect |
| 127 | +- Your API token has expired |
| 128 | + |
| 129 | +### Rate Limiting |
| 130 | +Without authentication, OSS Index has strict rate limits. If you hit them: |
| 131 | +- Wait a few minutes and try again |
| 132 | +- Consider setting up authentication (free and unlimited) |
| 133 | + |
| 134 | +### Nancy Installation Issues |
| 135 | +If Nancy fails to install: |
| 136 | +```bash |
| 137 | +# Clear Go module cache |
| 138 | +go clean -modcache |
| 139 | + |
| 140 | +# Reinstall |
| 141 | +go install github.com/sonatype-nexus-community/nancy@latest |
| 142 | +``` |
| 143 | + |
| 144 | +## Recommendations |
| 145 | + |
| 146 | +### For Open Source Projects |
| 147 | +- Authentication is optional but recommended |
| 148 | +- Use GitHub secrets to protect credentials |
| 149 | +- Document in your CONTRIBUTING.md if you require Nancy to pass |
| 150 | + |
| 151 | +### For Private/Enterprise Projects |
| 152 | +- **Strongly recommended** to set up authentication |
| 153 | +- Consider making Nancy a required check (remove `continue-on-error`) |
| 154 | +- Regular vulnerability scanning is a security best practice |
| 155 | + |
| 156 | +### For Personal Projects |
| 157 | +- Authentication is optional |
| 158 | +- Gosec provides good security coverage without it |
| 159 | +- Enable Nancy if you want comprehensive dependency scanning |
| 160 | + |
| 161 | +## Resources |
| 162 | + |
| 163 | +- [Nancy GitHub Repository](https://github.com/sonatype-nexus-community/nancy) |
| 164 | +- [OSS Index](https://ossindex.sonatype.org/) |
| 165 | +- [Sonatype Documentation](https://ossindex.sonatype.org/doc/rest) |
| 166 | +- [GitHub Actions Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) |
| 167 | + |
| 168 | +## Summary |
| 169 | + |
| 170 | +Nancy is **optional** and **non-blocking** in this project's CI pipeline. The security-scan job will pass regardless of Nancy's status. If you want full vulnerability scanning, follow the setup steps above. Otherwise, Gosec provides excellent security scanning for your code. |
| 171 | + |
0 commit comments