nextflow-io/nextflow

Support Gitlab OAuth 2.0 identity provider API

Open

#4,082 opened on Jul 5, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Groovy (784 forks)batch import
good first issuesoftware/gitstale

Repository metrics

Stars
 (3,382 stars)
PR merge metrics
 (Avg merge 16d 9h) (54 merged PRs in 30d)

Description

New feature

Hi! Thanks for using Nextflow and submitting the proposal for a new feature or the enhancement of an existing functionality.

Would nextflow support gitlab OAuth 2.0 identity provider API to enable cloning of gitlab repo's using following command: git clone https://oauth2:ACCESS_TOKEN@somegitlab.com/vendor/package.git

Usage scenario

(What's the main usage case and the deployment scenario addressed by this proposal) this will enable repositories to be pulled and ran with both private tokens and also OAuth token. Passing the user and token(OAuth token) fails and causes an authentication error even if it's a valid way of cloning any private gitlab repositories.

Am personally using a gitlab application to authenticate users and then retrieve an access token which I can then use to access and perform api functions on behalf of the use.

https://docs.gitlab.com/ee/api/oauth2.html

Suggest implementation

https://github.com/nextflow-io/nextflow/commit/da00175dadd3386332ed54f7c2440642a39b3805

This might be closely related and implemented in the https://github.com/nextflow-io/nextflow/commit/da00175dadd3386332ed54f7c2440642a39b3805#diff-d3e1b1e20532a0d163e0ea16fdafc56705b79046d086472505c259f0b54dd00d file by using a conditional to check if user token is either a private token or auth token and running different git clone commands.

(Highlight the main building blocks of a possible implementation and/or related components)

Contributor guide

Research direction
Investigate the implementation of OAuth 2.0 for GitLab in the codebase, focusing on the authentication flow in scm related classes. Adapt the existing Git clone logic to differentiate between personal access tokens and OAuth tokens.
Tech stack
groovy
Domain
authenticationapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65