https://github.com/ConsenSys/quorum-security-plugin-enterprise

Quorum Security Plugin to provide TLS configuration and enable OAuth2-compliant resource server for JSON RPC
https://github.com/ConsenSys/quorum-security-plugin-enterprise

protocols-team-goquorum

Last synced: 3 months ago
JSON representation

Quorum Security Plugin to provide TLS configuration and enable OAuth2-compliant resource server for JSON RPC

• Host: GitHub
• URL: https://github.com/ConsenSys/quorum-security-plugin-enterprise
• Owner: Consensys
• License: apache-2.0
• Created: 2019-07-22T13:16:39.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T13:31:37.000Z (over 1 year ago)
• Last Synced: 2024-06-21T16:57:06.456Z (5 months ago)
• Topics: protocols-team-goquorum
• Language: Go
• Homepage:
• Size: 2.36 MB
• Stars: 5
• Watchers: 34
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-quorum - Quorum Security Plugin - Plugin enabling securing JSON-RPC server endpoints by adding TLS and support for OAuth2 based authentication (Software components / Plugins)

README

        
# Quorum Enterprise Security Plugin

This is to provide a backend support for `geth` JSON RPC servers by implementing services from [security plugin interface](https://github.com/jpmorganchase/quorum-plugin-definitions/blob/master/security.proto):

- `TLSConfigurationSource` to provide TLS configuration for HTTP and WS RPC servers

- `AuthenticationManager` to enable RPC servers being OAuth2-compliant resource servers

  that support both JSON Web Token ([JWT](https://tools.ietf.org/html/rfc7519)) and opaque access token format

## Prerequisites

- Go 1.13.x

## Quick Start

```bash

$ make

$ PLUGIN_DEST_PATH= make dist-local

```

## Configuration

Refer to the official documentation [here](http://docs.goquorum.com/en/latest/PluggableArchitecture/Plugins/security/For-Users/) for more details

## Token Validation

Access token is validated by one of the following methods when configured:

- [JSON Web Signature](https://tools.ietf.org/html/rfc7515): The JSON Web Key Set ([JWKS](https://tools.ietf.org/html/rfc7517)) is a set of keys which contains the public keys used to verify

  the JSON Web Token (JWT) issued by the authorization server. JWKS is retrieved via a preconfigured endpoint.

- [OAuth2 Token Introspection](https://tools.ietf.org/html/rfc7662): support HTTP Basic Authentication and Form Authentication

  to access the protected introspection endpoint. Other authentication methods may be supported in the future.