Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crashappsec/github-analyzer

A tool to check the security settings of Github Organizations.
https://github.com/crashappsec/github-analyzer

Last synced: 29 days ago
JSON representation

A tool to check the security settings of Github Organizations.

Host: GitHub
URL: https://github.com/crashappsec/github-analyzer
Owner: crashappsec
License: apache-2.0
Created: 2022-09-23T16:44:47.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-06-14T13:57:13.000Z (over 1 year ago)
Last Synced: 2024-08-04T00:13:55.920Z (4 months ago)
Language: Go
Homepage:
Size: 359 KB
Stars: 69
Watchers: 5
Forks: 7
Open Issues: 26
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-software-supply-chain-security - crashappsec/github-analyzer: A tool to check the security settings of Github Organizations.

README

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/crashappsec/github-analyzer/blob/main/LICENSE)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://api.securityscorecards.dev/projects/github.com/crashappsec/github-analyzer)
[![Go Report Card](https://goreportcard.com/badge/github.com/ossf/scorecard/v4)](https://goreportcard.com/report/github.com/crashappsec/github-analyzer)

# Github Analyzer

Audits a GitHub organization for potential security issues. The tool is
currently in pre-alpha stage and only supports limited functionality, however
we will be actively adding checks in the upcoming months, and welcome
feature requests or contributions! Once the analysis is complete, a static HTML
with the summary of the results is rendered in localhost:3000 as shown below:

![gh-analyzer](https://user-images.githubusercontent.com/4614044/196647323-8138c053-644c-42a7-86f2-d94a7ce5e295.gif)

- [Available Checks](#available-checks)
- [Sample Output](#sample-output)
- [How to run](#how-to-run)
- [Running locally](#running-locally)
- [Running using Docker](#running-using-docker)
- [Permissions](#permissions)
- [Credits](#credits)

## Available Checks

## Sample Output

For each issue identified, a JSON with associated information will be
generated. A sample output snippet is as follows:

```
...
{
"id": "CONFIG_AS_1",
"name": "Secret scanning disabled for new repositories",
"severity": 3,
"category": "Information disclosure to untrusted parties",
"tags": [
"GitHub Advanced Security feature"
],
"description": "Secret scanning disabled for org testorg",
"resource": [
{
"id": "testorg",
"kind": "Organization"
}
],
"cwes": [
319
],
"remediation": "Pleasee see https://docs.github.com/en/github-ae@latest/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories for how to enable secret scanning in your repositories"
},
{
"id": "AUTH_2FA_2",
"name": "Users without 2FA configured",
"severity": 2,
"category": "Authentication",
"description": "The following collaborators have not enabled 2FA: testuser1, testuser2",
"resource": [
{
"id": "testuser1",
"kind": "UserAccount"
},
{
"id": "testuser2",
"kind": "UserAccount"
}
],
"cwes": [
308
],
"remediation": "Please see https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication for steps on how to configure 2FA for individual accounts"
}
...
```

## How to run

You can see available options via the `--help` flag.

### Running locally

- Install with:
```sh
go install -v github.com/crashappsec/github-analyzer/cmd/github-analyzer@latest
```
- Run with:
```sh
$GOPATH/bin/github-analyzer \
--organization \
--token "$GH_SECURITY_AUDITOR_TOKEN"
```

### Running using Docker

- After cloning the repo, build the container using:
```sh
docker compose build --no-cache
```
- Run

```sh
docker compose run \
--rm --service-ports \
github-analyzer \
--organization \
--output output \
--token "$GH_SECURITY_AUDITOR_TOKEN"
```

## Permissions

For **API-based based checks**, you need to pass in GitHub Token
(either personal access token (PAT) or token derived from GitHub app installation)
with the appropriate permissions. Example usage:

```sh
github-analyzer \
--organization \
--token "$GH_SECURITY_AUDITOR_TOKEN"
```

See [our wiki](https://github.com/crashappsec/github-analyzer/wiki/Setting-up-GitHub#creating-a-token)
for instructions on setting up a token to be used with the github-analyzer.

For **experimental scraping-based checks**, you need to pass in your username
and password, as well your two factor authentication one-time-password, as
needed. Example usage:

```shell
github-analyzer \
--organization crashappsec \
--token "$GH_SECURITY_AUDITOR_TOKEN" \
--userPermissionStats \
--enableScraping \
--username "$GH_SECURITY_AUDITOR_USERNAME" \
--password "$GH_SECURITY_AUDITOR_PASSWORD" \
--otpSeed "$GH_SECURITY_AUDITOR_OTP_SEED"
```

See [our wiki](https://github.com/crashappsec/github-analyzer/wiki/Setting-up-GitHub#setting-up-2fa-experimental)
for instructions on setting up a token to be used with the analyzer.

## Credits

Project was originally ported from Mike de Libero's
[auditor](https://github.com/CodeReconCo/githubsecurityauditor)
with the author's permission.