From 7d844f72d412e88e15b63c5e630edf7f610911c0 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 5 Feb 2020 14:49:53 +0100 Subject: [PATCH 1/5] docs(security): typo --- SECURITY.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index f7ecc88..6fe2daa 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,6 +1,6 @@ # Security Policy -At caos we are extremely grateful for security aware people that disclose vulnerabilities to us and the open source community. All reports will be investigated by our team. +At CAOS we are extremely grateful for security aware people that disclose vulnerabilities to us and the open source community. All reports will be investigated by our team. ## Supported Versions @@ -8,7 +8,7 @@ After the initial Release the following version support will apply | Version | Supported | | ------- | ------------------ | -| 1.x.x | :white_check_mark: (note yet available) | +| 1.x.x | :white_check_mark: (not yet available) | | 0.x.x | :x: | ## Reporting a vulnerability From 2d9a9ad192d22a6656dbcc4e5dfc0e7fe65d4ea6 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 5 Feb 2020 14:56:56 +0100 Subject: [PATCH 2/5] docs(readme): initial readme --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cbe2479..1cdd916 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,46 @@ -# oidc +# OpenID Connect SDK (client and server) for Go ![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg) ![Github Release Badge](https://github.com/caos/oidc/workflows/Release/badge.svg) [![GitHub release](https://img.shields.io/github/release/caos/oidc)](https://GitHub.com/caos/oidc/releases/) [![GitHub license](https://img.shields.io/github/license/caos/oidc)](https://github.com/caos/oidc/blob/master/LICENSE) -OpenID Connect SDK (client and server) for Go +> This project is in alpha state. It can AND will continue breaking until version 1.0.0 is released + +## What Is It + +This project is a easy to use client and server implementation for the `OIDC` (Open ID Connect) standard written for `Go`. + +Whenever possible we tried to reuse / extend existing packages like `OAuth2 for Go`. + +## How To Use It + +TBD + +## Features + +| | Code Flow | Implicit Flow | Hybrid Flow | Discovery | PKCE | Token Exchange | mTLS | +|----------------|-----------|---------------|-------------|-----------|------|----------------|---------| +| Relaying Party | yes | yes | not yet | yes | yes | partial | not yet | +| Origin Party | yes | yes | not yet | yes | yes | not yet | not yet | + +### Resources + +For your convinience you can find the relevant standards linked below. + +[OpenID Connect Core 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-core-1_0.html) +[Proof Key for Code Exchange by OAuth Public Clients](https://tools.ietf.org/html/rfc7636) +[OAuth 2.0 Token Exchange](https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-19) +[OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://tools.ietf.org/html/draft-ietf-oauth-mtls-17) + +## Why another library + +As of 2020 there are not a lot of `OIDC` librarys in `Go` which can handle server and client implementations. CAOS is strongly commited to the general field of IAM (Identity and Access Management) and as such, we need solid frameworks to implement services. + +## License + +The full functionality of this library is and stays open source and free to use for everyone. Visit our [website](https://caos.ch) and get in touch. + +See the exact licensing terms [here](./LICENSE) + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. \ No newline at end of file From 52d89a10e5fd56db180b56355e676a177914d63c Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 5 Feb 2020 15:02:51 +0100 Subject: [PATCH 3/5] docs(readme): go versions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1cdd916..436427a 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,16 @@ For your convinience you can find the relevant standards linked below. [OAuth 2.0 Token Exchange](https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-19) [OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://tools.ietf.org/html/draft-ietf-oauth-mtls-17) +## Supported Go Versions + +| Version | Supported | +|---------|--------------------| +| <1.11 | :x: | +| 1.11 | :white_check_mark: | +| 1.12 | :white_check_mark: | +| 1.13 | :white_check_mark: | +| 1.14 | not yet tested | + ## Why another library As of 2020 there are not a lot of `OIDC` librarys in `Go` which can handle server and client implementations. CAOS is strongly commited to the general field of IAM (Identity and Access Management) and as such, we need solid frameworks to implement services. From 7c4732c5fe9bfd2a08a767b33bcc45d20b606b0e Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 5 Feb 2020 15:05:09 +0100 Subject: [PATCH 4/5] docs(readme): format links --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 436427a..20dcb6b 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,10 @@ TBD For your convinience you can find the relevant standards linked below. -[OpenID Connect Core 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-core-1_0.html) -[Proof Key for Code Exchange by OAuth Public Clients](https://tools.ietf.org/html/rfc7636) -[OAuth 2.0 Token Exchange](https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-19) -[OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://tools.ietf.org/html/draft-ietf-oauth-mtls-17) +- [OpenID Connect Core 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-core-1_0.html) +- [Proof Key for Code Exchange by OAuth Public Clients](https://tools.ietf.org/html/rfc7636) +- [OAuth 2.0 Token Exchange](https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-19) +- [OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens](https://tools.ietf.org/html/draft-ietf-oauth-mtls-17) ## Supported Go Versions From aea8bad09af8db905cf5112b0f20d85c92fcb52f Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 5 Feb 2020 15:08:03 +0100 Subject: [PATCH 5/5] build: github release setting --- .releaserc.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.releaserc.js b/.releaserc.js index cf2f499..93a0158 100644 --- a/.releaserc.js +++ b/.releaserc.js @@ -1,7 +1,11 @@ module.exports = { branch: 'master', - plugins: [ + plugins: [ "@semantic-release/commit-analyzer", - "@semantic-release/release-notes-generator" + "@semantic-release/release-notes-generator", + "@semantic-release/github", + ["@semantic-release/exec", { + "prepareCmd": "echo '::set-env name=CAOS_NEXT_VERSION::v${nextRelease.version}'" + }], ] }; \ No newline at end of file