mirror of
https://github.com/appleboy/drone-jenkins.git
synced 2026-06-04 18:23:57 +08:00
docs: document Jenkins authentication and CSRF protection methods
- Clarify and expand Jenkins authentication documentation, outlining API token, remote trigger token, and combined authentication options - Add detailed explanations and requirements for working with CSRF protection in Jenkins, including error guidance - Modify authentication requirements and usage examples to emphasize API token over remote trigger token, especially for secure Jenkins setups - Introduce a Troubleshooting section with solutions for common Jenkins authentication errors (403, 401, remote token issues) - Add corresponding CSRF protection notices and troubleshooting guidance to Chinese (Simplified and Traditional) documentation Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
@@ -46,10 +46,16 @@ Whether you're managing a hybrid CI/CD environment or orchestrating complex mult
|
|||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Jenkins Server Setup](#jenkins-server-setup)
|
- [Jenkins Server Setup](#jenkins-server-setup)
|
||||||
- [Authentication](#authentication)
|
- [Authentication](#authentication)
|
||||||
|
- [Understanding Jenkins Authentication](#understanding-jenkins-authentication)
|
||||||
|
- [CSRF Protection Notice](#csrf-protection-notice)
|
||||||
- [Parameters Reference](#parameters-reference)
|
- [Parameters Reference](#parameters-reference)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Command Line](#command-line)
|
- [Command Line](#command-line)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
|
- [Troubleshooting](#troubleshooting)
|
||||||
|
- [Error: 403 No valid crumb was included in the request](#error-403-no-valid-crumb-was-included-in-the-request)
|
||||||
|
- [Error: 401 Unauthorized](#error-401-unauthorized)
|
||||||
|
- [Remote Token Not Working](#remote-token-not-working)
|
||||||
- [Development](#development)
|
- [Development](#development)
|
||||||
- [Building](#building)
|
- [Building](#building)
|
||||||
- [Testing](#testing)
|
- [Testing](#testing)
|
||||||
@@ -125,7 +131,20 @@ docker run -d -v jenkins_home:/var/jenkins_home -p 8080:8080 -p 50000:50000 --re
|
|||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
Jenkins API tokens are recommended for authentication. To create an API token:
|
#### Understanding Jenkins Authentication
|
||||||
|
|
||||||
|
Jenkins supports multiple authentication methods for triggering builds. This tool supports two approaches:
|
||||||
|
|
||||||
|
**1. API Token Authentication (Recommended)**
|
||||||
|
|
||||||
|
Use Jenkins user credentials with an API token. This method:
|
||||||
|
|
||||||
|
- ✅ Works with all Jenkins configurations
|
||||||
|
- ✅ Supports CSRF protection (enabled by default in modern Jenkins)
|
||||||
|
- ✅ Supports wait mode to monitor build completion
|
||||||
|
- ✅ Provides full access to Jenkins API features
|
||||||
|
|
||||||
|
To create an API token:
|
||||||
|
|
||||||
1. Log into Jenkins
|
1. Log into Jenkins
|
||||||
2. Click on your username (top right)
|
2. Click on your username (top right)
|
||||||
@@ -136,7 +155,42 @@ Jenkins API tokens are recommended for authentication. To create an API token:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Alternatively, you can use a remote trigger token configured in your Jenkins job settings.
|
**2. Remote Trigger Token Authentication**
|
||||||
|
|
||||||
|
Use a remote trigger token configured in your Jenkins job. **Important limitations**:
|
||||||
|
|
||||||
|
- ⚠️ **Does not work** with Jenkins CSRF protection enabled (default in modern Jenkins)
|
||||||
|
- ⚠️ Requires anonymous users to have read access to the job, OR
|
||||||
|
- ⚠️ Must be combined with API token authentication (see Combined Authentication below)
|
||||||
|
|
||||||
|
**3. Combined Authentication (Recommended for Remote Tokens)**
|
||||||
|
|
||||||
|
Use both API token and remote trigger token together:
|
||||||
|
|
||||||
|
- ✅ Works with CSRF protection enabled
|
||||||
|
- ✅ Provides double authentication security
|
||||||
|
- ✅ Supports all features including wait mode
|
||||||
|
|
||||||
|
```bash
|
||||||
|
drone-jenkins \
|
||||||
|
--host http://jenkins.example.com/ \
|
||||||
|
--user YOUR_USERNAME \
|
||||||
|
--token YOUR_API_TOKEN \
|
||||||
|
--remote-token YOUR_REMOTE_TOKEN \
|
||||||
|
--job my-jenkins-job
|
||||||
|
```
|
||||||
|
|
||||||
|
#### CSRF Protection Notice
|
||||||
|
|
||||||
|
Modern Jenkins installations have CSRF protection enabled by default. If you encounter errors like:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
Error 403 No valid crumb was included in the request
|
||||||
|
```
|
||||||
|
|
||||||
|
This means your Jenkins has CSRF protection enabled. You **must** use API token authentication (option 1 or 3 above). Remote trigger token alone will not work.
|
||||||
|
|
||||||
|
For more information about Jenkins CSRF protection, see the [official Jenkins documentation](https://www.jenkins.io/doc/book/security/csrf-protection/).
|
||||||
|
|
||||||
### Parameters Reference
|
### Parameters Reference
|
||||||
|
|
||||||
@@ -155,10 +209,19 @@ Alternatively, you can use a remote trigger token configured in your Jenkins job
|
|||||||
| Timeout | `--timeout` | `PLUGIN_TIMEOUT`, `JENKINS_TIMEOUT` | No | Maximum time to wait for job completion (default: 30m) |
|
| Timeout | `--timeout` | `PLUGIN_TIMEOUT`, `JENKINS_TIMEOUT` | No | Maximum time to wait for job completion (default: 30m) |
|
||||||
| Debug | `--debug` | `PLUGIN_DEBUG`, `JENKINS_DEBUG` | No | Enable debug mode to show detailed parameter information (default: false) |
|
| Debug | `--debug` | `PLUGIN_DEBUG`, `JENKINS_DEBUG` | No | Enable debug mode to show detailed parameter information (default: false) |
|
||||||
|
|
||||||
**Authentication Requirements**: You must provide either:
|
**Authentication Requirements**:
|
||||||
|
|
||||||
- `user` + `token` (API token authentication), OR
|
For Jenkins with **CSRF protection enabled** (default in modern Jenkins):
|
||||||
- `remote-token` (remote trigger token authentication)
|
|
||||||
|
- **Required**: `user` + `token` (API token authentication)
|
||||||
|
- **Optional**: `remote-token` (for additional security)
|
||||||
|
|
||||||
|
For Jenkins with **CSRF protection disabled** (not recommended):
|
||||||
|
|
||||||
|
- **Option 1**: `user` + `token` (API token authentication)
|
||||||
|
- **Option 2**: `remote-token` only (requires anonymous read access to job)
|
||||||
|
|
||||||
|
**Important**: If you encounter "403 No valid crumb" errors, you must use API token authentication (`user` + `token`).
|
||||||
|
|
||||||
**Parameters Format**: The `parameters` field accepts a multi-line string where each line contains one `key=value` pair:
|
**Parameters Format**: The `parameters` field accepts a multi-line string where each line contains one `key=value` pair:
|
||||||
|
|
||||||
@@ -220,9 +283,22 @@ drone-jenkins \
|
|||||||
--job my-jenkins-job
|
--job my-jenkins-job
|
||||||
```
|
```
|
||||||
|
|
||||||
**Using remote token authentication:**
|
**Using combined authentication (API token + remote token - Recommended):**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
drone-jenkins \
|
||||||
|
--host http://jenkins.example.com/ \
|
||||||
|
--user appleboy \
|
||||||
|
--token XXXXXXXX \
|
||||||
|
--remote-token REMOTE_TOKEN_HERE \
|
||||||
|
--job my-jenkins-job
|
||||||
|
```
|
||||||
|
|
||||||
|
**Using remote token only (only works without CSRF protection):**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Note: This will fail if Jenkins has CSRF protection enabled
|
||||||
|
# You will get "403 No valid crumb" error
|
||||||
drone-jenkins \
|
drone-jenkins \
|
||||||
--host http://jenkins.example.com/ \
|
--host http://jenkins.example.com/ \
|
||||||
--remote-token REMOTE_TOKEN_HERE \
|
--remote-token REMOTE_TOKEN_HERE \
|
||||||
@@ -309,6 +385,18 @@ docker run --rm \
|
|||||||
ghcr.io/appleboy/drone-jenkins
|
ghcr.io/appleboy/drone-jenkins
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**With combined authentication (API token + remote token):**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run --rm \
|
||||||
|
-e JENKINS_URL=http://jenkins.example.com/ \
|
||||||
|
-e JENKINS_USER=appleboy \
|
||||||
|
-e JENKINS_TOKEN=xxxxxxx \
|
||||||
|
-e JENKINS_REMOTE_TOKEN=your_remote_token \
|
||||||
|
-e JENKINS_JOB=my-jenkins-job \
|
||||||
|
ghcr.io/appleboy/drone-jenkins
|
||||||
|
```
|
||||||
|
|
||||||
**Wait for job completion:**
|
**Wait for job completion:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -360,6 +448,57 @@ docker run --rm \
|
|||||||
|
|
||||||
For more detailed examples and advanced configurations, see [DOCS.md](DOCS.md).
|
For more detailed examples and advanced configurations, see [DOCS.md](DOCS.md).
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Error: 403 No valid crumb was included in the request
|
||||||
|
|
||||||
|
**Cause**: Your Jenkins server has CSRF protection enabled (this is the default in modern Jenkins). Learn more at the [Jenkins CSRF Protection documentation](https://www.jenkins.io/doc/book/security/csrf-protection/).
|
||||||
|
|
||||||
|
**Solution**: Use API token authentication instead of remote token only:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# ❌ This will fail with CSRF protection enabled
|
||||||
|
drone-jenkins \
|
||||||
|
--host http://jenkins.example.com/ \
|
||||||
|
--remote-token YOUR_REMOTE_TOKEN \
|
||||||
|
--job my-jenkins-job
|
||||||
|
|
||||||
|
# ✅ Use this instead
|
||||||
|
drone-jenkins \
|
||||||
|
--host http://jenkins.example.com/ \
|
||||||
|
--user YOUR_USERNAME \
|
||||||
|
--token YOUR_API_TOKEN \
|
||||||
|
--job my-jenkins-job
|
||||||
|
|
||||||
|
# ✅ Or combine both for additional security
|
||||||
|
drone-jenkins \
|
||||||
|
--host http://jenkins.example.com/ \
|
||||||
|
--user YOUR_USERNAME \
|
||||||
|
--token YOUR_API_TOKEN \
|
||||||
|
--remote-token YOUR_REMOTE_TOKEN \
|
||||||
|
--job my-jenkins-job
|
||||||
|
```
|
||||||
|
|
||||||
|
### Error: 401 Unauthorized
|
||||||
|
|
||||||
|
**Cause**: Invalid credentials or incorrect authentication method.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
|
||||||
|
1. Verify your username and API token are correct
|
||||||
|
2. Ensure you're using an API token, not your Jenkins password
|
||||||
|
3. Check if you have permission to trigger the job
|
||||||
|
4. Make sure both `--user` and `--token` are provided together
|
||||||
|
|
||||||
|
### Remote Token Not Working
|
||||||
|
|
||||||
|
**Cause**: Remote trigger tokens alone only work in specific scenarios:
|
||||||
|
|
||||||
|
- Jenkins has CSRF protection disabled (not recommended), AND
|
||||||
|
- Anonymous users have read access to the job
|
||||||
|
|
||||||
|
**Solution**: Use combined authentication (API token + remote token) as shown in the examples above.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|||||||
@@ -46,6 +46,7 @@
|
|||||||
- [配置](#配置)
|
- [配置](#配置)
|
||||||
- [Jenkins 服务器设置](#jenkins-服务器设置)
|
- [Jenkins 服务器设置](#jenkins-服务器设置)
|
||||||
- [认证](#认证)
|
- [认证](#认证)
|
||||||
|
- [CSRF 保护注意事项](#csrf-保护注意事项)
|
||||||
- [参数参考](#参数参考)
|
- [参数参考](#参数参考)
|
||||||
- [使用方式](#使用方式)
|
- [使用方式](#使用方式)
|
||||||
- [命令行](#命令行)
|
- [命令行](#命令行)
|
||||||
@@ -138,6 +139,18 @@ docker run -d -v jenkins_home:/var/jenkins_home -p 8080:8080 -p 50000:50000 --re
|
|||||||
|
|
||||||
或者,您可以使用在 Jenkins 任务设置中配置的远程触发令牌。
|
或者,您可以使用在 Jenkins 任务设置中配置的远程触发令牌。
|
||||||
|
|
||||||
|
#### CSRF 保护注意事项
|
||||||
|
|
||||||
|
现代 Jenkins 安装默认启用 CSRF 保护。如果您遇到以下错误:
|
||||||
|
|
||||||
|
```
|
||||||
|
Error 403 No valid crumb was included in the request
|
||||||
|
```
|
||||||
|
|
||||||
|
这表示您的 Jenkins 已启用 CSRF 保护。您**必须**使用 API 令牌认证(user + token)。单独使用远程触发令牌将无法工作。
|
||||||
|
|
||||||
|
如需更多关于 Jenkins CSRF 保护的信息,请参阅 [Jenkins 官方文档](https://www.jenkins.io/doc/book/security/csrf-protection/)。
|
||||||
|
|
||||||
### 参数参考
|
### 参数参考
|
||||||
|
|
||||||
| 参数 | CLI 标志 | 环境变量 | 必需 | 说明 |
|
| 参数 | CLI 标志 | 环境变量 | 必需 | 说明 |
|
||||||
|
|||||||
@@ -46,6 +46,7 @@
|
|||||||
- [設定](#設定)
|
- [設定](#設定)
|
||||||
- [Jenkins 伺服器設定](#jenkins-伺服器設定)
|
- [Jenkins 伺服器設定](#jenkins-伺服器設定)
|
||||||
- [認證](#認證)
|
- [認證](#認證)
|
||||||
|
- [CSRF 保護注意事項](#csrf-保護注意事項)
|
||||||
- [參數參考](#參數參考)
|
- [參數參考](#參數參考)
|
||||||
- [使用方式](#使用方式)
|
- [使用方式](#使用方式)
|
||||||
- [命令列](#命令列)
|
- [命令列](#命令列)
|
||||||
@@ -138,6 +139,18 @@ docker run -d -v jenkins_home:/var/jenkins_home -p 8080:8080 -p 50000:50000 --re
|
|||||||
|
|
||||||
或者,您可以使用在 Jenkins 任務設定中配置的遠端觸發令牌。
|
或者,您可以使用在 Jenkins 任務設定中配置的遠端觸發令牌。
|
||||||
|
|
||||||
|
#### CSRF 保護注意事項
|
||||||
|
|
||||||
|
現代 Jenkins 安裝預設啟用 CSRF 保護。如果您遇到以下錯誤:
|
||||||
|
|
||||||
|
```
|
||||||
|
Error 403 No valid crumb was included in the request
|
||||||
|
```
|
||||||
|
|
||||||
|
這表示您的 Jenkins 已啟用 CSRF 保護。您**必須**使用 API 令牌認證(user + token)。單獨使用遠端觸發令牌將無法運作。
|
||||||
|
|
||||||
|
如需更多關於 Jenkins CSRF 保護的資訊,請參閱 [Jenkins 官方文件](https://www.jenkins.io/doc/book/security/csrf-protection/)。
|
||||||
|
|
||||||
### 參數參考
|
### 參數參考
|
||||||
|
|
||||||
| 參數 | CLI 旗標 | 環境變數 | 必要 | 說明 |
|
| 參數 | CLI 旗標 | 環境變數 | 必要 | 說明 |
|
||||||
|
|||||||
Reference in New Issue
Block a user