https://github.com/jenkinsci/authorize-project-plugin

Run a job with specified authorization
https://github.com/jenkinsci/authorize-project-plugin

adopt-this-plugin jenkins-plugin security

Last synced: about 1 month ago
JSON representation

Run a job with specified authorization

• Host: GitHub
• URL: https://github.com/jenkinsci/authorize-project-plugin
• Owner: jenkinsci
• License: mit
• Created: 2013-11-23T10:51:33.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2025-05-02T18:16:32.000Z (about 1 year ago)
• Last Synced: 2025-05-02T19:25:44.556Z (about 1 year ago)
• Topics: adopt-this-plugin, jenkins-plugin, security
• Language: Java
• Homepage: https://plugins.jenkins.io/authorize-project/
• Size: 894 KB
• Stars: 17
• Watchers: 98
• Forks: 38
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Authorize Project Plugin for Jenkins

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/authorize-project.svg)](https://plugins.jenkins.io/authorize-project)

[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/authorize-project.svg?color=blue)](https://plugins.jenkins.io/authorize-project)

[![Build Status](https://ci.jenkins.io/buildStatus/icon?job=Plugins%2Fauthorize-project-plugin%2Fmaster)](https://ci.jenkins.io/job/Plugins/job/authorize-project-plugin/job/master/)

[![GitHub release](https://img.shields.io/github/v/release/jenkinsci/authorize-project-plugin)](https://github.com/jenkinsci/authorize-project-plugin/releases)

[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

Configure projects to run builds with specified authorization using [QueueItemAuthenticator](https://javadoc.jenkins.io/jenkins/security/QueueItemAuthenticator.html).

## Features

### Authorization Strategies

| Strategy | Description |

|----------|-------------|

| **Run as the user who triggered the build** | Does not work for scheduled or polled builds. Only users with BUILD permission can configure projects. |

| **Run as anonymous** | Runs the build with no permissions. |

| **Run as a specific user** | Requires password/API token of the target user, unless you are an administrator or specifying yourself. |

| **Run as SYSTEM** | Provided only to override the global configuration. Plugins may treat SYSTEM as anonymous. |

### Access Control

When "Run as Specific User" is selected:

- Administrators can specify any user without authentication.

- Non-admin users specifying a different user must provide credentials (password or API token).

- Only administrators and the configured user can modify the project configuration, unless "Don't restrict job configuration" is enabled.

## Configuration

### Global Security

Add "Configure Build Authorizations in Project Configuration" under **Manage Jenkins > Security > Access Control for Builds**. You can also disable specific strategies from this page.

![Global Security Configuration](docs/images/authorize-project_01_globalsecurity.png)

### Project Authorization

A new **Authorization** menu appears in project sidebars, where you select the authorization strategy for that project.

| | |

|---|---|

| ![Sidebar](docs/images/sidebar.png) | ![Authorization Page](docs/images/authorization-page.png) |

When using "Run as Specific User", you can authenticate via password or API token (useful for non-password-based security realms).

![Specific User](docs/images/authorization-page-specific-user.png)

Unauthorized configuration attempts are blocked:

![Access Denied](docs/images/access-denied.png)

## Extension Point

Add custom authorization strategies by extending [`AuthorizeProjectStrategy`](https://javadoc.jenkins.io/plugin/authorize-project/org/jenkinsci/plugins/authorizeproject/AuthorizeProjectStrategy.html):

```java

public abstract Authentication authenticate(

    hudson.model.AbstractProject, ?> project,

    hudson.model.Queue.Item item

);

```

Use `AuthorizeProjectStrategyDescriptor` for your `Descriptor`. For global configuration properties, provide a `global-security.jelly` and override `AuthorizeProjectStrategyDescriptor#configureFromGlobalSecurity`.

## Issues

Report bugs and request features via [GitHub Issues](https://github.com/jenkinsci/authorize-project-plugin/issues).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## Changelog

See [GitHub Releases](https://github.com/jenkinsci/authorize-project-plugin/releases) for recent changes and the [Changelog Archive](https://github.com/jenkinsci/authorize-project-plugin/blob/authorize-project-1.6.0/docs/CHANGELOG.old.md) for version 1.3.0 and older.