Skip to content

Add Gitlab provider #1

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.

Sign up for GitHub

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

Merged
sebastianfeldmann merged 1 commit into from
Nov 26, 2024
Merged

Add Gitlab provider #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 50 additions & 0 deletions src/Regex/Supplier/Gitlab.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

/**
* This file is part of CaptainHook Secrets.
*
* (c) Sebastian Feldmann <sf@sebastian-feldmann.info>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace CaptainHook\Secrets\Regex\Supplier;

use CaptainHook\Secrets\Regex\Supplier;

/**
* Gitlab regex
*
* Provides the regex to find Gitlab secrets.
*
* @package CaptainHook-Secrets
* @since Class available since Release 0.9.6
*/
final class Gitlab implements Supplier {

/**
* Sourced from https://github.com/gitlabhq/gitlabhq/blob/master/gems/gitlab-secret_detection/lib/gitleaks.toml#L4-L51
* @return string[]
*/
public function patterns(): array {
return [
// GitLab Personal Access Token
'#' . Util::OPTIONAL_QUOTE . '(glpat-[0-9a-zA-Z_\\-]{20})' . Util::OPTIONAL_QUOTE . '#',
// GitLab Pipeline Trigger Token
'#' . Util::OPTIONAL_QUOTE . '(glptt-[0-9a-zA-Z_\\-]{40})' . Util::OPTIONAL_QUOTE . '#',
// GitLab Runner Registration Token
'#' . Util::OPTIONAL_QUOTE . '(GR1348941[0-9a-zA-Z_\\-]{20})' . Util::OPTIONAL_QUOTE . '#',
// GitLab OAuth Application Secrets
'#' . Util::OPTIONAL_QUOTE . '(gloas-[0-9a-zA-Z_\\-]{64})' . Util::OPTIONAL_QUOTE . '#',
// GitLab Feed token
'#' . Util::OPTIONAL_QUOTE . '(glft-[0-9a-zA-Z_\\-]{20})' . Util::OPTIONAL_QUOTE . '#',
// GitLab Agent for Kubernetes token
'#' . Util::OPTIONAL_QUOTE . '(glagent-[0-9a-zA-Z_\\-]{50})' . Util::OPTIONAL_QUOTE . '#',
// GitLab Incoming email token
'#' . Util::OPTIONAL_QUOTE . '(glimt-[0-9a-zA-Z_\\-]{25})' . Util::OPTIONAL_QUOTE . '#',
];
}
}
29 changes: 29 additions & 0 deletions tests/Regex/Supplier/GitlabTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

namespace CaptainHook\Secrets\Regex\Supplier;

use CaptainHook\Secrets\Detector;
use PHPUnit\Framework\TestCase;

final class GitlabTest extends TestCase
{
public function testDetectSecret(): void
{
$haystack = 'bar glpat-mBvGsDcJUvxvFZktWpzz baz';
$detector = Detector::create()->useSuppliers(new Gitlab());
$result = $detector->detectIn($haystack);

$this->assertTrue($result->wasSecretDetected());
$this->assertCount(1, $result->matches());
}

public function testDontDetectSecret(): void
{
$haystack = 'bar glpat-mBvGsDcJUvx... gitlab glpat-15487234 glpat-mBvG{}_JUvxvFZktWpzz';
$detector = Detector::create()->useSuppliers(new Gitlab());
$result = $detector->detectIn($haystack);

$this->assertFalse($result->wasSecretDetected());
$this->assertCount(0, $result->matches());
}
}
Loading