This project is a easy to use client (RP) and server (OP) implementation for the OIDC
(Open ID Connect) standard written for Go
.
The RP is certified for the basic and config profile.
Whenever possible we tried to reuse / extend existing packages like OAuth2 for Go
.
Check the /example
folder where example code for different scenarios is located.
# start oidc op server
# oidc discovery https://localhost:9998/.well-known/openid-configuration
CAOS_OIDC_DEV=1 go run github.com/caos/oidc/example/server/default
# start oidc web client
CLIENT_ID=web CLIENT_SECRET=web ISSUER=https://localhost:9998/ SCOPES=openid PORT=5556 go run github.com/caos/oidc/example/client/app
- browser https://localhost:5556/login will redirect to op server
- input id to login
- redirect to client app display user info
Code Flow | Implicit Flow | Hybrid Flow | Discovery | PKCE | Token Exchange | mTLS | JWT Profile | Refresh Token | |
---|---|---|---|---|---|---|---|---|---|
Relying Party | yes | no1 | no | yes | yes | partial | not yet | yes | yes |
OpenID Provider | yes | yes | not yet | yes | yes | not yet | not yet | yes | yes |
For your convenience you can find the relevant standards linked below.
- OpenID Connect Core 1.0 incorporating errata set 1
- Proof Key for Code Exchange by OAuth Public Clients
- OAuth 2.0 Token Exchange
- OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens
- JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants
For security reasons, we only support and recommend the use of one of the latest two Go versions (:white_check_mark:).
Versions that also build are marked with
Version | Supported |
---|---|
<1.15 | ❌ |
1.15 | |
1.16 | |
1.17 | ✅ |
1.18 | ✅ |
As of 2020 there are not a lot of OIDC
library's in Go
which can handle server and client implementations. CAOS is strongly committed to the general field of IAM (Identity and Access Management) and as such, we need solid frameworks to implement services.
https://github.com/coreos/go-oidc
The go-oidc
does only support RP
and is not feasible to use as OP
that's why we could not rely on go-oidc
https://github.com/ory/fosite
We did not choose fosite
because it implements OAuth 2.0
on its own and does not rely on the golang provided package. Nonetheless this is a great project.
The full functionality of this library is and stays open source and free to use for everyone. Visit our website and get in touch.
See the exact licensing terms here
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.