oidc

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2022 License: Apache-2.0 Imports: 0 Imported by: 0

README

OpenID Connect SDK (client and server) for Go

semantic-release Release license release Go Report Card codecov

openid_certified

What Is It

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.

How To Use It

Check the /example folder where example code for different scenarios is located.

# start oidc op server
# oidc discovery http://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=http://localhost:9998/ SCOPES=openid PORT=5556 go run github.com/caos/oidc/example/client/app

Features

Code Flow Implicit Flow Hybrid Flow Discovery PKCE Token Exchange mTLS JWT Profile Refresh Token
Relying Party yes no^1 no yes yes partial not yet yes yes
OpenID Provider yes yes not yet yes yes not yet not yet yes yes
Resources

For your convenience you can find the relevant standards linked below.

Supported Go Versions

Version Supported
<1.13
1.14
1.15
1.16
1.17

Why another library

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.

Goals
Other Go OpenID Connect libraries

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.

License

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
client/rp/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
op
op/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL