diff --git a/.forgejo.bak/ISSUE_TEMPLATE/bug_report.yaml b/.forgejo.bak/ISSUE_TEMPLATE/bug_report.yaml
deleted file mode 100644
index d024341..0000000
--- a/.forgejo.bak/ISSUE_TEMPLATE/bug_report.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-name: Bug Report
-description: "Create a bug report to help us improve ZITADEL. Click [here](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#product-management) to see how we process your issue."
-title: "[Bug]: "
-labels: ["bug"]
-type: Bug
-body:
- - type: markdown
- attributes:
- value: |
- Thanks for taking the time to fill out this bug report!
- - type: checkboxes
- id: preflight
- attributes:
- label: Preflight Checklist
- options:
- - label:
- I could not find a solution in the documentation, the existing issues or discussions
- required: true
- - label:
- I have joined the [ZITADEL chat](https://zitadel.com/chat)
- - type: input
- id: version
- attributes:
- label: Version
- description: Which version of the OIDC library are you using.
- - type: textarea
- id: impact
- attributes:
- label: Describe the problem caused by this bug
- description: A clear and concise description of the problem you have and what the bug is.
- validations:
- required: true
- - type: textarea
- id: reproduce
- attributes:
- label: To reproduce
- description: Steps to reproduce the behaviour
- placeholder: |
- Steps to reproduce the behavior:
- validations:
- required: true
- - type: textarea
- id: screenshots
- attributes:
- label: Screenshots
- description: If applicable, add screenshots to help explain your problem.
- - type: textarea
- id: expected
- attributes:
- label: Expected behavior
- description: A clear and concise description of what you expected to happen.
- placeholder: As a [type of user], I want [some goal] so that [some reason].
- - type: textarea
- id: additional
- attributes:
- label: Additional Context
- description: Please add any other infos that could be useful.
diff --git a/.forgejo.bak/ISSUE_TEMPLATE/docs.yaml b/.forgejo.bak/ISSUE_TEMPLATE/docs.yaml
deleted file mode 100644
index d3f82b9..0000000
--- a/.forgejo.bak/ISSUE_TEMPLATE/docs.yaml
+++ /dev/null
@@ -1,31 +0,0 @@
-name: đ Documentation
-description: Create an issue for missing or wrong documentation.
-labels: ["docs"]
-type: task
-body:
- - type: markdown
- attributes:
- value: |
- Thanks for taking the time to fill out this issue.
- - type: checkboxes
- id: preflight
- attributes:
- label: Preflight Checklist
- options:
- - label:
- I could not find a solution in the existing issues, docs, nor discussions
- required: true
- - label:
- I have joined the [ZITADEL chat](https://zitadel.com/chat)
- - type: textarea
- id: docs
- attributes:
- label: Describe the docs your are missing or that are wrong
- placeholder: As a [type of user], I want [some goal] so that [some reason].
- validations:
- required: true
- - type: textarea
- id: additional
- attributes:
- label: Additional Context
- description: Please add any other infos that could be useful.
diff --git a/.forgejo.bak/ISSUE_TEMPLATE/enhancement.yaml b/.forgejo.bak/ISSUE_TEMPLATE/enhancement.yaml
deleted file mode 100644
index ef2103e..0000000
--- a/.forgejo.bak/ISSUE_TEMPLATE/enhancement.yaml
+++ /dev/null
@@ -1,55 +0,0 @@
-name: đ ī¸ Improvement
-description: "Create an new issue for an improvment in ZITADEL"
-labels: ["enhancement"]
-type: enhancement
-body:
- - type: markdown
- attributes:
- value: |
- Thanks for taking the time to fill out this proposal / feature reqeust
- - type: checkboxes
- id: preflight
- attributes:
- label: Preflight Checklist
- options:
- - label:
- I could not find a solution in the existing issues, docs, nor discussions
- required: true
- - label:
- I have joined the [ZITADEL chat](https://zitadel.com/chat)
- - type: textarea
- id: problem
- attributes:
- label: Describe your problem
- description: Please describe your problem this improvement is supposed to solve.
- placeholder: Describe the problem you have
- validations:
- required: true
- - type: textarea
- id: solution
- attributes:
- label: Describe your ideal solution
- description: Which solution do you propose?
- placeholder: As a [type of user], I want [some goal] so that [some reason].
- validations:
- required: true
- - type: input
- id: version
- attributes:
- label: Version
- description: Which version of the OIDC Library are you using.
- - type: dropdown
- id: environment
- attributes:
- label: Environment
- description: How do you use ZITADEL?
- options:
- - ZITADEL Cloud
- - Self-hosted
- validations:
- required: true
- - type: textarea
- id: additional
- attributes:
- label: Additional Context
- description: Please add any other infos that could be useful.
diff --git a/.forgejo.bak/pull_request_template.md b/.forgejo.bak/pull_request_template.md
deleted file mode 100644
index 6c4ae58..0000000
--- a/.forgejo.bak/pull_request_template.md
+++ /dev/null
@@ -1,16 +0,0 @@
-### Definition of Ready
-
-- [ ] I am happy with the code
-- [ ] Short description of the feature/issue is added in the pr description
-- [ ] PR is linked to the corresponding user story
-- [ ] Acceptance criteria are met
-- [ ] All open todos and follow ups are defined in a new ticket and justified
-- [ ] Deviations from the acceptance criteria and design are agreed with the PO and documented.
-- [ ] No debug or dead code
-- [ ] My code has no repetitions
-- [ ] Critical parts are tested automatically
-- [ ] Where possible E2E tests are implemented
-- [ ] Documentation/examples are up-to-date
-- [ ] All non-functional requirements are met
-- [ ] Functionality of the acceptance criteria is checked manually on the dev system.
-
diff --git a/.forgejo.bak/workflows/issue.yml b/.forgejo.bak/workflows/issue.yml
deleted file mode 100644
index 480c339..0000000
--- a/.forgejo.bak/workflows/issue.yml
+++ /dev/null
@@ -1,43 +0,0 @@
-name: Add new issues to product management project
-
-on:
- issues:
- types:
- - opened
- pull_request_target:
- types:
- - opened
-
-jobs:
- add-to-project:
- name: Add issue and community pr to project
- runs-on: ubuntu-latest
- steps:
- - name: add issue
- uses: actions/add-to-project@v1.0.2
- if: ${{ github.event_name == 'issues' }}
- with:
- # You can target a repository in a different organization
- # to the issue
- project-url: https://github.com/orgs/zitadel/projects/2
- github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
- - uses: tspascoal/get-user-teams-membership@v3
- id: checkUserMember
- if: github.actor != 'dependabot[bot]'
- with:
- username: ${{ github.actor }}
- GITHUB_TOKEN: ${{ secrets.ADD_TO_PROJECT_PAT }}
- - name: add pr
- uses: actions/add-to-project@v1.0.2
- if: ${{ github.event_name == 'pull_request_target' && github.actor != 'dependabot[bot]' && !contains(steps.checkUserMember.outputs.teams, 'engineers')}}
- with:
- # You can target a repository in a different organization
- # to the issue
- project-url: https://github.com/orgs/zitadel/projects/2
- github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
- - uses: actions-ecosystem/action-add-labels@v1.1.3
- if: ${{ github.event_name == 'pull_request_target' && github.actor != 'dependabot[bot]' && !contains(steps.checkUserMember.outputs.teams, 'staff')}}
- with:
- github_token: ${{ secrets.ADD_TO_PROJECT_PAT }}
- labels: |
- os-contribution
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..49ccc49
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: đ Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
\ No newline at end of file
diff --git a/.forgejo.bak/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
similarity index 100%
rename from .forgejo.bak/ISSUE_TEMPLATE/config.yml
rename to .github/ISSUE_TEMPLATE/config.yml
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..118d30e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: đ Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.forgejo.bak/dependabot.yml b/.github/dependabot.yml
similarity index 58%
rename from .forgejo.bak/dependabot.yml
rename to .github/dependabot.yml
index 1efdcf8..79ff704 100644
--- a/.forgejo.bak/dependabot.yml
+++ b/.github/dependabot.yml
@@ -9,16 +9,6 @@ updates:
commit-message:
prefix: chore
include: scope
-- package-ecosystem: gomod
- target-branch: "2.12.x"
- directory: "/"
- schedule:
- interval: daily
- time: '04:00'
- open-pull-requests-limit: 10
- commit-message:
- prefix: chore
- include: scope
- package-ecosystem: "github-actions"
directory: "/"
schedule:
diff --git a/.forgejo.bak/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
similarity index 86%
rename from .forgejo.bak/workflows/codeql-analysis.yml
rename to .github/workflows/codeql-analysis.yml
index 27fa244..85ea2ca 100644
--- a/.forgejo.bak/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -2,10 +2,10 @@ name: "Code scanning - action"
on:
push:
- branches: [main,next]
+ branches: [main, ]
pull_request:
# The branches below must be a subset of the branches above
- branches: [main,next]
+ branches: [main]
schedule:
- cron: '0 11 * * 0'
@@ -16,7 +16,7 @@ jobs:
steps:
- name: Checkout repository
- uses: actions/checkout@v4
+ uses: actions/checkout@v3
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
@@ -29,7 +29,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
- uses: github/codeql-action/init@v3
+ uses: github/codeql-action/init@v2
# Override language selection by uncommenting this and choosing your languages
with:
languages: go
@@ -37,7 +37,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
- uses: github/codeql-action/autobuild@v3
+ uses: github/codeql-action/autobuild@v2
# âšī¸ Command-line programs to run using the OS shell.
# đ https://git.io/JvXDl
@@ -51,4 +51,4 @@ jobs:
# make release
- name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@v3
+ uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/issue.yml b/.github/workflows/issue.yml
new file mode 100644
index 0000000..8671820
--- /dev/null
+++ b/.github/workflows/issue.yml
@@ -0,0 +1,18 @@
+name: Add new issues to product management project
+
+on:
+ issues:
+ types:
+ - opened
+
+jobs:
+ add-to-project:
+ name: Add issue to project
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/add-to-project@v0.4.1
+ with:
+ # You can target a repository in a different organization
+ # to the issue
+ project-url: https://github.com/orgs/zitadel/projects/2
+ github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
diff --git a/.forgejo.bak/workflows/release.yml b/.github/workflows/release.yml
similarity index 66%
rename from .forgejo.bak/workflows/release.yml
rename to .github/workflows/release.yml
index 00063e4..92cb43d 100644
--- a/.forgejo.bak/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -2,9 +2,8 @@ name: Release
on:
push:
branches:
- - "2.11.x"
- main
- - next
+ - 1.13.x
tags-ignore:
- '**'
pull_request:
@@ -14,34 +13,33 @@ on:
jobs:
test:
- runs-on: ubuntu-24.04
+ runs-on: ubuntu-20.04
strategy:
- fail-fast: false
matrix:
- go: ['1.23', '1.24']
+ go: ['1.18', '1.19', '1.20']
name: Go ${{ matrix.go }} test
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v3
- name: Setup go
- uses: actions/setup-go@v5
+ uses: actions/setup-go@v3
with:
go-version: ${{ matrix.go }}
- - run: go test -race -v -coverprofile=profile.cov -coverpkg=./pkg/... ./pkg/...
- - uses: codecov/codecov-action@v5.4.3
+ - run: go test -race -v -coverprofile=profile.cov -coverpkg=github.com/zitadel/oidc/... ./pkg/...
+ - uses: codecov/codecov-action@v3.1.1
with:
file: ./profile.cov
name: codecov-go
release:
- runs-on: ubuntu-24.04
+ runs-on: ubuntu-20.04
needs: [test]
- if: ${{ github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main' || github.ref == 'refs/heads/next' }}
+ if: ${{ github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/1.13.x' }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Source checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v3
- name: Semantic Release
- uses: cycjimmy/semantic-release-action@v4
+ uses: cycjimmy/semantic-release-action@v3
with:
dry_run: false
semantic_version: 18.0.1
diff --git a/.releaserc.js b/.releaserc.js
index c87b1d1..6a5f098 100644
--- a/.releaserc.js
+++ b/.releaserc.js
@@ -1,9 +1,5 @@
module.exports = {
- branches: [
- {name: "2.11.x"},
- {name: "main"},
- {name: "next", prerelease: true},
- ],
+ branches: ["1.13.x", "main"],
plugins: [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
diff --git a/NEXT_RELEASE.md b/NEXT_RELEASE.md
new file mode 100644
index 0000000..91f7f5d
--- /dev/null
+++ b/NEXT_RELEASE.md
@@ -0,0 +1,7 @@
+
+# Backwards-incompatible changes to be made in the next major release
+
+- Add `rp/RelyingParty.GetRevokeEndpoint`
+- Rename `op/OpStorage.GetKeyByIDAndUserID` to `op/OpStorage.GetKeyByIDAndClientID`
+- Add `CanRefreshTokenInfo` (`GetRefreshTokenInfo()`) to `op.Storage`
+
diff --git a/README.md b/README.md
index bc346f5..78f1931 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,13 @@
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/zitadel/oidc/actions)
-[](https://pkg.go.dev/github.com/zitadel/oidc/v3)
+[](https://pkg.go.dev/github.com/zitadel/oidc)
[](https://github.com/zitadel/oidc/blob/master/LICENSE)
[](https://github.com/zitadel/oidc/releases)
-[](https://goreportcard.com/report/github.com/zitadel/oidc/v3)
+[](https://goreportcard.com/report/github.com/zitadel/oidc)
[](https://codecov.io/gh/zitadel/oidc)
-[](https://openid.net/certification/)
+
## What Is It
@@ -21,10 +21,9 @@ Whenever possible we tried to reuse / extend existing packages like `OAuth2 for
## Basic Overview
The most important packages of the library:
-
/pkg
- /client clients using the OP for retrieving, exchanging and verifying tokens
+ /client clients using the OP for retrieving, exchanging and verifying tokens
/rp definition and implementation of an OIDC Relying Party (client)
/rs definition and implementation of an OAuth Resource Server (API)
/op definition and implementation of an OIDC OpenID Provider (server)
@@ -35,13 +34,9 @@ The most important packages of the library:
/client/app web app / RP demonstrating authorization code flow using various authentication methods (code, PKCE, JWT profile)
/client/github example of the extended OAuth2 library, providing an HTTP client with a reuse token source
/client/service demonstration of JWT Profile Authorization Grant
- /server examples of an OpenID Provider implementations (including dynamic) with some very basic login UI
+ /server example of an OpenID Provider implementation including some very basic login UI
-### Semver
-
-This package uses [semver](https://semver.org/) for [releases](https://github.com/zitadel/oidc/releases). Major releases ship breaking changes. Starting with the `v2` to `v3` increment we provide an [upgrade guide](UPGRADING.md) to ease migration to a newer version.
-
## How To Use It
Check the `/example` folder where example code for different scenarios is located.
@@ -49,90 +44,22 @@ Check the `/example` folder where example code for different scenarios is locate
```bash
# start oidc op server
# oidc discovery http://localhost:9998/.well-known/openid-configuration
-go run github.com/zitadel/oidc/v3/example/server
+go run github.com/zitadel/oidc/example/server
# start oidc web client (in a new terminal)
-CLIENT_ID=web CLIENT_SECRET=secret ISSUER=http://localhost:9998/ SCOPES="openid profile" PORT=9999 go run github.com/zitadel/oidc/v3/example/client/app
+CLIENT_ID=web CLIENT_SECRET=secret ISSUER=http://localhost:9998 SCOPES="openid profile" PORT=9999 go run github.com/zitadel/oidc/example/client/app
```
- open http://localhost:9999/login in your browser
-- you will be redirected to op server and the login UI
-- login with user `test-user@localhost` and password `verysecure`
+- you will be redirected to op server and the login UI
+- login with user `test-user` and password `verysecure`
- the OP will redirect you to the client app, which displays the user info
-for the dynamic issuer, just start it with:
-
-```bash
-go run github.com/zitadel/oidc/v3/example/server/dynamic
-```
-
-the oidc web client above will still work, but if you add `oidc.local` (pointing to 127.0.0.1) in your hosts file you can also start it with:
-
-```bash
-CLIENT_ID=web CLIENT_SECRET=secret ISSUER=http://oidc.local:9998/ SCOPES="openid profile" PORT=9999 go run github.com/zitadel/oidc/v3/example/client/app
-```
-
-> Note: Usernames are suffixed with the hostname (`test-user@localhost` or `test-user@oidc.local`)
-
-### Server configuration
-
-Example server allows extra configuration using environment variables and could be used for end to
-end testing of your services.
-
-| Name | Format | Description |
-| ------------ | -------------------------------- | ------------------------------------- |
-| PORT | Number between 1 and 65535 | OIDC listen port |
-| REDIRECT_URI | Comma-separated URIs | List of allowed redirect URIs |
-| USERS_FILE | Path to json in local filesystem | Users with their data and credentials |
-
-Here is json equivalent for one of the default users
-
-```json
-{
- "id2": {
- "ID": "id2",
- "Username": "test-user2",
- "Password": "verysecure",
- "FirstName": "Test",
- "LastName": "User2",
- "Email": "test-user2@zitadel.ch",
- "EmailVerified": true,
- "Phone": "",
- "PhoneVerified": false,
- "PreferredLanguage": "DE",
- "IsAdmin": false
- }
-}
-```
-
## Features
-| | Relying party | OpenID Provider | Specification |
-| -------------------- | ------------- | --------------- | -------------------------------------------- |
-| Code Flow | yes | yes | OpenID Connect Core 1.0, [Section 3.1][1] |
-| Implicit Flow | no[^1] | yes | OpenID Connect Core 1.0, [Section 3.2][2] |
-| Hybrid Flow | no | not yet | OpenID Connect Core 1.0, [Section 3.3][3] |
-| Client Credentials | yes | yes | OpenID Connect Core 1.0, [Section 9][4] |
-| Refresh Token | yes | yes | OpenID Connect Core 1.0, [Section 12][5] |
-| Discovery | yes | yes | OpenID Connect [Discovery][6] 1.0 |
-| JWT Profile | yes | yes | [RFC 7523][7] |
-| PKCE | yes | yes | [RFC 7636][8] |
-| Token Exchange | yes | yes | [RFC 8693][9] |
-| Device Authorization | yes | yes | [RFC 8628][10] |
-| mTLS | not yet | not yet | [RFC 8705][11] |
-| Back-Channel Logout | not yet | yes | OpenID Connect [Back-Channel Logout][12] 1.0 |
-
-[1]: https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth "3.1. Authentication using the Authorization Code Flow"
-[2]: https://openid.net/specs/openid-connect-core-1_0.html#ImplicitFlowAuth "3.2. Authentication using the Implicit Flow"
-[3]: https://openid.net/specs/openid-connect-core-1_0.html#HybridFlowAuth "3.3. Authentication using the Hybrid Flow"
-[4]: https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication "9. Client Authentication"
-[5]: https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens "12. Using Refresh Tokens"
-[6]: https://openid.net/specs/openid-connect-discovery-1_0.html "OpenID Connect Discovery 1.0 incorporating errata set 1"
-[7]: https://www.rfc-editor.org/rfc/rfc7523.html "JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants"
-[8]: https://www.rfc-editor.org/rfc/rfc7636.html "Proof Key for Code Exchange by OAuth Public Clients"
-[9]: https://www.rfc-editor.org/rfc/rfc8693.html "OAuth 2.0 Token Exchange"
-[10]: https://www.rfc-editor.org/rfc/rfc8628.html "OAuth 2.0 Device Authorization Grant"
-[11]: https://www.rfc-editor.org/rfc/rfc8705.html "OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens"
-[12]: https://openid.net/specs/openid-connect-backchannel-1_0.html "OpenID Connect Back-Channel Logout 1.0 incorporating errata set 1"
+| | Code Flow | Implicit Flow | Hybrid Flow | Discovery | PKCE | Token Exchange | mTLS | JWT Profile | Refresh Token | Client Credentials |
+|------------------|-----------|---------------|-------------|-----------|------|----------------|---------|-------------|---------------|--------------------|
+| Relying Party | yes | no[^1] | no | yes | yes | partial | not yet | yes | yes | not yet |
+| OpenID Provider | yes | yes | not yet | yes | yes | not yet | not yet | yes | yes | yes |
## Contributors
@@ -144,21 +71,26 @@ Made with [contrib.rocks](https://contrib.rocks).
### Resources
-For your convenience you can find the relevant guides linked below.
+For your convenience 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)
+- [JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants](https://tools.ietf.org/html/rfc7523)
- [OIDC/OAuth Flow in Zitadel (using this library)](https://zitadel.com/docs/guides/integrate/login-users)
## Supported Go Versions
-For security reasons, we only support and recommend the use of one of the latest two Go versions (:white_check_mark:).
+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 :warning:.
| Version | Supported |
-| ------- | ------------------ |
-| <1.23 | :x: |
-| 1.23 | :white_check_mark: |
-| 1.24 | :white_check_mark: |
+|---------|--------------------|
+| <1.18 | :x: |
+| 1.18 | :warning: |
+| 1.19 | :white_check_mark: |
+| 1.20 | :white_check_mark: |
## Why another library
@@ -189,4 +121,5 @@ Unless required by applicable law or agreed to in writing, software distributed
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.
+
[^1]: https://github.com/zitadel/oidc/issues/135#issuecomment-950563892
diff --git a/SECURITY.md b/SECURITY.md
index a32b842..934426a 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,20 +1,43 @@
# Security Policy
-Please refer to the security policy [on zitadel/zitadel](https://github.com/zitadel/zitadel/blob/main/SECURITY.md) which is applicable for all open source repositories of our organization.
+At ZITADEL 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
-We currently support the following version of the OIDC framework:
+After the initial Release the following version support will apply
-| Version | Supported | Branch | Details |
-| -------- | ------------------ | ----------- | ------------------------------------ |
-| 0.x.x | :x: | | not maintained |
-| <2.11 | :x: | | not maintained |
-| 2.11.x | :lock: :warning: | [2.11.x][1] | security only, [community effort][2] |
-| 3.x.x | :heavy_check_mark: | [main][3] | supported |
-| 4.0.0-xx | :white_check_mark: | [next][4] | [development branch] |
+| Version | Supported |
+| ------- | ------------------ |
+| 0.x.x | :x: |
+| 1.x.x | :white_check_mark: |
+| 2.x.x | :white_check_mark: (not released) |
-[1]: https://github.com/zitadel/oidc/tree/2.11.x
-[2]: https://github.com/zitadel/oidc/discussions/458
-[3]: https://github.com/zitadel/oidc/tree/main
-[4]: https://github.com/zitadel/oidc/tree/next
+## Reporting a vulnerability
+
+To file a incident, please disclose by email to security@zitadel.com with the security details.
+
+At the moment GPG encryption is no yet supported, however you may sign your message at will.
+
+### When should I report a vulnerability
+
+* You think you discovered a ...
+ * ... potential security vulnerability in the SDK
+ * ... vulnerability in another project that this SDK bases on
+* For projects with their own vulnerability reporting and disclosure process, please report it directly there
+
+### When should I NOT report a vulnerability
+
+* You need help applying security related updates
+* Your issue is not security related
+
+## Security Vulnerability Response
+
+TBD
+
+## Public Disclosure
+
+All accepted and mitigated vulnerabilities will be published on the [Github Security Page](https://github.com/zitadel/oidc/security/advisories)
+
+### Timing
+
+We think it is crucial to publish advisories `ASAP` as mitigations are ready. But due to the unknown nature of the disclosures the time frame can range from 7 to 90 days.
diff --git a/UPGRADING.md b/UPGRADING.md
deleted file mode 100644
index 6b5a41d..0000000
--- a/UPGRADING.md
+++ /dev/null
@@ -1,370 +0,0 @@
-# Upgrading
-
-All commands are executed from the root of the project that imports oidc packages.
-`sed` commands are created with **GNU sed** in mind and might need alternate syntax
-on non-GNU systems, such as MacOS.
-Alternatively, GNU sed can be installed on such systems. (`coreutils` package?).
-
-## V2 to V3
-
-**TL;DR** at the [bottom](#full-script) of this chapter is a full `sed` script
-containing all automatic steps at once.
-
-
-As first steps we will:
-1. Download the latest v3 module;
-2. Replace imports in all Go files;
-3. Tidy the module file;
-
-```bash
-go get -u github.com/zitadel/oidc/v3
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/github\.com\/zitadel\/oidc\/v2/github.com\/zitadel\/oidc\/v3/g'
-go mod tidy
-```
-
-### global
-
-#### go-jose package
-
-`gopkg.in/square/go-jose.v2` import has been changed to `github.com/go-jose/go-jose/v3`.
-That means that the imported types are also changed and imports need to be adapted.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/gopkg.in\/square\/go-jose\.v2/github.com\/go-jose\/go-jose\/v3/g'
-go mod tidy
-```
-
-### op
-
-```go
-import "github.com/zitadel/oidc/v3/pkg/op"
-```
-
-#### Logger
-
-This version of OIDC adds logging to the framework. For this we use the new Go standard library `log/slog`. (Until v3.12.0 we used `x/exp/slog`).
-Mostly OIDC will use error level logs where it's returning an error through a HTTP handler. OIDC errors that are user facing don't carry much context, also for security reasons. With logging we are now able to print the error context, so that developers can more easily find the source of their issues. Previously we just discarded such context.
-
-Most users of the OP package with the storage interface will not experience breaking changes. However if you use `RequestError()` directly in your code, you now need to give it a `Logger` as final argument.
-
-The `OpenIDProvider` and sub-interfaces like `Authorizer` and `Exchanger` got a `Logger()` method to return the configured logger. This logger is in turn used by `AuthRequestError()`. You configure the logger with the `WithLogger()` for the `Provider`. By default the `slog.Default()` is used.
-
-We also provide a new optional interface: [`LogAuthRequest`](https://pkg.go.dev/github.com/zitadel/oidc/v3/pkg/op#LogAuthRequest). If an `AuthRequest` implements this interface, it is completely passed into the logger after an error. Its `LogValue()` will be used by `slog` to print desired fields. This allows omitting sensitive fields you wish not no print. If the interface is not implemented, no `AuthRequest` details will ever be printed.
-
-#### Server interface
-
-We've added a new [`Server`](https://pkg.go.dev/github.com/zitadel/oidc/v3/pkg/op#Server) interface. This interface is experimental and subject to change. See [issue 440](https://github.com/zitadel/oidc/issues/440) for the motivation and discussion around this new interface.
-Usage of the new interface is not required, but may be used for advanced scenarios when working with the `Storage` interface isn't the optimal solution for your app (like we experienced in [Zitadel](https://github.com/zitadel/zitadel)).
-
-#### AuthRequestError
-
-`AuthRequestError` now takes the complete `Authorizer` as final argument, instead of only the encoder.
-This is to facilitate the use of the `Logger` as described above.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/\bAuthRequestError(w, r, authReq, err, authorizer.Encoder())/AuthRequestError(w, r, authReq, err, authorizer)/g'
-```
-
-Note: the sed regex might not find all uses if the local variables of the passed arguments use different names.
-
-#### AccessTokenVerifier
-
-`AccessTokenVerifier` interface has become a struct type. `NewAccessTokenVerifier` now returns a pointer to `AccessTokenVerifier`.
-Variable and struct fields declarations need to be changed from `op.AccessTokenVerifier` to `*op.AccessTokenVerifier`.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/\bop\.AccessTokenVerifier\b/*op.AccessTokenVerifier/g'
-```
-
-#### JWTProfileVerifier
-
-`JWTProfileVerifier` interface has become a struct type. `NewJWTProfileVerifier` now returns a pointer to `JWTProfileVerifier`.
-Variable and struct fields declarations need to be changed from `op.JWTProfileVerifier` to `*op.JWTProfileVerifier`.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/\bop\.JWTProfileVerifier\b/*op.JWTProfileVerifier/g'
-```
-
-#### IDTokenHintVerifier
-
-`IDTokenHintVerifier` interface has become a struct type. `NewIDTokenHintVerifier` now returns a pointer to `IDTokenHintVerifier`.
-Variable and struct fields declarations need to be changed from `op.IDTokenHintVerifier` to `*op.IDTokenHintVerifier`.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/\bop\.IDTokenHintVerifier\b/*op.IDTokenHintVerifier/g'
-```
-
-#### ParseRequestObject
-
-`ParseRequestObject` no longer returns `*oidc.AuthRequest` as it already operates on the pointer for the passed `authReq` argument. As such the argument and the return value were the same pointer. Callers can just use the original `*oidc.AuthRequest` now.
-
-#### Endpoint Configuration
-
-`Endpoint`s returned from `Configuration` interface methods are now pointers. Usually, `op.Provider` is the main implementation of the `Configuration` interface. However, if a custom implementation is used, you should be able to update it using the following:
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/AuthorizationEndpoint() Endpoint/AuthorizationEndpoint() *Endpoint/g' \
- -e 's/TokenEndpoint() Endpoint/TokenEndpoint() *Endpoint/g' \
- -e 's/IntrospectionEndpoint() Endpoint/IntrospectionEndpoint() *Endpoint/g' \
- -e 's/UserinfoEndpoint() Endpoint/UserinfoEndpoint() *Endpoint/g' \
- -e 's/RevocationEndpoint() Endpoint/RevocationEndpoint() *Endpoint/g' \
- -e 's/EndSessionEndpoint() Endpoint/EndSessionEndpoint() *Endpoint/g' \
- -e 's/KeysEndpoint() Endpoint/KeysEndpoint() *Endpoint/g' \
- -e 's/DeviceAuthorizationEndpoint() Endpoint/DeviceAuthorizationEndpoint() *Endpoint/g'
-```
-
-#### CreateDiscoveryConfig
-
-`CreateDiscoveryConfig` now takes a context as first argument. The following adds `context.TODO()` to the function:
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/op\.CreateDiscoveryConfig(/op.CreateDiscoveryConfig(context.TODO(), /g'
-```
-
-It now takes the issuer out of the context using the [`IssuerFromContext`](https://pkg.go.dev/github.com/zitadel/oidc/v3/pkg/op#IssuerFromContext) functionality,
-instead of the `config.IssuerFromRequest()` method.
-
-#### CreateRouter
-
-`CreateRouter` now returns a `chi.Router` instead of `*mux.Router`.
-Usually this function is called when the Provider is constructed and not by package consumers.
-However if your project does call this function directly, manual update of the code is required.
-
-#### DeviceAuthorizationStorage
-
-`DeviceAuthorizationStorage` dropped the following methods:
-
-- `GetDeviceAuthorizationByUserCode`
-- `CompleteDeviceAuthorization`
-- `DenyDeviceAuthorization`
-
-These methods proved not to be required from a library point of view.
-Implementations of a device authorization flow may take care of these calls in a way they see fit.
-
-#### AuthorizeCodeChallenge
-
-The `AuthorizeCodeChallenge` function now only takes the `CodeVerifier` argument, instead of the complete `*oidc.AccessTokenRequest`.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/op\.AuthorizeCodeChallenge(tokenReq/op.AuthorizeCodeChallenge(tokenReq.CodeVerifier/g'
-```
-
-### client
-
-```go
-import "github.com/zitadel/oidc/v3/pkg/client"
-```
-
-#### Context
-
-All client calls now take a context as first argument. The following adds `context.TODO()` to all the affected functions:
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/client\.Discover(/client.Discover(context.TODO(), /g' \
- -e 's/client\.CallTokenEndpoint(/client.CallTokenEndpoint(context.TODO(), /g' \
- -e 's/client\.CallEndSessionEndpoint(/client.CallEndSessionEndpoint(context.TODO(), /g' \
- -e 's/client\.CallRevokeEndpoint(/client.CallRevokeEndpoint(context.TODO(), /g' \
- -e 's/client\.CallTokenExchangeEndpoint(/client.CallTokenExchangeEndpoint(context.TODO(), /g' \
- -e 's/client\.CallDeviceAuthorizationEndpoint(/client.CallDeviceAuthorizationEndpoint(context.TODO(), /g' \
- -e 's/client\.JWTProfileExchange(/client.JWTProfileExchange(context.TODO(), /g'
-```
-
-#### keyFile type
-
-The `keyFile` struct type is now exported a `KeyFile` and returned by the `ConfigFromKeyFile` and `ConfigFromKeyFileData`. No changes are needed on the caller's side.
-
-### client/profile
-
-The package now defines a new interface `TokenSource` which compliments the `oauth2.TokenSource` with a `TokenCtx` method, so that a context can be explicitly added on each call. Users can migrate to the new method when they whish.
-
-`NewJWTProfileTokenSource` now takes a context as first argument, so do the related `NewJWTProfileTokenSourceFromKeyFile` and `NewJWTProfileTokenSourceFromKeyFileData`. The context is used for the Discovery request.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/profile\.NewJWTProfileTokenSource(/profile.NewJWTProfileTokenSource(context.TODO(), /g' \
- -e 's/profile\.NewJWTProfileTokenSourceFromKeyFileData(/profile.NewJWTProfileTokenSourceFromKeyFileData(context.TODO(), /g' \
- -e 's/profile\.NewJWTProfileTokenSourceFromKeyFile(/profile.NewJWTProfileTokenSourceFromKeyFile(context.TODO(), /g'
-```
-
-
-### client/rp
-
-```go
-import "github.com/zitadel/oidc/v3/pkg/client/rs"
-```
-
-#### Discover
-
-The `Discover` function has been removed. Use `client.Discover` instead.
-
-#### Context
-
-Most `rp` functions now require a context as first argument. The following adds `context.TODO()` to the function that have no additional changes. Functions with more complex changes are documented below.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/rp\.NewRelyingPartyOIDC(/rp.NewRelyingPartyOIDC(context.TODO(), /g' \
- -e 's/rp\.EndSession(/rp.EndSession(context.TODO(), /g' \
- -e 's/rp\.RevokeToken(/rp.RevokeToken(context.TODO(), /g' \
- -e 's/rp\.DeviceAuthorization(/rp.DeviceAuthorization(context.TODO(), /g'
-```
-
-Remember to replace `context.TODO()` with a context that is applicable for your app, where possible.
-
-#### RefreshAccessToken
-
-1. Renamed to `RefreshTokens`;
-2. A context must be passed;
-3. An `*oidc.Tokens` object is now returned, which included an ID Token if it was returned by the server;
-4. The function is now generic and requires a type argument for the `IDTokenClaims` implementation inside the returned `oidc.Tokens` object;
-
-For most use cases `*oidc.IDTokenClaims` can be used as type argument. A custom implementation of `oidc.IDClaims` can be used if type-safe access to custom claims is required.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/rp\.RefreshAccessToken(/rp.RefreshTokens[*oidc.IDTokenClaims](context.TODO(), /g'
-```
-
-Users that called `tokens.Extra("id_token").(string)` and a subsequent `VerifyTokens` to get the claims, no longer need to do this. The ID token is verified (when present) by `RefreshTokens` already.
-
-
-#### Userinfo
-
-1. A context must be passed as first argument;
-2. The function is now generic and requires a type argument for the returned user info object;
-
-For most use cases `*oidc.UserInfo` can be used a type argument. A [custom implementation](https://pkg.go.dev/github.com/zitadel/oidc/v3/pkg/client/rp#example-Userinfo-Custom) of `rp.SubjectGetter` can be used if type-safe access to custom claims is required.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/rp\.Userinfo(/rp.Userinfo[*oidc.UserInfo](context.TODO(), /g'
-```
-
-#### UserinfoCallback
-
-`UserinfoCallback` has an additional type argument fot the `UserInfo` object. Typically the type argument can be inferred by the compiler, by the function that is passed. The actual code update cannot be done by a simple `sed` script and depends on how the caller implemented the function.
-
-
-#### IDTokenVerifier
-
-`IDTokenVerifier` interface has become a struct type. `NewIDTokenVerifier` now returns a pointer to `IDTokenVerifier`.
-Variable and struct fields declarations need to be changed from `rp.IDTokenVerifier` to `*rp.AccessTokenVerifier`.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/\brp\.IDTokenVerifier\b/*rp.IDTokenVerifier/g'
-```
-
-### client/rs
-
-```go
-import "github.com/zitadel/oidc/v3/pkg/client/rs"
-```
-
-#### NewResourceServer
-
-The `NewResourceServerClientCredentials` and `NewResourceServerJWTProfile` constructor functions now take a context as first argument.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/rs\.NewResourceServerClientCredentials(/rs.NewResourceServerClientCredentials(context.TODO(), /g' \
- -e 's/rs\.NewResourceServerJWTProfile(/rs.NewResourceServerJWTProfile(context.TODO(), /g'
-```
-
-#### Introspect
-
-`Introspect` is now generic and requires a type argument for the returned introspection response. For most use cases `*oidc.IntrospectionResponse` can be used as type argument. Any other response type if type-safe access to [custom claims](https://pkg.go.dev/github.com/zitadel/oidc/v3/pkg/client/rs#example-Introspect-Custom) is required.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/rs\.Introspect(/rs.Introspect[*oidc.IntrospectionResponse](/g'
-```
-
-### client/tokenexchange
-
-The `TokenExchanger` constructor functions `NewTokenExchanger` and `NewTokenExchangerClientCredentials` now take a context as first argument.
-As well as the `ExchangeToken` function.
-
-```bash
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/tokenexchange\.NewTokenExchanger(/tokenexchange.NewTokenExchanger(context.TODO(), /g' \
- -e 's/tokenexchange\.NewTokenExchangerClientCredentials(/tokenexchange.NewTokenExchangerClientCredentials(context.TODO(), /g' \
- -e 's/tokenexchange\.ExchangeToken(/tokenexchange.ExchangeToken(context.TODO(), /g'
-```
-
-### oidc
-
-#### SpaceDelimitedArray
-
-The `SpaceDelimitedArray` type's `Encode()` function has been renamed to `String()` so it implements the `fmt.Stringer` interface. If the `Encode` method was called by a package consumer, it should be changed manually.
-
-#### Verifier
-
-The `Verifier` interface as been changed into a struct type. The struct type is aliased in the `op` and `rp` packages for the specific token use cases. See the relevant section above.
-
-### Full script
-
-For the courageous this is the full `sed` script which combines all the steps described above.
-It should migrate most of the code in a repository to a more-or-less compilable state,
-using defaults such as `context.TODO()` where possible.
-
-Warnings:
-- Again, this is written for **GNU sed** not the posix variant.
-- Assumes imports that use the package names, not aliases.
-- Do this on a project with version control (eg Git), that allows you to rollback if things went wrong.
-- The script has been tested on the [ZITADEL](https://github.com/zitadel/zitadel) project, but we do not use all affected symbols. Parts of the script are mere guesswork.
-
-```bash
-go get -u github.com/zitadel/oidc/v3
-find . -type f -name '*.go' | xargs sed -i \
- -e 's/github\.com\/zitadel\/oidc\/v2/github.com\/zitadel\/oidc\/v3/g' \
- -e 's/gopkg.in\/square\/go-jose\.v2/github.com\/go-jose\/go-jose\/v3/g' \
- -e 's/\bAuthRequestError(w, r, authReq, err, authorizer.Encoder())/AuthRequestError(w, r, authReq, err, authorizer)/g' \
- -e 's/\bop\.AccessTokenVerifier\b/*op.AccessTokenVerifier/g' \
- -e 's/\bop\.JWTProfileVerifier\b/*op.JWTProfileVerifier/g' \
- -e 's/\bop\.IDTokenHintVerifier\b/*op.IDTokenHintVerifier/g' \
- -e 's/AuthorizationEndpoint() Endpoint/AuthorizationEndpoint() *Endpoint/g' \
- -e 's/TokenEndpoint() Endpoint/TokenEndpoint() *Endpoint/g' \
- -e 's/IntrospectionEndpoint() Endpoint/IntrospectionEndpoint() *Endpoint/g' \
- -e 's/UserinfoEndpoint() Endpoint/UserinfoEndpoint() *Endpoint/g' \
- -e 's/RevocationEndpoint() Endpoint/RevocationEndpoint() *Endpoint/g' \
- -e 's/EndSessionEndpoint() Endpoint/EndSessionEndpoint() *Endpoint/g' \
- -e 's/KeysEndpoint() Endpoint/KeysEndpoint() *Endpoint/g' \
- -e 's/DeviceAuthorizationEndpoint() Endpoint/DeviceAuthorizationEndpoint() *Endpoint/g' \
- -e 's/op\.CreateDiscoveryConfig(/op.CreateDiscoveryConfig(context.TODO(), /g' \
- -e 's/op\.AuthorizeCodeChallenge(tokenReq/op.AuthorizeCodeChallenge(tokenReq.CodeVerifier/g' \
- -e 's/client\.Discover(/client.Discover(context.TODO(), /g' \
- -e 's/client\.CallTokenEndpoint(/client.CallTokenEndpoint(context.TODO(), /g' \
- -e 's/client\.CallEndSessionEndpoint(/client.CallEndSessionEndpoint(context.TODO(), /g' \
- -e 's/client\.CallRevokeEndpoint(/client.CallRevokeEndpoint(context.TODO(), /g' \
- -e 's/client\.CallTokenExchangeEndpoint(/client.CallTokenExchangeEndpoint(context.TODO(), /g' \
- -e 's/client\.CallDeviceAuthorizationEndpoint(/client.CallDeviceAuthorizationEndpoint(context.TODO(), /g' \
- -e 's/client\.JWTProfileExchange(/client.JWTProfileExchange(context.TODO(), /g' \
- -e 's/profile\.NewJWTProfileTokenSource(/profile.NewJWTProfileTokenSource(context.TODO(), /g' \
- -e 's/profile\.NewJWTProfileTokenSourceFromKeyFileData(/profile.NewJWTProfileTokenSourceFromKeyFileData(context.TODO(), /g' \
- -e 's/profile\.NewJWTProfileTokenSourceFromKeyFile(/profile.NewJWTProfileTokenSourceFromKeyFile(context.TODO(), /g' \
- -e 's/rp\.NewRelyingPartyOIDC(/rp.NewRelyingPartyOIDC(context.TODO(), /g' \
- -e 's/rp\.EndSession(/rp.EndSession(context.TODO(), /g' \
- -e 's/rp\.RevokeToken(/rp.RevokeToken(context.TODO(), /g' \
- -e 's/rp\.DeviceAuthorization(/rp.DeviceAuthorization(context.TODO(), /g' \
- -e 's/rp\.RefreshAccessToken(/rp.RefreshTokens[*oidc.IDTokenClaims](context.TODO(), /g' \
- -e 's/rp\.Userinfo(/rp.Userinfo[*oidc.UserInfo](context.TODO(), /g' \
- -e 's/\brp\.IDTokenVerifier\b/*rp.IDTokenVerifier/g' \
- -e 's/rs\.NewResourceServerClientCredentials(/rs.NewResourceServerClientCredentials(context.TODO(), /g' \
- -e 's/rs\.NewResourceServerJWTProfile(/rs.NewResourceServerJWTProfile(context.TODO(), /g' \
- -e 's/rs\.Introspect(/rs.Introspect[*oidc.IntrospectionResponse](/g' \
- -e 's/tokenexchange\.NewTokenExchanger(/tokenexchange.NewTokenExchanger(context.TODO(), /g' \
- -e 's/tokenexchange\.NewTokenExchangerClientCredentials(/tokenexchange.NewTokenExchangerClientCredentials(context.TODO(), /g' \
- -e 's/tokenexchange\.ExchangeToken(/tokenexchange.ExchangeToken(context.TODO(), /g'
-go mod tidy
-```
\ No newline at end of file
diff --git a/example/client/api/api.go b/example/client/api/api.go
index 69f9466..0ab669d 100644
--- a/example/client/api/api.go
+++ b/example/client/api/api.go
@@ -1,7 +1,6 @@
package main
import (
- "context"
"encoding/json"
"fmt"
"log"
@@ -10,11 +9,11 @@ import (
"strings"
"time"
- "github.com/go-chi/chi/v5"
+ "github.com/gorilla/mux"
"github.com/sirupsen/logrus"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rs"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/client/rs"
+ "github.com/zitadel/oidc/pkg/oidc"
)
const (
@@ -28,12 +27,12 @@ func main() {
port := os.Getenv("PORT")
issuer := os.Getenv("ISSUER")
- provider, err := rs.NewResourceServerFromKeyFile(context.TODO(), issuer, keyPath)
+ provider, err := rs.NewResourceServerFromKeyFile(issuer, keyPath)
if err != nil {
logrus.Fatalf("error creating provider %s", err.Error())
}
- router := chi.NewRouter()
+ router := mux.NewRouter()
// public url accessible without any authorization
// will print `OK` and current timestamp
@@ -48,7 +47,7 @@ func main() {
if !ok {
return
}
- resp, err := rs.Introspect[*oidc.IntrospectionResponse](r.Context(), provider, token)
+ resp, err := rs.Introspect(r.Context(), provider, token)
if err != nil {
http.Error(w, err.Error(), http.StatusForbidden)
return
@@ -69,15 +68,15 @@ func main() {
if !ok {
return
}
- resp, err := rs.Introspect[*oidc.IntrospectionResponse](r.Context(), provider, token)
+ resp, err := rs.Introspect(r.Context(), provider, token)
if err != nil {
http.Error(w, err.Error(), http.StatusForbidden)
return
}
- requestedClaim := chi.URLParam(r, "claim")
- requestedValue := chi.URLParam(r, "value")
-
- value, ok := resp.Claims[requestedClaim].(string)
+ params := mux.Vars(r)
+ requestedClaim := params["claim"]
+ requestedValue := params["value"]
+ value, ok := resp.GetClaim(requestedClaim).(string)
if !ok || value == "" || value != requestedValue {
http.Error(w, "claim does not match", http.StatusForbidden)
return
diff --git a/example/client/app/app.go b/example/client/app/app.go
index 90b1969..e7be491 100644
--- a/example/client/app/app.go
+++ b/example/client/app/app.go
@@ -1,23 +1,19 @@
package main
import (
- "context"
"encoding/json"
"fmt"
- "log/slog"
"net/http"
"os"
"strings"
- "sync/atomic"
"time"
"github.com/google/uuid"
"github.com/sirupsen/logrus"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/zitadel/logging"
+ "github.com/zitadel/oidc/pkg/client/rp"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
var (
@@ -32,31 +28,13 @@ func main() {
issuer := os.Getenv("ISSUER")
port := os.Getenv("PORT")
scopes := strings.Split(os.Getenv("SCOPES"), " ")
- responseMode := os.Getenv("RESPONSE_MODE")
redirectURI := fmt.Sprintf("http://localhost:%v%v", port, callbackPath)
cookieHandler := httphelper.NewCookieHandler(key, key, httphelper.WithUnsecure())
- logger := slog.New(
- slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
- AddSource: true,
- Level: slog.LevelDebug,
- }),
- )
- client := &http.Client{
- Timeout: time.Minute,
- }
- // enable outgoing request logging
- logging.EnableHTTPClient(client,
- logging.WithClientGroup("client"),
- )
-
options := []rp.Option{
rp.WithCookieHandler(cookieHandler),
rp.WithVerifierOpts(rp.WithIssuedAtOffset(5 * time.Second)),
- rp.WithHTTPClient(client),
- rp.WithLogger(logger),
- rp.WithSigningAlgsFromDiscovery(),
}
if clientSecret == "" {
options = append(options, rp.WithPKCE(cookieHandler))
@@ -65,10 +43,7 @@ func main() {
options = append(options, rp.WithJWTProfile(rp.SignerFromKeyPath(keyPath)))
}
- // One can add a logger to the context,
- // pre-defining log attributes as required.
- ctx := logging.ToContext(context.TODO(), logger)
- provider, err := rp.NewRelyingPartyOIDC(ctx, issuer, clientID, clientSecret, redirectURI, scopes, options...)
+ provider, err := rp.NewRelyingPartyOIDC(issuer, clientID, clientSecret, redirectURI, scopes, options...)
if err != nil {
logrus.Fatalf("error creating provider %s", err.Error())
}
@@ -79,37 +54,20 @@ func main() {
return uuid.New().String()
}
- urlOptions := []rp.URLParamOpt{
- rp.WithPromptURLParam("Welcome back!"),
- }
-
- if responseMode != "" {
- urlOptions = append(urlOptions, rp.WithResponseModeURLParam(oidc.ResponseMode(responseMode)))
- }
-
// register the AuthURLHandler at your preferred path.
// the AuthURLHandler creates the auth request and redirects the user to the auth server.
// including state handling with secure cookie and the possibility to use PKCE.
// Prompts can optionally be set to inform the server of
// any messages that need to be prompted back to the user.
- http.Handle("/login", rp.AuthURLHandler(
- state,
- provider,
- urlOptions...,
- ))
+ http.Handle("/login", rp.AuthURLHandler(state, provider, rp.WithPromptURLParam("Welcome back!")))
// for demonstration purposes the returned userinfo response is written as JSON object onto response
- marshalUserinfo := func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens[*oidc.IDTokenClaims], state string, rp rp.RelyingParty, info *oidc.UserInfo) {
- fmt.Println("access token", tokens.AccessToken)
- fmt.Println("refresh token", tokens.RefreshToken)
- fmt.Println("id token", tokens.IDToken)
-
+ marshalUserinfo := func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, rp rp.RelyingParty, info oidc.UserInfo) {
data, err := json.Marshal(info)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
- w.Header().Set("content-type", "application/json")
w.Write(data)
}
@@ -124,31 +82,6 @@ func main() {
// w.Write(data)
//}
- // you can also try token exchange flow
- //
- // requestTokenExchange := func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, rp rp.RelyingParty, info oidc.UserInfo) {
- // data := make(url.Values)
- // data.Set("grant_type", string(oidc.GrantTypeTokenExchange))
- // data.Set("requested_token_type", string(oidc.IDTokenType))
- // data.Set("subject_token", tokens.RefreshToken)
- // data.Set("subject_token_type", string(oidc.RefreshTokenType))
- // data.Add("scope", "profile custom_scope:impersonate:id2")
-
- // client := &http.Client{}
- // r2, _ := http.NewRequest(http.MethodPost, issuer+"/oauth/token", strings.NewReader(data.Encode()))
- // // r2.Header.Add("Authorization", "Basic "+"d2ViOnNlY3JldA==")
- // r2.Header.Add("Content-Type", "application/x-www-form-urlencoded")
- // r2.SetBasicAuth("web", "secret")
-
- // resp, _ := client.Do(r2)
- // fmt.Println(resp.Status)
-
- // b, _ := io.ReadAll(resp.Body)
- // resp.Body.Close()
-
- // w.Write(b)
- // }
-
// register the CodeExchangeHandler at the callbackPath
// the CodeExchangeHandler handles the auth response, creates the token request and calls the callback function
// with the returned tokens from the token endpoint
@@ -160,22 +93,8 @@ func main() {
//
// http.Handle(callbackPath, rp.CodeExchangeHandler(marshalToken, provider))
- // simple counter for request IDs
- var counter atomic.Int64
- // enable incomming request logging
- mw := logging.Middleware(
- logging.WithLogger(logger),
- logging.WithGroup("server"),
- logging.WithIDFunc(func() slog.Attr {
- return slog.Int64("id", counter.Add(1))
- }),
- )
-
lis := fmt.Sprintf("127.0.0.1:%s", port)
- logger.Info("server listening, press ctrl+c to stop", "addr", lis)
- err = http.ListenAndServe(lis, mw(http.DefaultServeMux))
- if err != http.ErrServerClosed {
- logger.Error("server terminated", "error", err)
- os.Exit(1)
- }
+ logrus.Infof("listening on http://%s/", lis)
+ logrus.Info("press ctrl+c to stop")
+ logrus.Fatal(http.ListenAndServe(lis, nil))
}
diff --git a/example/client/device/device.go b/example/client/device/device.go
deleted file mode 100644
index 33bc570..0000000
--- a/example/client/device/device.go
+++ /dev/null
@@ -1,95 +0,0 @@
-// Command device is an example Oauth2 Device Authorization Grant app.
-// It creates a new Device Authorization request on the Issuer and then polls for tokens.
-// The user is then prompted to visit a URL and enter the user code.
-// Or, the complete URL can be used instead to omit manual entry.
-// In practice then can be a "magic link" in the form or a QR.
-//
-// The following environment variables are used for configuration:
-//
-// ISSUER: URL to the OP, required.
-// CLIENT_ID: ID of the application, required.
-// CLIENT_SECRET: Secret to authenticate the app using basic auth. Only required if the OP expects this type of authentication.
-// KEY_PATH: Path to a private key file, used to for JWT authentication of the App. Only required if the OP expects this type of authentication.
-// SCOPES: Scopes of the Authentication Request. Optional.
-//
-// Basic usage:
-//
-// cd example/client/device
-// export ISSUER="http://localhost:9000" CLIENT_ID="246048465824634593@demo"
-//
-// Get an Access Token:
-//
-// SCOPES="email profile" go run .
-//
-// Get an Access Token and ID Token:
-//
-// SCOPES="email profile openid" go run .
-//
-// Get an Access Token and Refresh Token
-//
-// SCOPES="email profile offline_access" go run .
-//
-// Get Access, Refresh and ID Tokens:
-//
-// SCOPES="email profile offline_access openid" go run .
-package main
-
-import (
- "context"
- "fmt"
- "os"
- "os/signal"
- "strings"
- "syscall"
- "time"
-
- "github.com/sirupsen/logrus"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
-)
-
-var (
- key = []byte("test1234test1234")
-)
-
-func main() {
- ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGINT)
- defer stop()
-
- clientID := os.Getenv("CLIENT_ID")
- clientSecret := os.Getenv("CLIENT_SECRET")
- keyPath := os.Getenv("KEY_PATH")
- issuer := os.Getenv("ISSUER")
- scopes := strings.Split(os.Getenv("SCOPES"), " ")
-
- cookieHandler := httphelper.NewCookieHandler(key, key, httphelper.WithUnsecure())
-
- var options []rp.Option
- if clientSecret == "" {
- options = append(options, rp.WithPKCE(cookieHandler))
- }
- if keyPath != "" {
- options = append(options, rp.WithJWTProfile(rp.SignerFromKeyPath(keyPath)))
- }
-
- provider, err := rp.NewRelyingPartyOIDC(ctx, issuer, clientID, clientSecret, "", scopes, options...)
- if err != nil {
- logrus.Fatalf("error creating provider %s", err.Error())
- }
-
- logrus.Info("starting device authorization flow")
- resp, err := rp.DeviceAuthorization(ctx, scopes, provider, nil)
- if err != nil {
- logrus.Fatal(err)
- }
- logrus.Info("resp", resp)
- fmt.Printf("\nPlease browse to %s and enter code %s\n", resp.VerificationURI, resp.UserCode)
-
- logrus.Info("start polling")
- token, err := rp.DeviceAccessToken(ctx, resp.DeviceCode, time.Duration(resp.Interval)*time.Second, provider)
- if err != nil {
- logrus.Fatal(err)
- }
- logrus.Infof("successfully obtained token: %#v", token)
-}
diff --git a/example/client/github/github.go b/example/client/github/github.go
index f6c536b..feb3e26 100644
--- a/example/client/github/github.go
+++ b/example/client/github/github.go
@@ -10,10 +10,9 @@ import (
"golang.org/x/oauth2"
githubOAuth "golang.org/x/oauth2/github"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp/cli"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/client/rp"
+ "github.com/zitadel/oidc/pkg/client/rp/cli"
+ "github.com/zitadel/oidc/pkg/http"
)
var (
@@ -44,7 +43,7 @@ func main() {
state := func() string {
return uuid.New().String()
}
- token := cli.CodeFlow[*oidc.IDTokenClaims](ctx, relyingParty, callbackPath, port, state)
+ token := cli.CodeFlow(ctx, relyingParty, callbackPath, port, state)
client := github.NewClient(relyingParty.OAuthConfig().Client(ctx, token.Token))
diff --git a/example/client/service/service.go b/example/client/service/service.go
index a88ab2f..b3819d5 100644
--- a/example/client/service/service.go
+++ b/example/client/service/service.go
@@ -13,7 +13,7 @@ import (
"github.com/sirupsen/logrus"
"golang.org/x/oauth2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/profile"
+ "github.com/zitadel/oidc/pkg/client/profile"
)
var client = http.DefaultClient
@@ -25,7 +25,7 @@ func main() {
scopes := strings.Split(os.Getenv("SCOPES"), " ")
if keyPath != "" {
- ts, err := profile.NewJWTProfileTokenSourceFromKeyFile(context.TODO(), issuer, keyPath, scopes)
+ ts, err := profile.NewJWTProfileTokenSourceFromKeyFile(issuer, keyPath, scopes)
if err != nil {
logrus.Fatalf("error creating token source %s", err.Error())
}
@@ -76,7 +76,7 @@ func main() {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
- ts, err := profile.NewJWTProfileTokenSourceFromKeyFileData(context.TODO(), issuer, key, scopes)
+ ts, err := profile.NewJWTProfileTokenSourceFromKeyFileData(issuer, key, scopes)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
@@ -125,7 +125,7 @@ func main() {
testURL := r.Form.Get("url")
var data struct {
URL string
- Response any
+ Response interface{}
}
if testURL != "" {
data.URL = testURL
@@ -149,7 +149,7 @@ func main() {
logrus.Fatal(http.ListenAndServe("127.0.0.1:"+port, nil))
}
-func callExampleEndpoint(client *http.Client, testURL string) (any, error) {
+func callExampleEndpoint(client *http.Client, testURL string) (interface{}, error) {
req, err := http.NewRequest("GET", testURL, nil)
if err != nil {
return nil, err
diff --git a/example/doc.go b/example/doc.go
index fd4f038..7212a7d 100644
--- a/example/doc.go
+++ b/example/doc.go
@@ -5,6 +5,7 @@ Package example contains some example of the various use of this library:
/app web app / RP demonstrating authorization code flow using various authentication methods (code, PKCE, JWT profile)
/github example of the extended OAuth2 library, providing an HTTP client with a reuse token source
/service demonstration of JWT Profile Authorization Grant
-/server examples of an OpenID Provider implementations (including dynamic) with some very basic
+/server example of an OpenID Provider implementation including some very basic login UI
+
*/
package example
diff --git a/example/server/config/config.go b/example/server/config/config.go
deleted file mode 100644
index 96837d4..0000000
--- a/example/server/config/config.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package config
-
-import (
- "os"
- "strings"
-)
-
-const (
- // default port for the http server to run
- DefaultIssuerPort = "9998"
-)
-
-type Config struct {
- Port string
- RedirectURI []string
- UsersFile string
-}
-
-// FromEnvVars loads configuration parameters from environment variables.
-// If there is no such variable defined, then use default values.
-func FromEnvVars(defaults *Config) *Config {
- if defaults == nil {
- defaults = &Config{}
- }
- cfg := &Config{
- Port: defaults.Port,
- RedirectURI: defaults.RedirectURI,
- UsersFile: defaults.UsersFile,
- }
- if value, ok := os.LookupEnv("PORT"); ok {
- cfg.Port = value
- }
- if value, ok := os.LookupEnv("USERS_FILE"); ok {
- cfg.UsersFile = value
- }
- if value, ok := os.LookupEnv("REDIRECT_URI"); ok {
- cfg.RedirectURI = strings.Split(value, ",")
- }
- return cfg
-}
diff --git a/example/server/config/config_test.go b/example/server/config/config_test.go
deleted file mode 100644
index 3b73c0b..0000000
--- a/example/server/config/config_test.go
+++ /dev/null
@@ -1,77 +0,0 @@
-package config
-
-import (
- "fmt"
- "os"
- "testing"
-)
-
-func TestFromEnvVars(t *testing.T) {
-
- for _, tc := range []struct {
- name string
- env map[string]string
- defaults *Config
- want *Config
- }{
- {
- name: "no vars, no default values",
- env: map[string]string{},
- want: &Config{},
- },
- {
- name: "no vars, only defaults",
- env: map[string]string{},
- defaults: &Config{
- Port: "6666",
- UsersFile: "/default/user/path",
- RedirectURI: []string{"re", "direct", "uris"},
- },
- want: &Config{
- Port: "6666",
- UsersFile: "/default/user/path",
- RedirectURI: []string{"re", "direct", "uris"},
- },
- },
- {
- name: "overriding default values",
- env: map[string]string{
- "PORT": "1234",
- "USERS_FILE": "/path/to/users",
- "REDIRECT_URI": "http://redirect/redirect",
- },
- defaults: &Config{
- Port: "6666",
- UsersFile: "/default/user/path",
- RedirectURI: []string{"re", "direct", "uris"},
- },
- want: &Config{
- Port: "1234",
- UsersFile: "/path/to/users",
- RedirectURI: []string{"http://redirect/redirect"},
- },
- },
- {
- name: "multiple redirect uris",
- env: map[string]string{
- "REDIRECT_URI": "http://host_1,http://host_2,http://host_3",
- },
- want: &Config{
- RedirectURI: []string{
- "http://host_1", "http://host_2", "http://host_3",
- },
- },
- },
- } {
- t.Run(tc.name, func(t *testing.T) {
- os.Clearenv()
- for k, v := range tc.env {
- os.Setenv(k, v)
- }
- cfg := FromEnvVars(tc.defaults)
- if fmt.Sprint(cfg) != fmt.Sprint(tc.want) {
- t.Errorf("Expected FromEnvVars()=%q, but got %q", tc.want, cfg)
- }
- })
- }
-}
diff --git a/example/server/dynamic/login.go b/example/server/dynamic/login.go
deleted file mode 100644
index 05f0e34..0000000
--- a/example/server/dynamic/login.go
+++ /dev/null
@@ -1,113 +0,0 @@
-package main
-
-import (
- "context"
- "fmt"
- "html/template"
- "net/http"
-
- "github.com/go-chi/chi/v5"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
-)
-
-const (
- queryAuthRequestID = "authRequestID"
-)
-
-var (
- loginTmpl, _ = template.New("login").Parse(`
-
-
-
- Login
-
-
-
-
- `)
-)
-
-type login struct {
- authenticate authenticate
- router chi.Router
- callback func(context.Context, string) string
-}
-
-func NewLogin(authenticate authenticate, callback func(context.Context, string) string, issuerInterceptor *op.IssuerInterceptor) *login {
- l := &login{
- authenticate: authenticate,
- callback: callback,
- }
- l.createRouter(issuerInterceptor)
- return l
-}
-
-func (l *login) createRouter(issuerInterceptor *op.IssuerInterceptor) {
- l.router = chi.NewRouter()
- l.router.Get("/username", l.loginHandler)
- l.router.With(issuerInterceptor.Handler).Post("/username", l.checkLoginHandler)
-}
-
-type authenticate interface {
- CheckUsernamePassword(ctx context.Context, username, password, id string) error
-}
-
-func (l *login) loginHandler(w http.ResponseWriter, r *http.Request) {
- err := r.ParseForm()
- if err != nil {
- http.Error(w, fmt.Sprintf("cannot parse form:%s", err), http.StatusInternalServerError)
- return
- }
- //the oidc package will pass the id of the auth request as query parameter
- //we will use this id through the login process and therefore pass it to the login page
- renderLogin(w, r.FormValue(queryAuthRequestID), nil)
-}
-
-func renderLogin(w http.ResponseWriter, id string, err error) {
- var errMsg string
- if err != nil {
- errMsg = err.Error()
- }
- data := &struct {
- ID string
- Error string
- }{
- ID: id,
- Error: errMsg,
- }
- err = loginTmpl.Execute(w, data)
- if err != nil {
- http.Error(w, err.Error(), http.StatusInternalServerError)
- }
-}
-
-func (l *login) checkLoginHandler(w http.ResponseWriter, r *http.Request) {
- err := r.ParseForm()
- if err != nil {
- http.Error(w, fmt.Sprintf("cannot parse form:%s", err), http.StatusInternalServerError)
- return
- }
- username := r.FormValue("username")
- password := r.FormValue("password")
- id := r.FormValue("id")
- err = l.authenticate.CheckUsernamePassword(r.Context(), username, password, id)
- if err != nil {
- renderLogin(w, id, err)
- return
- }
- http.Redirect(w, r, l.callback(r.Context(), id), http.StatusFound)
-}
diff --git a/example/server/dynamic/op.go b/example/server/dynamic/op.go
deleted file mode 100644
index 2c00e41..0000000
--- a/example/server/dynamic/op.go
+++ /dev/null
@@ -1,138 +0,0 @@
-package main
-
-import (
- "context"
- "crypto/sha256"
- "fmt"
- "log"
- "net/http"
-
- "github.com/go-chi/chi/v5"
- "golang.org/x/text/language"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/storage"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
-)
-
-const (
- pathLoggedOut = "/logged-out"
-)
-
-var (
- hostnames = []string{
- "localhost", //note that calling 127.0.0.1 / ::1 won't work as the hostname does not match
- "oidc.local", //add this to your hosts file (pointing to 127.0.0.1)
- //feel free to add more...
- }
-)
-
-func init() {
- storage.RegisterClients(
- storage.NativeClient("native"),
- storage.WebClient("web", "secret"),
- storage.WebClient("api", "secret"),
- )
-}
-
-func main() {
- ctx := context.Background()
-
- port := "9998"
- issuers := make([]string, len(hostnames))
- for i, hostname := range hostnames {
- issuers[i] = fmt.Sprintf("http://%s:%s/", hostname, port)
- }
-
- //the OpenID Provider requires a 32-byte key for (token) encryption
- //be sure to create a proper crypto random key and manage it securely!
- key := sha256.Sum256([]byte("test"))
-
- router := chi.NewRouter()
-
- //for simplicity, we provide a very small default page for users who have signed out
- router.HandleFunc(pathLoggedOut, func(w http.ResponseWriter, req *http.Request) {
- _, err := w.Write([]byte("signed out successfully"))
- if err != nil {
- log.Printf("error serving logged out page: %v", err)
- }
- })
-
- //the OpenIDProvider interface needs a Storage interface handling various checks and state manipulations
- //this might be the layer for accessing your database
- //in this example it will be handled in-memory
- //the NewMultiStorage is able to handle multiple issuers
- storage := storage.NewMultiStorage(issuers)
-
- //creation of the OpenIDProvider with the just created in-memory Storage
- provider, err := newDynamicOP(ctx, storage, key)
- if err != nil {
- log.Fatal(err)
- }
-
- //the provider will only take care of the OpenID Protocol, so there must be some sort of UI for the login process
- //for the simplicity of the example this means a simple page with username and password field
- //be sure to provide an IssuerInterceptor with the IssuerFromRequest from the OP so the login can select / and pass it to the storage
- l := NewLogin(storage, op.AuthCallbackURL(provider), op.NewIssuerInterceptor(provider.IssuerFromRequest))
-
- //regardless of how many pages / steps there are in the process, the UI must be registered in the router,
- //so we will direct all calls to /login to the login UI
- router.Mount("/login/", http.StripPrefix("/login", l.router))
-
- //we register the http handler of the OP on the root, so that the discovery endpoint (/.well-known/openid-configuration)
- //is served on the correct path
- //
- //if your issuer ends with a path (e.g. http://localhost:9998/custom/path/),
- //then you would have to set the path prefix (/custom/path/):
- //router.PathPrefix("/custom/path/").Handler(http.StripPrefix("/custom/path", provider.HttpHandler()))
- router.Mount("/", provider)
-
- server := &http.Server{
- Addr: ":" + port,
- Handler: router,
- }
- err = server.ListenAndServe()
- if err != nil {
- log.Fatal(err)
- }
- <-ctx.Done()
-}
-
-// newDynamicOP will create an OpenID Provider for localhost on a specified port with a given encryption key
-// and a predefined default logout uri
-// it will enable all options (see descriptions)
-func newDynamicOP(ctx context.Context, storage op.Storage, key [32]byte) (*op.Provider, error) {
- config := &op.Config{
- CryptoKey: key,
-
- //will be used if the end_session endpoint is called without a post_logout_redirect_uri
- DefaultLogoutRedirectURI: pathLoggedOut,
-
- //enables code_challenge_method S256 for PKCE (and therefore PKCE in general)
- CodeMethodS256: true,
-
- //enables additional client_id/client_secret authentication by form post (not only HTTP Basic Auth)
- AuthMethodPost: true,
-
- //enables additional authentication by using private_key_jwt
- AuthMethodPrivateKeyJWT: true,
-
- //enables refresh_token grant use
- GrantTypeRefreshToken: true,
-
- //enables use of the `request` Object parameter
- RequestObjectSupported: true,
-
- //this example has only static texts (in English), so we'll set the here accordingly
- SupportedUILocales: []language.Tag{language.English},
- }
- handler, err := op.NewDynamicOpenIDProvider("/", config, storage,
- //we must explicitly allow the use of the http issuer
- op.WithAllowInsecure(),
- //as an example on how to customize an endpoint this will change the authorization_endpoint from /authorize to /auth
- op.WithCustomAuthEndpoint(op.NewEndpoint("auth")),
- )
- if err != nil {
- return nil, err
- }
- return handler, nil
-}
diff --git a/example/server/exampleop/device.go b/example/server/exampleop/device.go
deleted file mode 100644
index 99505e4..0000000
--- a/example/server/exampleop/device.go
+++ /dev/null
@@ -1,204 +0,0 @@
-package exampleop
-
-import (
- "context"
- "errors"
- "fmt"
- "io"
- "net/http"
- "net/url"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "github.com/go-chi/chi/v5"
- "github.com/gorilla/securecookie"
- "github.com/sirupsen/logrus"
-)
-
-type deviceAuthenticate interface {
- CheckUsernamePasswordSimple(username, password string) error
- op.DeviceAuthorizationStorage
-
- // GetDeviceAuthorizationByUserCode resturns the current state of the device authorization flow,
- // identified by the user code.
- GetDeviceAuthorizationByUserCode(ctx context.Context, userCode string) (*op.DeviceAuthorizationState, error)
-
- // CompleteDeviceAuthorization marks a device authorization entry as Completed,
- // identified by userCode. The Subject is added to the state, so that
- // GetDeviceAuthorizatonState can use it to create a new Access Token.
- CompleteDeviceAuthorization(ctx context.Context, userCode, subject string) error
-
- // DenyDeviceAuthorization marks a device authorization entry as Denied.
- DenyDeviceAuthorization(ctx context.Context, userCode string) error
-}
-
-type deviceLogin struct {
- storage deviceAuthenticate
- cookie *securecookie.SecureCookie
-}
-
-func registerDeviceAuth(storage deviceAuthenticate, router chi.Router) {
- l := &deviceLogin{
- storage: storage,
- cookie: securecookie.New(securecookie.GenerateRandomKey(32), nil),
- }
-
- router.HandleFunc("/", l.userCodeHandler)
- router.Post("/login", l.loginHandler)
- router.HandleFunc("/confirm", l.confirmHandler)
-}
-
-func renderUserCode(w io.Writer, err error) {
- data := struct {
- Error string
- }{
- Error: errMsg(err),
- }
-
- if err := templates.ExecuteTemplate(w, "usercode", data); err != nil {
- logrus.Error(err)
- }
-}
-
-func renderDeviceLogin(w http.ResponseWriter, userCode string, err error) {
- data := &struct {
- UserCode string
- Error string
- }{
- UserCode: userCode,
- Error: errMsg(err),
- }
- if err = templates.ExecuteTemplate(w, "device_login", data); err != nil {
- logrus.Error(err)
- }
-}
-
-func renderConfirmPage(w http.ResponseWriter, username, clientID string, scopes []string) {
- data := &struct {
- Username string
- ClientID string
- Scopes []string
- }{
- Username: username,
- ClientID: clientID,
- Scopes: scopes,
- }
- if err := templates.ExecuteTemplate(w, "confirm_device", data); err != nil {
- logrus.Error(err)
- }
-}
-
-func (d *deviceLogin) userCodeHandler(w http.ResponseWriter, r *http.Request) {
- err := r.ParseForm()
- if err != nil {
- w.WriteHeader(http.StatusBadRequest)
- renderUserCode(w, err)
- return
- }
- userCode := r.Form.Get("user_code")
- if userCode == "" {
- if prompt, _ := url.QueryUnescape(r.Form.Get("prompt")); prompt != "" {
- err = errors.New(prompt)
- }
- renderUserCode(w, err)
- return
- }
-
- renderDeviceLogin(w, userCode, nil)
-}
-
-func redirectBack(w http.ResponseWriter, r *http.Request, prompt string) {
- values := make(url.Values)
- values.Set("prompt", url.QueryEscape(prompt))
-
- url := url.URL{
- Path: "/device",
- RawQuery: values.Encode(),
- }
- http.Redirect(w, r, url.String(), http.StatusSeeOther)
-}
-
-const userCodeCookieName = "user_code"
-
-type userCodeCookie struct {
- UserCode string
- UserName string
-}
-
-func (d *deviceLogin) loginHandler(w http.ResponseWriter, r *http.Request) {
- if err := r.ParseForm(); err != nil {
- redirectBack(w, r, err.Error())
- return
- }
-
- userCode := r.PostForm.Get("user_code")
- if userCode == "" {
- redirectBack(w, r, "missing user_code in request")
- return
- }
- username := r.PostForm.Get("username")
- if username == "" {
- redirectBack(w, r, "missing username in request")
- return
- }
- password := r.PostForm.Get("password")
- if password == "" {
- redirectBack(w, r, "missing password in request")
- return
- }
-
- if err := d.storage.CheckUsernamePasswordSimple(username, password); err != nil {
- redirectBack(w, r, err.Error())
- return
- }
- state, err := d.storage.GetDeviceAuthorizationByUserCode(r.Context(), userCode)
- if err != nil {
- redirectBack(w, r, err.Error())
- return
- }
-
- encoded, err := d.cookie.Encode(userCodeCookieName, userCodeCookie{userCode, username})
- if err != nil {
- http.Error(w, err.Error(), http.StatusInternalServerError)
- return
- }
- cookie := &http.Cookie{
- Name: userCodeCookieName,
- Value: encoded,
- Path: "/",
- }
- http.SetCookie(w, cookie)
- renderConfirmPage(w, username, state.ClientID, state.Scopes)
-}
-
-func (d *deviceLogin) confirmHandler(w http.ResponseWriter, r *http.Request) {
- cookie, err := r.Cookie(userCodeCookieName)
- if err != nil {
- redirectBack(w, r, err.Error())
- return
- }
- data := new(userCodeCookie)
- if err = d.cookie.Decode(userCodeCookieName, cookie.Value, &data); err != nil {
- redirectBack(w, r, err.Error())
- return
- }
- if err = r.ParseForm(); err != nil {
- redirectBack(w, r, err.Error())
- return
- }
-
- action := r.Form.Get("action")
- switch action {
- case "allowed":
- err = d.storage.CompleteDeviceAuthorization(r.Context(), data.UserCode, data.UserName)
- case "denied":
- err = d.storage.DenyDeviceAuthorization(r.Context(), data.UserCode)
- default:
- err = errors.New("action must be one of \"allow\" or \"deny\"")
- }
- if err != nil {
- redirectBack(w, r, err.Error())
- return
- }
-
- fmt.Fprintf(w, "Device authorization %s. You can now return to the device", action)
-}
diff --git a/example/server/exampleop/login.go b/example/server/exampleop/login.go
index 77a6189..fd3dead 100644
--- a/example/server/exampleop/login.go
+++ b/example/server/exampleop/login.go
@@ -1,33 +1,65 @@
package exampleop
import (
- "context"
"fmt"
+ "html/template"
"net/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "github.com/go-chi/chi/v5"
+ "github.com/gorilla/mux"
)
+const (
+ queryAuthRequestID = "authRequestID"
+)
+
+var loginTmpl, _ = template.New("login").Parse(`
+
+
+
+ Login
+
+
+
+
+ `)
+
type login struct {
authenticate authenticate
- router chi.Router
- callback func(context.Context, string) string
+ router *mux.Router
+ callback func(string) string
}
-func NewLogin(authenticate authenticate, callback func(context.Context, string) string, issuerInterceptor *op.IssuerInterceptor) *login {
+func NewLogin(authenticate authenticate, callback func(string) string) *login {
l := &login{
authenticate: authenticate,
callback: callback,
}
- l.createRouter(issuerInterceptor)
+ l.createRouter()
return l
}
-func (l *login) createRouter(issuerInterceptor *op.IssuerInterceptor) {
- l.router = chi.NewRouter()
- l.router.Get("/username", l.loginHandler)
- l.router.Post("/username", issuerInterceptor.HandlerFunc(l.checkLoginHandler))
+func (l *login) createRouter() {
+ l.router = mux.NewRouter()
+ l.router.Path("/username").Methods("GET").HandlerFunc(l.loginHandler)
+ l.router.Path("/username").Methods("POST").HandlerFunc(l.checkLoginHandler)
}
type authenticate interface {
@@ -41,19 +73,23 @@ func (l *login) loginHandler(w http.ResponseWriter, r *http.Request) {
return
}
// the oidc package will pass the id of the auth request as query parameter
- // we will use this id through the login process and therefore pass it to the login page
+ // we will use this id through the login process and therefore pass it to the login page
renderLogin(w, r.FormValue(queryAuthRequestID), nil)
}
func renderLogin(w http.ResponseWriter, id string, err error) {
+ var errMsg string
+ if err != nil {
+ errMsg = err.Error()
+ }
data := &struct {
ID string
Error string
}{
ID: id,
- Error: errMsg(err),
+ Error: errMsg,
}
- err = templates.ExecuteTemplate(w, "login", data)
+ err = loginTmpl.Execute(w, data)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
}
@@ -73,5 +109,5 @@ func (l *login) checkLoginHandler(w http.ResponseWriter, r *http.Request) {
renderLogin(w, id, err)
return
}
- http.Redirect(w, r, l.callback(r.Context(), id), http.StatusFound)
+ http.Redirect(w, r, l.callback(id), http.StatusFound)
}
diff --git a/example/server/exampleop/op.go b/example/server/exampleop/op.go
index e12c755..4794d8a 100644
--- a/example/server/exampleop/op.go
+++ b/example/server/exampleop/op.go
@@ -1,85 +1,77 @@
package exampleop
import (
+ "context"
"crypto/sha256"
"log"
- "log/slog"
"net/http"
- "sync/atomic"
- "time"
+ "os"
- "github.com/go-chi/chi/v5"
- "github.com/zitadel/logging"
+ "github.com/gorilla/mux"
"golang.org/x/text/language"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
+ "github.com/zitadel/oidc/example/server/storage"
+ "github.com/zitadel/oidc/pkg/op"
)
const (
pathLoggedOut = "/logged-out"
)
-type Storage interface {
- op.Storage
- authenticate
- deviceAuthenticate
+func init() {
+ storage.RegisterClients(
+ storage.NativeClient("native"),
+ storage.WebClient("web", "secret"),
+ storage.WebClient("api", "secret"),
+ )
}
-// simple counter for request IDs
-var counter atomic.Int64
+type Storage interface {
+ op.Storage
+ CheckUsernamePassword(username, password, id string) error
+}
// SetupServer creates an OIDC server with Issuer=http://localhost:
//
// Use one of the pre-made clients in storage/clients.go or register a new one.
-func SetupServer(issuer string, storage Storage, logger *slog.Logger, wrapServer bool, extraOptions ...op.Option) chi.Router {
+func SetupServer(ctx context.Context, issuer string, storage Storage) *mux.Router {
+ // this will allow us to use an issuer with http:// instead of https://
+ os.Setenv(op.OidcDevMode, "true")
+
// the OpenID Provider requires a 32-byte key for (token) encryption
// be sure to create a proper crypto random key and manage it securely!
key := sha256.Sum256([]byte("test"))
- router := chi.NewRouter()
- router.Use(logging.Middleware(
- logging.WithLogger(logger),
- logging.WithIDFunc(func() slog.Attr {
- return slog.Int64("id", counter.Add(1))
- }),
- ))
+ router := mux.NewRouter()
// for simplicity, we provide a very small default page for users who have signed out
router.HandleFunc(pathLoggedOut, func(w http.ResponseWriter, req *http.Request) {
- w.Write([]byte("signed out successfully"))
- // no need to check/log error, this will be handled by the middleware.
+ _, err := w.Write([]byte("signed out successfully"))
+ if err != nil {
+ log.Printf("error serving logged out page: %v", err)
+ }
})
// creation of the OpenIDProvider with the just created in-memory Storage
- provider, err := newOP(storage, issuer, key, logger, extraOptions...)
+ provider, err := newOP(ctx, storage, issuer, key)
if err != nil {
log.Fatal(err)
}
- //the provider will only take care of the OpenID Protocol, so there must be some sort of UI for the login process
- //for the simplicity of the example this means a simple page with username and password field
- //be sure to provide an IssuerInterceptor with the IssuerFromRequest from the OP so the login can select / and pass it to the storage
- l := NewLogin(storage, op.AuthCallbackURL(provider), op.NewIssuerInterceptor(provider.IssuerFromRequest))
+ // the provider will only take care of the OpenID Protocol, so there must be some sort of UI for the login process
+ // for the simplicity of the example this means a simple page with username and password field
+ l := NewLogin(storage, op.AuthCallbackURL(provider))
// regardless of how many pages / steps there are in the process, the UI must be registered in the router,
// so we will direct all calls to /login to the login UI
- router.Mount("/login/", http.StripPrefix("/login", l.router))
-
- router.Route("/device", func(r chi.Router) {
- registerDeviceAuth(storage, r)
- })
-
- handler := http.Handler(provider)
- if wrapServer {
- handler = op.RegisterLegacyServer(op.NewLegacyServer(provider, *op.DefaultEndpoints), op.AuthorizeCallbackHandler(provider))
- }
+ router.PathPrefix("/login/").Handler(http.StripPrefix("/login", l.router))
// we register the http handler of the OP on the root, so that the discovery endpoint (/.well-known/openid-configuration)
// is served on the correct path
//
// if your issuer ends with a path (e.g. http://localhost:9998/custom/path/),
// then you would have to set the path prefix (/custom/path/)
- router.Mount("/", handler)
+ router.PathPrefix("/").Handler(provider.HttpHandler())
return router
}
@@ -87,8 +79,9 @@ func SetupServer(issuer string, storage Storage, logger *slog.Logger, wrapServer
// newOP will create an OpenID Provider for localhost on a specified port with a given encryption key
// and a predefined default logout uri
// it will enable all options (see descriptions)
-func newOP(storage op.Storage, issuer string, key [32]byte, logger *slog.Logger, extraOptions ...op.Option) (op.OpenIDProvider, error) {
+func newOP(ctx context.Context, storage op.Storage, issuer string, key [32]byte) (op.OpenIDProvider, error) {
config := &op.Config{
+ Issuer: issuer,
CryptoKey: key,
// will be used if the end_session endpoint is called without a post_logout_redirect_uri
@@ -111,23 +104,10 @@ func newOP(storage op.Storage, issuer string, key [32]byte, logger *slog.Logger,
// this example has only static texts (in English), so we'll set the here accordingly
SupportedUILocales: []language.Tag{language.English},
-
- DeviceAuthorization: op.DeviceAuthorizationConfig{
- Lifetime: 5 * time.Minute,
- PollInterval: 5 * time.Second,
- UserFormPath: "/device",
- UserCode: op.UserCodeBase20,
- },
}
- handler, err := op.NewOpenIDProvider(issuer, config, storage,
- append([]op.Option{
- //we must explicitly allow the use of the http issuer
- op.WithAllowInsecure(),
- // as an example on how to customize an endpoint this will change the authorization_endpoint from /authorize to /auth
- op.WithCustomAuthEndpoint(op.NewEndpoint("auth")),
- // Pass our logger to the OP
- op.WithLogger(logger.WithGroup("op")),
- }, extraOptions...)...,
+ handler, err := op.NewOpenIDProvider(ctx, config, storage,
+ // as an example on how to customize an endpoint this will change the authorization_endpoint from /authorize to /auth
+ op.WithCustomAuthEndpoint(op.NewEndpoint("auth")),
)
if err != nil {
return nil, err
diff --git a/example/server/exampleop/templates.go b/example/server/exampleop/templates.go
deleted file mode 100644
index 5b5c966..0000000
--- a/example/server/exampleop/templates.go
+++ /dev/null
@@ -1,26 +0,0 @@
-package exampleop
-
-import (
- "embed"
- "html/template"
-
- "github.com/sirupsen/logrus"
-)
-
-var (
- //go:embed templates
- templateFS embed.FS
- templates = template.Must(template.ParseFS(templateFS, "templates/*.html"))
-)
-
-const (
- queryAuthRequestID = "authRequestID"
-)
-
-func errMsg(err error) string {
- if err == nil {
- return ""
- }
- logrus.Error(err)
- return err.Error()
-}
diff --git a/example/server/exampleop/templates/confirm_device.html b/example/server/exampleop/templates/confirm_device.html
deleted file mode 100644
index a6bcdad..0000000
--- a/example/server/exampleop/templates/confirm_device.html
+++ /dev/null
@@ -1,25 +0,0 @@
-{{ define "confirm_device" -}}
-
-
-
- Confirm device authorization
-
-
-
- Welcome back {{.Username}}!
-
- You are about to grant device {{.ClientID}} access to the following scopes: {{.Scopes}}.
-
- Allow
- Deny
-
-
-{{- end }}
diff --git a/example/server/exampleop/templates/device_login.html b/example/server/exampleop/templates/device_login.html
deleted file mode 100644
index cc5b00b..0000000
--- a/example/server/exampleop/templates/device_login.html
+++ /dev/null
@@ -1,29 +0,0 @@
-{{ define "device_login" -}}
-
-
-
- Login
-
-
-
-
-
-{{- end }}
diff --git a/example/server/exampleop/templates/login.html b/example/server/exampleop/templates/login.html
deleted file mode 100644
index b048211..0000000
--- a/example/server/exampleop/templates/login.html
+++ /dev/null
@@ -1,29 +0,0 @@
-{{ define "login" -}}
-
-
-
- Login
-
-
-
-
-`
-{{- end }}
\ No newline at end of file
diff --git a/example/server/exampleop/templates/usercode.html b/example/server/exampleop/templates/usercode.html
deleted file mode 100644
index fb8fa7f..0000000
--- a/example/server/exampleop/templates/usercode.html
+++ /dev/null
@@ -1,21 +0,0 @@
-{{ define "usercode" -}}
-
-
-
- Device authorization
-
-
-
-
-
-{{- end }}
diff --git a/example/server/main.go b/example/server/main.go
index 5bdbb05..3cfd20d 100644
--- a/example/server/main.go
+++ b/example/server/main.go
@@ -1,59 +1,34 @@
package main
import (
- "fmt"
- "log/slog"
+ "context"
+ "log"
"net/http"
- "os"
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/config"
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/exampleop"
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/storage"
+ "github.com/zitadel/oidc/example/server/exampleop"
+ "github.com/zitadel/oidc/example/server/storage"
)
-func getUserStore(cfg *config.Config) (storage.UserStore, error) {
- if cfg.UsersFile == "" {
- return storage.NewUserStore(fmt.Sprintf("http://localhost:%s/", cfg.Port)), nil
- }
- return storage.StoreFromFile(cfg.UsersFile)
-}
-
func main() {
- cfg := config.FromEnvVars(&config.Config{Port: "9998"})
- logger := slog.New(
- slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
- AddSource: true,
- Level: slog.LevelDebug,
- }),
- )
-
- //which gives us the issuer: http://localhost:9998/
- issuer := fmt.Sprintf("http://localhost:%s/", cfg.Port)
-
- storage.RegisterClients(
- storage.NativeClient("native", cfg.RedirectURI...),
- storage.WebClient("web", "secret", cfg.RedirectURI...),
- storage.WebClient("api", "secret", cfg.RedirectURI...),
- )
+ ctx := context.Background()
// the OpenIDProvider interface needs a Storage interface handling various checks and state manipulations
// this might be the layer for accessing your database
// in this example it will be handled in-memory
- store, err := getUserStore(cfg)
- if err != nil {
- logger.Error("cannot create UserStore", "error", err)
- os.Exit(1)
- }
- storage := storage.NewStorage(store)
- router := exampleop.SetupServer(issuer, storage, logger, false)
+ storage := storage.NewStorage(storage.NewUserStore())
+
+ port := "9998"
+ router := exampleop.SetupServer(ctx, "http://localhost:"+port, storage)
server := &http.Server{
- Addr: ":" + cfg.Port,
+ Addr: ":" + port,
Handler: router,
}
- logger.Info("server listening, press ctrl+c to stop", "addr", issuer)
- if server.ListenAndServe() != http.ErrServerClosed {
- logger.Error("server terminated", "error", err)
- os.Exit(1)
+ log.Printf("server listening on http://localhost:%s/", port)
+ log.Println("press ctrl+c to stop")
+ err := server.ListenAndServe()
+ if err != nil {
+ log.Fatal(err)
}
+ <-ctx.Done()
}
diff --git a/example/server/storage/client.go b/example/server/storage/client.go
index 2b836c0..0b98679 100644
--- a/example/server/storage/client.go
+++ b/example/server/storage/client.go
@@ -3,8 +3,8 @@ package storage
import (
"time"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
+ "github.com/zitadel/oidc/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/op"
)
var (
@@ -32,8 +32,6 @@ type Client struct {
devMode bool
idTokenUserinfoClaimsAssertion bool
clockSkew time.Duration
- postLogoutRedirectURIGlobs []string
- redirectURIGlobs []string
}
// GetID must return the client_id
@@ -46,11 +44,21 @@ func (c *Client) RedirectURIs() []string {
return c.redirectURIs
}
+// RedirectURIGlobs provide wildcarding for additional valid redirects
+func (c *Client) RedirectURIGlobs() []string {
+ return nil
+}
+
// PostLogoutRedirectURIs must return the registered post_logout_redirect_uris for sign-outs
func (c *Client) PostLogoutRedirectURIs() []string {
return []string{}
}
+// PostLogoutRedirectURIGlobs provide extra wildcarding for additional valid redirects
+func (c *Client) PostLogoutRedirectURIGlobs() []string {
+ return nil
+}
+
// ApplicationType must return the type of the client (app, native, user agent)
func (c *Client) ApplicationType() op.ApplicationType {
return c.applicationType
@@ -160,7 +168,7 @@ func NativeClient(id string, redirectURIs ...string) *Client {
loginURL: defaultLoginURL,
responseTypes: []oidc.ResponseType{oidc.ResponseTypeCode},
grantTypes: []oidc.GrantType{oidc.GrantTypeCode, oidc.GrantTypeRefreshToken},
- accessTokenType: op.AccessTokenTypeBearer,
+ accessTokenType: 0,
devMode: false,
idTokenUserinfoClaimsAssertion: false,
clockSkew: 0,
@@ -184,52 +192,11 @@ func WebClient(id, secret string, redirectURIs ...string) *Client {
applicationType: op.ApplicationTypeWeb,
authMethod: oidc.AuthMethodBasic,
loginURL: defaultLoginURL,
- responseTypes: []oidc.ResponseType{oidc.ResponseTypeCode, oidc.ResponseTypeIDTokenOnly, oidc.ResponseTypeIDToken},
- grantTypes: []oidc.GrantType{oidc.GrantTypeCode, oidc.GrantTypeRefreshToken, oidc.GrantTypeTokenExchange},
- accessTokenType: op.AccessTokenTypeBearer,
- devMode: true,
- idTokenUserinfoClaimsAssertion: false,
- clockSkew: 0,
- }
-}
-
-// DeviceClient creates a device client with Basic authentication.
-func DeviceClient(id, secret string) *Client {
- return &Client{
- id: id,
- secret: secret,
- redirectURIs: nil,
- applicationType: op.ApplicationTypeWeb,
- authMethod: oidc.AuthMethodBasic,
- loginURL: defaultLoginURL,
responseTypes: []oidc.ResponseType{oidc.ResponseTypeCode},
- grantTypes: []oidc.GrantType{oidc.GrantTypeDeviceCode},
- accessTokenType: op.AccessTokenTypeBearer,
+ grantTypes: []oidc.GrantType{oidc.GrantTypeCode, oidc.GrantTypeRefreshToken},
+ accessTokenType: 0,
devMode: false,
idTokenUserinfoClaimsAssertion: false,
clockSkew: 0,
}
}
-
-type hasRedirectGlobs struct {
- *Client
-}
-
-// RedirectURIGlobs provide wildcarding for additional valid redirects
-func (c hasRedirectGlobs) RedirectURIGlobs() []string {
- return c.redirectURIGlobs
-}
-
-// PostLogoutRedirectURIGlobs provide extra wildcarding for additional valid redirects
-func (c hasRedirectGlobs) PostLogoutRedirectURIGlobs() []string {
- return c.postLogoutRedirectURIGlobs
-}
-
-// RedirectGlobsClient wraps the client in a op.HasRedirectGlobs
-// only if DevMode is enabled.
-func RedirectGlobsClient(client *Client) op.Client {
- if client.devMode {
- return hasRedirectGlobs{client}
- }
- return client
-}
diff --git a/example/server/storage/oidc.go b/example/server/storage/oidc.go
index 9c7f544..91afd90 100644
--- a/example/server/storage/oidc.go
+++ b/example/server/storage/oidc.go
@@ -1,13 +1,13 @@
package storage
import (
- "log/slog"
"time"
"golang.org/x/text/language"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
+ "github.com/zitadel/oidc/pkg/op"
+
+ "github.com/zitadel/oidc/pkg/oidc"
)
const (
@@ -17,9 +17,6 @@ const (
// CustomClaim is an example for how to return custom claims with this library
CustomClaim = "custom_claim"
-
- // CustomScopeImpersonatePrefix is an example scope prefix for passing user id to impersonate using token exchage
- CustomScopeImpersonatePrefix = "custom_scope:impersonate:"
)
type AuthRequest struct {
@@ -35,25 +32,11 @@ type AuthRequest struct {
UserID string
Scopes []string
ResponseType oidc.ResponseType
- ResponseMode oidc.ResponseMode
Nonce string
CodeChallenge *OIDCCodeChallenge
- done bool
- authTime time.Time
-}
-
-// LogValue allows you to define which fields will be logged.
-// Implements the [slog.LogValuer]
-func (a *AuthRequest) LogValue() slog.Value {
- return slog.GroupValue(
- slog.String("id", a.ID),
- slog.Time("creation_date", a.CreationDate),
- slog.Any("scopes", a.Scopes),
- slog.String("response_type", string(a.ResponseType)),
- slog.String("app_id", a.ApplicationID),
- slog.String("callback_uri", a.CallbackURI),
- )
+ passwordChecked bool
+ authTime time.Time
}
func (a *AuthRequest) GetID() string {
@@ -66,7 +49,7 @@ func (a *AuthRequest) GetACR() string {
func (a *AuthRequest) GetAMR() []string {
// this example only uses password for authentication
- if a.done {
+ if a.passwordChecked {
return []string{"pwd"}
}
return nil
@@ -101,7 +84,7 @@ func (a *AuthRequest) GetResponseType() oidc.ResponseType {
}
func (a *AuthRequest) GetResponseMode() oidc.ResponseMode {
- return a.ResponseMode
+ return "" // we won't handle response mode in this example
}
func (a *AuthRequest) GetScopes() []string {
@@ -117,11 +100,11 @@ func (a *AuthRequest) GetSubject() string {
}
func (a *AuthRequest) Done() bool {
- return a.done
+ return a.passwordChecked // this example only uses password for authentication
}
func PromptToInternal(oidcPrompt oidc.SpaceDelimitedArray) []string {
- prompts := make([]string, 0, len(oidcPrompt))
+ prompts := make([]string, len(oidcPrompt))
for _, oidcPrompt := range oidcPrompt {
switch oidcPrompt {
case oidc.PromptNone,
@@ -155,7 +138,6 @@ func authRequestToInternal(authReq *oidc.AuthRequest, userID string) *AuthReques
UserID: userID,
Scopes: authReq.Scopes,
ResponseType: authReq.ResponseType,
- ResponseMode: authReq.ResponseMode,
Nonce: authReq.Nonce,
CodeChallenge: &OIDCCodeChallenge{
Challenge: authReq.CodeChallenge,
@@ -164,15 +146,6 @@ func authRequestToInternal(authReq *oidc.AuthRequest, userID string) *AuthReques
}
}
-type AuthRequestWithSessionState struct {
- *AuthRequest
- SessionState string
-}
-
-func (a *AuthRequestWithSessionState) GetSessionState() string {
- return a.SessionState
-}
-
type OIDCCodeChallenge struct {
Challenge string
Method string
diff --git a/example/server/storage/storage.go b/example/server/storage/storage.go
index d4315c6..130822e 100644
--- a/example/server/storage/storage.go
+++ b/example/server/storage/storage.go
@@ -4,18 +4,16 @@ import (
"context"
"crypto/rand"
"crypto/rsa"
- "errors"
"fmt"
"math/big"
- "strings"
"sync"
"time"
- jose "github.com/go-jose/go-jose/v4"
"github.com/google/uuid"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
+ "github.com/zitadel/oidc/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/op"
)
// serviceKey1 is a public key which will be used for the JWT Profile Authorization Grant
@@ -28,10 +26,8 @@ var serviceKey1 = &rsa.PublicKey{
E: 65537,
}
-var (
- _ op.Storage = &Storage{}
- _ op.ClientCredentialsStorage = &Storage{}
-)
+// var _ op.Storage = &storage{}
+// var _ op.ClientCredentialsStorage = &storage{}
// storage implements the op.Storage interface
// typically you would implement this as a layer on top of your database
@@ -46,54 +42,15 @@ type Storage struct {
services map[string]Service
refreshTokens map[string]*RefreshToken
signingKey signingKey
- deviceCodes map[string]deviceAuthorizationEntry
- userCodes map[string]string
- serviceUsers map[string]*Client
}
type signingKey struct {
- id string
- algorithm jose.SignatureAlgorithm
- key *rsa.PrivateKey
-}
-
-func (s *signingKey) SignatureAlgorithm() jose.SignatureAlgorithm {
- return s.algorithm
-}
-
-func (s *signingKey) Key() any {
- return s.key
-}
-
-func (s *signingKey) ID() string {
- return s.id
-}
-
-type publicKey struct {
- signingKey
-}
-
-func (s *publicKey) ID() string {
- return s.id
-}
-
-func (s *publicKey) Algorithm() jose.SignatureAlgorithm {
- return s.algorithm
-}
-
-func (s *publicKey) Use() string {
- return "sig"
-}
-
-func (s *publicKey) Key() any {
- return &s.key.PublicKey
+ ID string
+ Algorithm string
+ Key *rsa.PrivateKey
}
func NewStorage(userStore UserStore) *Storage {
- return NewStorageWithClients(userStore, clients)
-}
-
-func NewStorageWithClients(userStore UserStore, clients map[string]*Client) *Storage {
key, _ := rsa.GenerateKey(rand.Reader, 2048)
return &Storage{
authRequests: make(map[string]*AuthRequest),
@@ -110,21 +67,9 @@ func NewStorageWithClients(userStore UserStore, clients map[string]*Client) *Sto
},
},
signingKey: signingKey{
- id: uuid.NewString(),
- algorithm: jose.RS256,
- key: key,
- },
- deviceCodes: make(map[string]deviceAuthorizationEntry),
- userCodes: make(map[string]string),
- serviceUsers: map[string]*Client{
- "sid1": {
- id: "sid1",
- secret: "verysecret",
- grantTypes: []oidc.GrantType{
- oidc.GrantTypeClientCredentials,
- },
- accessTokenType: op.AccessTokenTypeBearer,
- },
+ ID: "id",
+ Algorithm: "RS256",
+ Key: key,
},
}
}
@@ -150,21 +95,7 @@ func (s *Storage) CheckUsernamePassword(username, password, id string) error {
// you will have to change some state on the request to guide the user through possible multiple steps of the login process
// in this example we'll simply check the username / password and set a boolean to true
// therefore we will also just check this boolean if the request / login has been finished
- request.done = true
-
- request.authTime = time.Now()
-
- return nil
- }
- return fmt.Errorf("username or password wrong")
-}
-
-func (s *Storage) CheckUsernamePasswordSimple(username, password string) error {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- user := s.userStore.GetUserByUsername(username)
- if user != nil && user.Password == password {
+ request.passwordChecked = true
return nil
}
return fmt.Errorf("username or password wrong")
@@ -176,12 +107,6 @@ func (s *Storage) CreateAuthRequest(ctx context.Context, authReq *oidc.AuthReque
s.lock.Lock()
defer s.lock.Unlock()
- if len(authReq.Prompt) == 1 && authReq.Prompt[0] == "none" {
- // With prompt=none, there is no way for the user to log in
- // so return error right away.
- return nil, oidc.ErrLoginRequired()
- }
-
// typically, you'll fill your storage / storage model with the information of the passed object
request := authRequestToInternal(authReq, userID)
@@ -256,14 +181,11 @@ func (s *Storage) DeleteAuthRequest(ctx context.Context, id string) error {
// it will be called for all requests able to return an access token (Authorization Code Flow, Implicit Flow, JWT Profile, ...)
func (s *Storage) CreateAccessToken(ctx context.Context, request op.TokenRequest) (string, time.Time, error) {
var applicationID string
- switch req := request.(type) {
- case *AuthRequest:
- // if authenticated for an app (auth code / implicit flow) we must save the client_id to the token
- applicationID = req.ApplicationID
- case op.TokenExchangeRequest:
- applicationID = req.GetClientID()
+ // if authenticated for an app (auth code / implicit flow) we must save the client_id to the token
+ authReq, ok := request.(*AuthRequest)
+ if ok {
+ applicationID = authReq.ApplicationID
}
-
token, err := s.accessToken(applicationID, "", request.GetSubject(), request.GetAudience(), request.GetScopes())
if err != nil {
return "", time.Time{}, err
@@ -274,11 +196,6 @@ func (s *Storage) CreateAccessToken(ctx context.Context, request op.TokenRequest
// CreateAccessAndRefreshTokens implements the op.Storage interface
// it will be called for all requests able to return an access and refresh token (Authorization Code Flow, Refresh Token Request)
func (s *Storage) CreateAccessAndRefreshTokens(ctx context.Context, request op.TokenRequest, currentRefreshToken string) (accessTokenID string, newRefreshToken string, expiration time.Time, err error) {
- // generate tokens via token exchange flow if request is relevant
- if teReq, ok := request.(op.TokenExchangeRequest); ok {
- return s.exchangeRefreshToken(ctx, teReq)
- }
-
// get the information depending on the request type / implementation
applicationID, authTime, amr := getInfoFromRequest(request)
@@ -298,36 +215,14 @@ func (s *Storage) CreateAccessAndRefreshTokens(ctx context.Context, request op.T
// if we get here, the currentRefreshToken was not empty, so the call is a refresh token request
// we therefore will have to check the currentRefreshToken and renew the refresh token
-
- newRefreshToken = uuid.NewString()
-
- accessToken, err := s.accessToken(applicationID, newRefreshToken, request.GetSubject(), request.GetAudience(), request.GetScopes())
+ refreshToken, refreshTokenID, err := s.renewRefreshToken(currentRefreshToken)
if err != nil {
return "", "", time.Time{}, err
}
-
- if err := s.renewRefreshToken(currentRefreshToken, newRefreshToken, accessToken.ID); err != nil {
- return "", "", time.Time{}, err
- }
-
- return accessToken.ID, newRefreshToken, accessToken.Expiration, nil
-}
-
-func (s *Storage) exchangeRefreshToken(ctx context.Context, request op.TokenExchangeRequest) (accessTokenID string, newRefreshToken string, expiration time.Time, err error) {
- applicationID := request.GetClientID()
- authTime := request.GetAuthTime()
-
- refreshTokenID := uuid.NewString()
accessToken, err := s.accessToken(applicationID, refreshTokenID, request.GetSubject(), request.GetAudience(), request.GetScopes())
if err != nil {
return "", "", time.Time{}, err
}
-
- refreshToken, err := s.createRefreshToken(accessToken, nil, authTime)
- if err != nil {
- return "", "", time.Time{}, err
- }
-
return accessToken.ID, refreshToken, accessToken.Expiration, nil
}
@@ -357,16 +252,6 @@ func (s *Storage) TerminateSession(ctx context.Context, userID string, clientID
return nil
}
-// GetRefreshTokenInfo looks up a refresh token and returns the token id and user id.
-// If given something that is not a refresh token, it must return error.
-func (s *Storage) GetRefreshTokenInfo(ctx context.Context, clientID string, token string) (userID string, tokenID string, err error) {
- refreshToken, ok := s.refreshTokens[token]
- if !ok {
- return "", "", op.ErrInvalidRefreshToken
- }
- return refreshToken.UserID, refreshToken.ID, nil
-}
-
// RevokeToken implements the op.Storage interface
// it will be called after parsing and validation of the token revocation request
func (s *Storage) RevokeToken(ctx context.Context, tokenIDOrToken string, userID string, clientID string) *oidc.Error {
@@ -392,35 +277,52 @@ func (s *Storage) RevokeToken(ctx context.Context, tokenIDOrToken string, userID
if refreshToken.ApplicationID != clientID {
return oidc.ErrInvalidClient().WithDescription("token was not issued for this client")
}
- delete(s.refreshTokens, refreshToken.ID)
// if it is a refresh token, you will have to remove the access token as well
- delete(s.tokens, refreshToken.AccessToken)
+ delete(s.refreshTokens, refreshToken.ID)
+ for _, accessToken := range s.tokens {
+ if accessToken.RefreshTokenID == refreshToken.ID {
+ delete(s.tokens, accessToken.ID)
+ return nil
+ }
+ }
return nil
}
-// SigningKey implements the op.Storage interface
+// GetSigningKey implements the op.Storage interface
// it will be called when creating the OpenID Provider
-func (s *Storage) SigningKey(ctx context.Context) (op.SigningKey, error) {
+func (s *Storage) GetSigningKey(ctx context.Context, keyCh chan<- jose.SigningKey) {
// in this example the signing key is a static rsa.PrivateKey and the algorithm used is RS256
// you would obviously have a more complex implementation and store / retrieve the key from your database as well
- return &s.signingKey, nil
+ //
+ // the idea of the signing key channel is, that you can (with what ever mechanism) rotate your signing key and
+ // switch the key of the signer via this channel
+ keyCh <- jose.SigningKey{
+ Algorithm: jose.SignatureAlgorithm(s.signingKey.Algorithm), // always tell the signer with algorithm to use
+ Key: jose.JSONWebKey{
+ KeyID: s.signingKey.ID, // always give the key an id so, that it will include it in the token header as `kid` claim
+ Key: s.signingKey.Key,
+ },
+ }
}
-// SignatureAlgorithms implements the op.Storage interface
-// it will be called to get the sign
-func (s *Storage) SignatureAlgorithms(context.Context) ([]jose.SignatureAlgorithm, error) {
- return []jose.SignatureAlgorithm{s.signingKey.algorithm}, nil
-}
-
-// KeySet implements the op.Storage interface
+// GetKeySet implements the op.Storage interface
// it will be called to get the current (public) keys, among others for the keys_endpoint or for validating access_tokens on the userinfo_endpoint, ...
-func (s *Storage) KeySet(ctx context.Context) ([]op.Key, error) {
+func (s *Storage) GetKeySet(ctx context.Context) (*jose.JSONWebKeySet, error) {
// as mentioned above, this example only has a single signing key without key rotation,
// so it will directly use its public key
//
// when using key rotation you typically would store the public keys alongside the private keys in your database
- // and give both of them an expiration date, with the public key having a longer lifetime
- return []op.Key{&publicKey{s.signingKey}}, nil
+ // and give both of them an expiration date, with the public key having a longer lifetime (e.g. rotate private key every
+ return &jose.JSONWebKeySet{
+ Keys: []jose.JSONWebKey{
+ {
+ KeyID: s.signingKey.ID,
+ Algorithm: s.signingKey.Algorithm,
+ Use: oidc.KeyUseSignature,
+ Key: &s.signingKey.Key.PublicKey,
+ },
+ },
+ }, nil
}
// GetClientByClientID implements the op.Storage interface
@@ -432,7 +334,7 @@ func (s *Storage) GetClientByClientID(ctx context.Context, clientID string) (op.
if !ok {
return nil, fmt.Errorf("client not found")
}
- return RedirectGlobsClient(client), nil
+ return client, nil
}
// AuthorizeClientIDSecret implements the op.Storage interface
@@ -452,22 +354,15 @@ func (s *Storage) AuthorizeClientIDSecret(ctx context.Context, clientID, clientS
return nil
}
-// SetUserinfoFromScopes implements the op.Storage interface.
-// Provide an empty implementation and use SetUserinfoFromRequest instead.
-func (s *Storage) SetUserinfoFromScopes(ctx context.Context, userinfo *oidc.UserInfo, userID, clientID string, scopes []string) error {
- return nil
-}
-
-// SetUserinfoFromRequests implements the op.CanSetUserinfoFromRequest interface. In the
-// next major release, it will be required for op.Storage.
-// It will be called for the creation of an id_token, so we'll just pass it to the private function without any further check
-func (s *Storage) SetUserinfoFromRequest(ctx context.Context, userinfo *oidc.UserInfo, token op.IDTokenRequest, scopes []string) error {
- return s.setUserinfo(ctx, userinfo, token.GetSubject(), token.GetClientID(), scopes)
+// SetUserinfoFromScopes implements the op.Storage interface
+// it will be called for the creation of an id_token, so we'll just pass it to the private function without any further check
+func (s *Storage) SetUserinfoFromScopes(ctx context.Context, userinfo oidc.UserInfoSetter, userID, clientID string, scopes []string) error {
+ return s.setUserinfo(ctx, userinfo, userID, clientID, scopes)
}
// SetUserinfoFromToken implements the op.Storage interface
// it will be called for the userinfo endpoint, so we read the token and pass the information from that to the private function
-func (s *Storage) SetUserinfoFromToken(ctx context.Context, userinfo *oidc.UserInfo, tokenID, subject, origin string) error {
+func (s *Storage) SetUserinfoFromToken(ctx context.Context, userinfo oidc.UserInfoSetter, tokenID, subject, origin string) error {
token, ok := func() (*Token, bool) {
s.lock.Lock()
defer s.lock.Unlock()
@@ -490,15 +385,12 @@ func (s *Storage) SetUserinfoFromToken(ctx context.Context, userinfo *oidc.UserI
// return err
// }
//}
- if token.Expiration.Before(time.Now()) {
- return fmt.Errorf("token is expired")
- }
return s.setUserinfo(ctx, userinfo, token.Subject, token.ApplicationID, token.Scopes)
}
// SetIntrospectionFromToken implements the op.Storage interface
// it will be called for the introspection endpoint, so we read the token and pass the information from that to the private function
-func (s *Storage) SetIntrospectionFromToken(ctx context.Context, introspection *oidc.IntrospectionResponse, tokenID, subject, clientID string) error {
+func (s *Storage) SetIntrospectionFromToken(ctx context.Context, introspection oidc.IntrospectionResponse, tokenID, subject, clientID string) error {
token, ok := func() (*Token, bool) {
s.lock.Lock()
defer s.lock.Unlock()
@@ -515,17 +407,14 @@ func (s *Storage) SetIntrospectionFromToken(ctx context.Context, introspection *
// this will automatically be done by the library if you don't return an error
// you can also return further information about the user / associated token
// e.g. the userinfo (equivalent to userinfo endpoint)
-
- userInfo := new(oidc.UserInfo)
- err := s.setUserinfo(ctx, userInfo, subject, clientID, token.Scopes)
+ err := s.setUserinfo(ctx, introspection, subject, clientID, token.Scopes)
if err != nil {
return err
}
- introspection.SetUserInfo(userInfo)
//...and also the requested scopes...
- introspection.Scope = token.Scopes
+ introspection.SetScopes(token.Scopes)
//...and the client the token was issued to
- introspection.ClientID = token.ApplicationID
+ introspection.SetClientID(token.ApplicationID)
return nil
}
}
@@ -534,11 +423,7 @@ func (s *Storage) SetIntrospectionFromToken(ctx context.Context, introspection *
// GetPrivateClaimsFromScopes implements the op.Storage interface
// it will be called for the creation of a JWT access token to assert claims for custom scopes
-func (s *Storage) GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]any, err error) {
- return s.getPrivateClaimsFromScopes(ctx, userID, clientID, scopes)
-}
-
-func (s *Storage) getPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]any, err error) {
+func (s *Storage) GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]interface{}, err error) {
for _, scope := range scopes {
switch scope {
case CustomScope:
@@ -548,9 +433,9 @@ func (s *Storage) getPrivateClaimsFromScopes(ctx context.Context, userID, client
return claims, nil
}
-// GetKeyByIDAndClientID implements the op.Storage interface
+// GetKeyByIDAndUserID implements the op.Storage interface
// it will be called to validate the signatures of a JWT (JWT Profile Grant and Authentication)
-func (s *Storage) GetKeyByIDAndClientID(ctx context.Context, keyID, clientID string) (*jose.JSONWebKey, error) {
+func (s *Storage) GetKeyByIDAndUserID(ctx context.Context, keyID, clientID string) (*jose.JSONWebKey, error) {
s.lock.Lock()
defer s.lock.Unlock()
service, ok := s.services[clientID]
@@ -599,41 +484,33 @@ func (s *Storage) createRefreshToken(accessToken *Token, amr []string, authTime
Audience: accessToken.Audience,
Expiration: time.Now().Add(5 * time.Hour),
Scopes: accessToken.Scopes,
- AccessToken: accessToken.ID,
}
s.refreshTokens[token.ID] = token
return token.Token, nil
}
// renewRefreshToken checks the provided refresh_token and creates a new one based on the current
-//
-// [Refresh Token Rotation] is implemented.
-//
-// [Refresh Token Rotation]: https://www.rfc-editor.org/rfc/rfc6819#section-5.2.2.3
-func (s *Storage) renewRefreshToken(currentRefreshToken, newRefreshToken, newAccessToken string) error {
+func (s *Storage) renewRefreshToken(currentRefreshToken string) (string, string, error) {
s.lock.Lock()
defer s.lock.Unlock()
refreshToken, ok := s.refreshTokens[currentRefreshToken]
if !ok {
- return fmt.Errorf("invalid refresh token")
+ return "", "", fmt.Errorf("invalid refresh token")
}
- // deletes the refresh token
+ // deletes the refresh token and all access tokens which were issued based on this refresh token
delete(s.refreshTokens, currentRefreshToken)
-
- // delete the access token which was issued based on this refresh token
- delete(s.tokens, refreshToken.AccessToken)
-
- if refreshToken.Expiration.Before(time.Now()) {
- return fmt.Errorf("expired refresh token")
+ for _, token := range s.tokens {
+ if token.RefreshTokenID == currentRefreshToken {
+ delete(s.tokens, token.ID)
+ break
+ }
}
-
// creates a new refresh token based on the current one
- refreshToken.Token = newRefreshToken
- refreshToken.ID = newRefreshToken
- refreshToken.Expiration = time.Now().Add(5 * time.Hour)
- refreshToken.AccessToken = newAccessToken
- s.refreshTokens[newRefreshToken] = refreshToken
- return nil
+ token := uuid.NewString()
+ refreshToken.Token = token
+ refreshToken.ID = token
+ s.refreshTokens[token] = refreshToken
+ return token, refreshToken.ID, nil
}
// accessToken will store an access_token in-memory based on the provided information
@@ -654,7 +531,7 @@ func (s *Storage) accessToken(applicationID, refreshTokenID, subject string, aud
}
// setUserinfo sets the info based on the user, scopes and if necessary the clientID
-func (s *Storage) setUserinfo(ctx context.Context, userInfo *oidc.UserInfo, userID, clientID string, scopes []string) (err error) {
+func (s *Storage) setUserinfo(ctx context.Context, userInfo oidc.UserInfoSetter, userID, clientID string, scopes []string) (err error) {
s.lock.Lock()
defer s.lock.Unlock()
user := s.userStore.GetUserByID(userID)
@@ -664,19 +541,17 @@ func (s *Storage) setUserinfo(ctx context.Context, userInfo *oidc.UserInfo, user
for _, scope := range scopes {
switch scope {
case oidc.ScopeOpenID:
- userInfo.Subject = user.ID
+ userInfo.SetSubject(user.ID)
case oidc.ScopeEmail:
- userInfo.Email = user.Email
- userInfo.EmailVerified = oidc.Bool(user.EmailVerified)
+ userInfo.SetEmail(user.Email, user.EmailVerified)
case oidc.ScopeProfile:
- userInfo.PreferredUsername = user.Username
- userInfo.Name = user.FirstName + " " + user.LastName
- userInfo.FamilyName = user.LastName
- userInfo.GivenName = user.FirstName
- userInfo.Locale = oidc.NewLocale(user.PreferredLanguage)
+ userInfo.SetPreferredUsername(user.Username)
+ userInfo.SetName(user.FirstName + " " + user.LastName)
+ userInfo.SetFamilyName(user.LastName)
+ userInfo.SetGivenName(user.FirstName)
+ userInfo.SetLocale(user.PreferredLanguage)
case oidc.ScopePhone:
- userInfo.PhoneNumber = user.Phone
- userInfo.PhoneNumberVerified = user.PhoneVerified
+ userInfo.SetPhone(user.Phone, user.PhoneVerified)
case CustomScope:
// you can also have a custom scope and assert public or custom claims based on that
userInfo.AppendClaims(CustomClaim, customClaim(clientID))
@@ -685,101 +560,6 @@ func (s *Storage) setUserinfo(ctx context.Context, userInfo *oidc.UserInfo, user
return nil
}
-// ValidateTokenExchangeRequest implements the op.TokenExchangeStorage interface
-// it will be called to validate parsed Token Exchange Grant request
-func (s *Storage) ValidateTokenExchangeRequest(ctx context.Context, request op.TokenExchangeRequest) error {
- if request.GetRequestedTokenType() == "" {
- request.SetRequestedTokenType(oidc.RefreshTokenType)
- }
-
- // Just an example, some use cases might need this use case
- if request.GetExchangeSubjectTokenType() == oidc.IDTokenType && request.GetRequestedTokenType() == oidc.RefreshTokenType {
- return errors.New("exchanging id_token to refresh_token is not supported")
- }
-
- // Check impersonation permissions
- if request.GetExchangeActor() == "" && !s.userStore.GetUserByID(request.GetExchangeSubject()).IsAdmin {
- return errors.New("user doesn't have impersonation permission")
- }
-
- allowedScopes := make([]string, 0)
- for _, scope := range request.GetScopes() {
- if scope == oidc.ScopeAddress {
- continue
- }
-
- if strings.HasPrefix(scope, CustomScopeImpersonatePrefix) {
- subject := strings.TrimPrefix(scope, CustomScopeImpersonatePrefix)
- request.SetSubject(subject)
- }
-
- allowedScopes = append(allowedScopes, scope)
- }
-
- request.SetCurrentScopes(allowedScopes)
-
- return nil
-}
-
-// ValidateTokenExchangeRequest implements the op.TokenExchangeStorage interface
-// Common use case is to store request for audit purposes. For this example we skip the storing.
-func (s *Storage) CreateTokenExchangeRequest(ctx context.Context, request op.TokenExchangeRequest) error {
- return nil
-}
-
-// GetPrivateClaimsFromScopesForTokenExchange implements the op.TokenExchangeStorage interface
-// it will be called for the creation of an exchanged JWT access token to assert claims for custom scopes
-// plus adding token exchange specific claims related to delegation or impersonation
-func (s *Storage) GetPrivateClaimsFromTokenExchangeRequest(ctx context.Context, request op.TokenExchangeRequest) (claims map[string]any, err error) {
- claims, err = s.getPrivateClaimsFromScopes(ctx, "", request.GetClientID(), request.GetScopes())
- if err != nil {
- return nil, err
- }
-
- for k, v := range s.getTokenExchangeClaims(ctx, request) {
- claims = appendClaim(claims, k, v)
- }
-
- return claims, nil
-}
-
-// SetUserinfoFromScopesForTokenExchange implements the op.TokenExchangeStorage interface
-// it will be called for the creation of an id_token - we are using the same private function as for other flows,
-// plus adding token exchange specific claims related to delegation or impersonation
-func (s *Storage) SetUserinfoFromTokenExchangeRequest(ctx context.Context, userinfo *oidc.UserInfo, request op.TokenExchangeRequest) error {
- err := s.setUserinfo(ctx, userinfo, request.GetSubject(), request.GetClientID(), request.GetScopes())
- if err != nil {
- return err
- }
-
- for k, v := range s.getTokenExchangeClaims(ctx, request) {
- userinfo.AppendClaims(k, v)
- }
-
- return nil
-}
-
-func (s *Storage) getTokenExchangeClaims(ctx context.Context, request op.TokenExchangeRequest) (claims map[string]any) {
- for _, scope := range request.GetScopes() {
- switch {
- case strings.HasPrefix(scope, CustomScopeImpersonatePrefix) && request.GetExchangeActor() == "":
- // Set actor subject claim for impersonation flow
- claims = appendClaim(claims, "act", map[string]any{
- "sub": request.GetExchangeSubject(),
- })
- }
- }
-
- // Set actor subject claim for delegation flow
- // if request.GetExchangeActor() != "" {
- // claims = appendClaim(claims, "act", map[string]any{
- // "sub": request.GetExchangeActor(),
- // })
- // }
-
- return claims
-}
-
// getInfoFromRequest returns the clientID, authTime and amr depending on the op.TokenRequest type / implementation
func getInfoFromRequest(req op.TokenRequest) (clientID string, authTime time.Time, amr []string) {
authReq, ok := req.(*AuthRequest) // Code Flow (with scope offline_access)
@@ -794,140 +574,17 @@ func getInfoFromRequest(req op.TokenRequest) (clientID string, authTime time.Tim
}
// customClaim demonstrates how to return custom claims based on provided information
-func customClaim(clientID string) map[string]any {
- return map[string]any{
+func customClaim(clientID string) map[string]interface{} {
+ return map[string]interface{}{
"client": clientID,
"other": "stuff",
}
}
-func appendClaim(claims map[string]any, claim string, value any) map[string]any {
+func appendClaim(claims map[string]interface{}, claim string, value interface{}) map[string]interface{} {
if claims == nil {
- claims = make(map[string]any)
+ claims = make(map[string]interface{})
}
claims[claim] = value
return claims
}
-
-type deviceAuthorizationEntry struct {
- deviceCode string
- userCode string
- state *op.DeviceAuthorizationState
-}
-
-func (s *Storage) StoreDeviceAuthorization(ctx context.Context, clientID, deviceCode, userCode string, expires time.Time, scopes []string) error {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- if _, ok := s.clients[clientID]; !ok {
- return errors.New("client not found")
- }
-
- if _, ok := s.userCodes[userCode]; ok {
- return op.ErrDuplicateUserCode
- }
-
- s.deviceCodes[deviceCode] = deviceAuthorizationEntry{
- deviceCode: deviceCode,
- userCode: userCode,
- state: &op.DeviceAuthorizationState{
- ClientID: clientID,
- Scopes: scopes,
- Expires: expires,
- },
- }
-
- s.userCodes[userCode] = deviceCode
- return nil
-}
-
-func (s *Storage) GetDeviceAuthorizatonState(ctx context.Context, clientID, deviceCode string) (*op.DeviceAuthorizationState, error) {
- if ctx.Err() != nil {
- return nil, ctx.Err()
- }
-
- s.lock.Lock()
- defer s.lock.Unlock()
-
- entry, ok := s.deviceCodes[deviceCode]
- if !ok || entry.state.ClientID != clientID {
- return nil, errors.New("device code not found for client") // is there a standard not found error in the framework?
- }
-
- return entry.state, nil
-}
-
-func (s *Storage) GetDeviceAuthorizationByUserCode(ctx context.Context, userCode string) (*op.DeviceAuthorizationState, error) {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- entry, ok := s.deviceCodes[s.userCodes[userCode]]
- if !ok {
- return nil, errors.New("user code not found")
- }
-
- return entry.state, nil
-}
-
-func (s *Storage) CompleteDeviceAuthorization(ctx context.Context, userCode, subject string) error {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- entry, ok := s.deviceCodes[s.userCodes[userCode]]
- if !ok {
- return errors.New("user code not found")
- }
-
- entry.state.Subject = subject
- entry.state.Done = true
- return nil
-}
-
-func (s *Storage) DenyDeviceAuthorization(ctx context.Context, userCode string) error {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- s.deviceCodes[s.userCodes[userCode]].state.Denied = true
- return nil
-}
-
-// AuthRequestDone is used by testing and is not required to implement op.Storage
-func (s *Storage) AuthRequestDone(id string) error {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- if req, ok := s.authRequests[id]; ok {
- req.done = true
- return nil
- }
-
- return errors.New("request not found")
-}
-
-func (s *Storage) ClientCredentials(ctx context.Context, clientID, clientSecret string) (op.Client, error) {
- s.lock.Lock()
- defer s.lock.Unlock()
-
- client, ok := s.serviceUsers[clientID]
- if !ok {
- return nil, errors.New("wrong service user or password")
- }
- if client.secret != clientSecret {
- return nil, errors.New("wrong service user or password")
- }
-
- return client, nil
-}
-
-func (s *Storage) ClientCredentialsTokenRequest(ctx context.Context, clientID string, scopes []string) (op.TokenRequest, error) {
- client, ok := s.serviceUsers[clientID]
- if !ok {
- return nil, errors.New("wrong service user or password")
- }
-
- return &oidc.JWTTokenRequest{
- Subject: client.id,
- Audience: []string{clientID},
- Scopes: scopes,
- }, nil
-}
diff --git a/example/server/storage/storage_dynamic.go b/example/server/storage/storage_dynamic.go
deleted file mode 100644
index 765d29a..0000000
--- a/example/server/storage/storage_dynamic.go
+++ /dev/null
@@ -1,281 +0,0 @@
-package storage
-
-import (
- "context"
- "time"
-
- jose "github.com/go-jose/go-jose/v4"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
-)
-
-type multiStorage struct {
- issuers map[string]*Storage
-}
-
-// NewMultiStorage implements the op.Storage interface by wrapping multiple storage structs
-// and selecting them by the calling issuer
-func NewMultiStorage(issuers []string) *multiStorage {
- s := make(map[string]*Storage)
- for _, issuer := range issuers {
- s[issuer] = NewStorage(NewUserStore(issuer))
- }
- return &multiStorage{issuers: s}
-}
-
-// CheckUsernamePassword implements the `authenticate` interface of the login
-func (s *multiStorage) CheckUsernamePassword(ctx context.Context, username, password, id string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.CheckUsernamePassword(username, password, id)
-}
-
-// CreateAuthRequest implements the op.Storage interface
-// it will be called after parsing and validation of the authentication request
-func (s *multiStorage) CreateAuthRequest(ctx context.Context, authReq *oidc.AuthRequest, userID string) (op.AuthRequest, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.CreateAuthRequest(ctx, authReq, userID)
-}
-
-// AuthRequestByID implements the op.Storage interface
-// it will be called after the Login UI redirects back to the OIDC endpoint
-func (s *multiStorage) AuthRequestByID(ctx context.Context, id string) (op.AuthRequest, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.AuthRequestByID(ctx, id)
-}
-
-// AuthRequestByCode implements the op.Storage interface
-// it will be called after parsing and validation of the token request (in an authorization code flow)
-func (s *multiStorage) AuthRequestByCode(ctx context.Context, code string) (op.AuthRequest, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.AuthRequestByCode(ctx, code)
-}
-
-// SaveAuthCode implements the op.Storage interface
-// it will be called after the authentication has been successful and before redirecting the user agent to the redirect_uri
-// (in an authorization code flow)
-func (s *multiStorage) SaveAuthCode(ctx context.Context, id string, code string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.SaveAuthCode(ctx, id, code)
-}
-
-// DeleteAuthRequest implements the op.Storage interface
-// it will be called after creating the token response (id and access tokens) for a valid
-// - authentication request (in an implicit flow)
-// - token request (in an authorization code flow)
-func (s *multiStorage) DeleteAuthRequest(ctx context.Context, id string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.DeleteAuthRequest(ctx, id)
-}
-
-// CreateAccessToken implements the op.Storage interface
-// it will be called for all requests able to return an access token (Authorization Code Flow, Implicit Flow, JWT Profile, ...)
-func (s *multiStorage) CreateAccessToken(ctx context.Context, request op.TokenRequest) (string, time.Time, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return "", time.Time{}, err
- }
- return storage.CreateAccessToken(ctx, request)
-}
-
-// CreateAccessAndRefreshTokens implements the op.Storage interface
-// it will be called for all requests able to return an access and refresh token (Authorization Code Flow, Refresh Token Request)
-func (s *multiStorage) CreateAccessAndRefreshTokens(ctx context.Context, request op.TokenRequest, currentRefreshToken string) (accessTokenID string, newRefreshToken string, expiration time.Time, err error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return "", "", time.Time{}, err
- }
- return storage.CreateAccessAndRefreshTokens(ctx, request, currentRefreshToken)
-}
-
-// TokenRequestByRefreshToken implements the op.Storage interface
-// it will be called after parsing and validation of the refresh token request
-func (s *multiStorage) TokenRequestByRefreshToken(ctx context.Context, refreshToken string) (op.RefreshTokenRequest, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.TokenRequestByRefreshToken(ctx, refreshToken)
-}
-
-// TerminateSession implements the op.Storage interface
-// it will be called after the user signed out, therefore the access and refresh token of the user of this client must be removed
-func (s *multiStorage) TerminateSession(ctx context.Context, userID string, clientID string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.TerminateSession(ctx, userID, clientID)
-}
-
-// GetRefreshTokenInfo looks up a refresh token and returns the token id and user id.
-// If given something that is not a refresh token, it must return error.
-func (s *multiStorage) GetRefreshTokenInfo(ctx context.Context, clientID string, token string) (userID string, tokenID string, err error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return "", "", err
- }
- return storage.GetRefreshTokenInfo(ctx, clientID, token)
-}
-
-// RevokeToken implements the op.Storage interface
-// it will be called after parsing and validation of the token revocation request
-func (s *multiStorage) RevokeToken(ctx context.Context, token string, userID string, clientID string) *oidc.Error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.RevokeToken(ctx, token, userID, clientID)
-}
-
-// SigningKey implements the op.Storage interface
-// it will be called when creating the OpenID Provider
-func (s *multiStorage) SigningKey(ctx context.Context) (op.SigningKey, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.SigningKey(ctx)
-}
-
-// SignatureAlgorithms implements the op.Storage interface
-// it will be called to get the sign
-func (s *multiStorage) SignatureAlgorithms(ctx context.Context) ([]jose.SignatureAlgorithm, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.SignatureAlgorithms(ctx)
-}
-
-// KeySet implements the op.Storage interface
-// it will be called to get the current (public) keys, among others for the keys_endpoint or for validating access_tokens on the userinfo_endpoint, ...
-func (s *multiStorage) KeySet(ctx context.Context) ([]op.Key, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.KeySet(ctx)
-}
-
-// GetClientByClientID implements the op.Storage interface
-// it will be called whenever information (type, redirect_uris, ...) about the client behind the client_id is needed
-func (s *multiStorage) GetClientByClientID(ctx context.Context, clientID string) (op.Client, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.GetClientByClientID(ctx, clientID)
-}
-
-// AuthorizeClientIDSecret implements the op.Storage interface
-// it will be called for validating the client_id, client_secret on token or introspection requests
-func (s *multiStorage) AuthorizeClientIDSecret(ctx context.Context, clientID, clientSecret string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.AuthorizeClientIDSecret(ctx, clientID, clientSecret)
-}
-
-// SetUserinfoFromScopes implements the op.Storage interface.
-// Provide an empty implementation and use SetUserinfoFromRequest instead.
-func (s *multiStorage) SetUserinfoFromScopes(ctx context.Context, userinfo *oidc.UserInfo, userID, clientID string, scopes []string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.SetUserinfoFromScopes(ctx, userinfo, userID, clientID, scopes)
-}
-
-// SetUserinfoFromRequests implements the op.CanSetUserinfoFromRequest interface. In the
-// next major release, it will be required for op.Storage.
-// It will be called for the creation of an id_token, so we'll just pass it to the private function without any further check
-func (s *multiStorage) SetUserinfoFromRequest(ctx context.Context, userinfo *oidc.UserInfo, token op.IDTokenRequest, scopes []string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.SetUserinfoFromRequest(ctx, userinfo, token, scopes)
-}
-
-// SetUserinfoFromToken implements the op.Storage interface
-// it will be called for the userinfo endpoint, so we read the token and pass the information from that to the private function
-func (s *multiStorage) SetUserinfoFromToken(ctx context.Context, userinfo *oidc.UserInfo, tokenID, subject, origin string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.SetUserinfoFromToken(ctx, userinfo, tokenID, subject, origin)
-}
-
-// SetIntrospectionFromToken implements the op.Storage interface
-// it will be called for the introspection endpoint, so we read the token and pass the information from that to the private function
-func (s *multiStorage) SetIntrospectionFromToken(ctx context.Context, introspection *oidc.IntrospectionResponse, tokenID, subject, clientID string) error {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return err
- }
- return storage.SetIntrospectionFromToken(ctx, introspection, tokenID, subject, clientID)
-}
-
-// GetPrivateClaimsFromScopes implements the op.Storage interface
-// it will be called for the creation of a JWT access token to assert claims for custom scopes
-func (s *multiStorage) GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]any, err error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.GetPrivateClaimsFromScopes(ctx, userID, clientID, scopes)
-}
-
-// GetKeyByIDAndClientID implements the op.Storage interface
-// it will be called to validate the signatures of a JWT (JWT Profile Grant and Authentication)
-func (s *multiStorage) GetKeyByIDAndClientID(ctx context.Context, keyID, userID string) (*jose.JSONWebKey, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.GetKeyByIDAndClientID(ctx, keyID, userID)
-}
-
-// ValidateJWTProfileScopes implements the op.Storage interface
-// it will be called to validate the scopes of a JWT Profile Authorization Grant request
-func (s *multiStorage) ValidateJWTProfileScopes(ctx context.Context, userID string, scopes []string) ([]string, error) {
- storage, err := s.storageFromContext(ctx)
- if err != nil {
- return nil, err
- }
- return storage.ValidateJWTProfileScopes(ctx, userID, scopes)
-}
-
-// Health implements the op.Storage interface
-func (s *multiStorage) Health(ctx context.Context) error {
- return nil
-}
-
-func (s *multiStorage) storageFromContext(ctx context.Context) (*Storage, *oidc.Error) {
- storage, ok := s.issuers[op.IssuerFromContext(ctx)]
- if !ok {
- return nil, oidc.ErrInvalidRequest().WithDescription("invalid issuer")
- }
- return storage, nil
-}
diff --git a/example/server/storage/token.go b/example/server/storage/token.go
index beab38c..ad907e3 100644
--- a/example/server/storage/token.go
+++ b/example/server/storage/token.go
@@ -22,5 +22,4 @@ type RefreshToken struct {
ApplicationID string
Expiration time.Time
Scopes []string
- AccessToken string // Token.ID
}
diff --git a/example/server/storage/user.go b/example/server/storage/user.go
index ed8cdfa..423af59 100644
--- a/example/server/storage/user.go
+++ b/example/server/storage/user.go
@@ -2,9 +2,6 @@ package storage
import (
"crypto/rsa"
- "encoding/json"
- "os"
- "strings"
"golang.org/x/text/language"
)
@@ -20,7 +17,6 @@ type User struct {
Phone string
PhoneVerified bool
PreferredLanguage language.Tag
- IsAdmin bool
}
type Service struct {
@@ -37,25 +33,12 @@ type userStore struct {
users map[string]*User
}
-func StoreFromFile(path string) (UserStore, error) {
- users := map[string]*User{}
- data, err := os.ReadFile(path)
- if err != nil {
- return nil, err
- }
- if err := json.Unmarshal(data, &users); err != nil {
- return nil, err
- }
- return userStore{users}, nil
-}
-
-func NewUserStore(issuer string) UserStore {
- hostname := strings.Split(strings.Split(issuer, "://")[1], ":")[0]
+func NewUserStore() UserStore {
return userStore{
users: map[string]*User{
"id1": {
ID: "id1",
- Username: "test-user@" + hostname,
+ Username: "test-user",
Password: "verysecure",
FirstName: "Test",
LastName: "User",
@@ -64,20 +47,6 @@ func NewUserStore(issuer string) UserStore {
Phone: "",
PhoneVerified: false,
PreferredLanguage: language.German,
- IsAdmin: true,
- },
- "id2": {
- ID: "id2",
- Username: "test-user2",
- Password: "verysecure",
- FirstName: "Test",
- LastName: "User2",
- Email: "test-user2@zitadel.ch",
- EmailVerified: true,
- Phone: "",
- PhoneVerified: false,
- PreferredLanguage: language.German,
- IsAdmin: false,
},
},
}
diff --git a/example/server/storage/user_test.go b/example/server/storage/user_test.go
deleted file mode 100644
index c2e2212..0000000
--- a/example/server/storage/user_test.go
+++ /dev/null
@@ -1,70 +0,0 @@
-package storage
-
-import (
- "os"
- "path"
- "reflect"
- "testing"
-
- "golang.org/x/text/language"
-)
-
-func TestStoreFromFile(t *testing.T) {
- for _, tc := range []struct {
- name string
- pathToFile string
- content string
- want UserStore
- wantErr bool
- }{
- {
- name: "normal user file",
- pathToFile: "userfile.json",
- content: `{
- "id1": {
- "ID": "id1",
- "EmailVerified": true,
- "PreferredLanguage": "DE"
- }
- }`,
- want: userStore{map[string]*User{
- "id1": {
- ID: "id1",
- EmailVerified: true,
- PreferredLanguage: language.German,
- },
- }},
- },
- {
- name: "malformed file",
- pathToFile: "whatever",
- content: "not a json just a text",
- wantErr: true,
- },
- {
- name: "not existing file",
- pathToFile: "what/ever/file",
- wantErr: true,
- },
- } {
- t.Run(tc.name, func(t *testing.T) {
- actualPath := path.Join(t.TempDir(), tc.pathToFile)
-
- if tc.content != "" && tc.pathToFile != "" {
- if err := os.WriteFile(actualPath, []byte(tc.content), 0666); err != nil {
- t.Fatalf("cannot create file with test content: %q", tc.content)
- }
- }
- result, err := StoreFromFile(actualPath)
- if err != nil && !tc.wantErr {
- t.Errorf("StoreFromFile(%q) returned unexpected error %q", tc.pathToFile, err)
- } else if err == nil && tc.wantErr {
- t.Errorf("StoreFromFile(%q) did not return an expected error", tc.pathToFile)
- }
- if !tc.wantErr && !reflect.DeepEqual(tc.want, result.(userStore)) {
- t.Errorf("expected StoreFromFile(%q) = %v, but got %v",
- tc.pathToFile, tc.want, result)
- }
- })
- }
-}
diff --git a/go.mod b/go.mod
index a0f42c4..306a379 100644
--- a/go.mod
+++ b/go.mod
@@ -1,40 +1,35 @@
-module git.christmann.info/LARA/zitadel-oidc/v3
+module github.com/zitadel/oidc
-go 1.23.7
-
-toolchain go1.24.1
+go 1.18
require (
- github.com/bmatcuk/doublestar/v4 v4.8.1
- github.com/go-chi/chi/v5 v5.2.1
- github.com/go-jose/go-jose/v4 v4.0.5
github.com/golang/mock v1.6.0
github.com/google/go-github/v31 v31.0.0
- github.com/google/uuid v1.6.0
- github.com/gorilla/securecookie v1.1.2
- github.com/jeremija/gosubmit v0.2.8
- github.com/muhlemmer/gu v0.3.1
- github.com/muhlemmer/httpforwarded v0.1.0
- github.com/rs/cors v1.11.1
+ github.com/google/uuid v1.3.1
+ github.com/gorilla/mux v1.8.0
+ github.com/gorilla/schema v1.2.0
+ github.com/gorilla/securecookie v1.1.1
+ github.com/jeremija/gosubmit v0.2.7
+ github.com/rs/cors v1.10.1
github.com/sirupsen/logrus v1.9.3
- github.com/stretchr/testify v1.10.0
- github.com/zitadel/logging v0.6.2
- github.com/zitadel/schema v1.3.1
- go.opentelemetry.io/otel v1.29.0
- golang.org/x/oauth2 v0.30.0
- golang.org/x/text v0.26.0
+ github.com/stretchr/testify v1.8.2
+ github.com/zitadel/logging v0.3.4
+ golang.org/x/oauth2 v0.13.0
+ golang.org/x/text v0.13.0
+ gopkg.in/square/go-jose.v2 v2.6.0
)
require (
github.com/davecgh/go-spew v1.1.1 // indirect
- github.com/go-logr/logr v1.4.2 // indirect
- github.com/go-logr/stdr v1.2.2 // indirect
+ github.com/golang/protobuf v1.5.3 // indirect
github.com/google/go-querystring v1.1.0 // indirect
+ github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
- go.opentelemetry.io/otel/metric v1.29.0 // indirect
- go.opentelemetry.io/otel/trace v1.29.0 // indirect
- golang.org/x/crypto v0.36.0 // indirect
- golang.org/x/net v0.38.0 // indirect
- golang.org/x/sys v0.31.0 // indirect
+ golang.org/x/crypto v0.14.0 // indirect
+ golang.org/x/net v0.17.0 // indirect
+ golang.org/x/sys v0.13.0 // indirect
+ google.golang.org/appengine v1.6.8 // indirect
+ google.golang.org/protobuf v1.31.0 // indirect
+ gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
diff --git a/go.sum b/go.sum
index 4835505..d356f35 100644
--- a/go.sum
+++ b/go.sum
@@ -1,108 +1,124 @@
-github.com/bmatcuk/doublestar/v4 v4.8.1 h1:54Bopc5c2cAvhLRAzqOGCYHYyhcDHsFF4wWIR5wKP38=
-github.com/bmatcuk/doublestar/v4 v4.8.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/go-chi/chi/v5 v5.2.1 h1:KOIHODQj58PmL80G2Eak4WdvUzjSJSm0vG72crDCqb8=
-github.com/go-chi/chi/v5 v5.2.1/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops=
-github.com/go-jose/go-jose/v4 v4.0.5 h1:M6T8+mKZl/+fNNuFHvGIzDz7BTLQPIounk/b9dw3AaE=
-github.com/go-jose/go-jose/v4 v4.0.5/go.mod h1:s3P1lRrkT8igV8D9OjyL4WRyHvjB6a4JSllnOrmmBOA=
-github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
-github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=
-github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
-github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
-github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
+github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
+github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
+github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=
+github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
github.com/google/go-github/v31 v31.0.0 h1:JJUxlP9lFK+ziXKimTCprajMApV1ecWD4NB6CCb0plo=
github.com/google/go-github/v31 v31.0.0/go.mod h1:NQPZol8/1sMoWYGN2yaALIBytu17gAWfhbweiEed3pM=
github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
-github.com/google/gofuzz v1.2.0 h1:xRy4A+RhZaiKjJ1bPfwQ8sedCA+YS2YcCHW6ec7JMi0=
-github.com/google/gofuzz v1.2.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
-github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
-github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gorilla/securecookie v1.1.2 h1:YCIWL56dvtr73r6715mJs5ZvhtnY73hBvEF8kXD8ePA=
-github.com/gorilla/securecookie v1.1.2/go.mod h1:NfCASbcHqRSY+3a8tlWJwsQap2VX5pwzwo4h3eOamfo=
-github.com/jeremija/gosubmit v0.2.8 h1:mmSITBz9JxVtu8eqbN+zmmwX7Ij2RidQxhcwRVI4wqA=
-github.com/jeremija/gosubmit v0.2.8/go.mod h1:Ui+HS073lCFREXBbdfrJzMB57OI/bdxTiLtrDHHhFPI=
-github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
-github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/google/uuid v1.3.1 h1:KjJaJ9iWZ3jOFZIf1Lqf4laDRCasjl0BCmnEGxkdLb4=
+github.com/google/uuid v1.3.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
+github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/gorilla/schema v1.2.0 h1:YufUaxZYCKGFuAq3c96BOhjgd5nmXiOY9NGzF247Tsc=
+github.com/gorilla/schema v1.2.0/go.mod h1:kgLaKoK1FELgZqMAVxx/5cbj0kT+57qxUrAlIO2eleU=
+github.com/gorilla/securecookie v1.1.1 h1:miw7JPhV+b/lAHSXz4qd/nN9jRiAFV5FwjeKyCS8BvQ=
+github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4=
+github.com/jeremija/gosubmit v0.2.7 h1:At0OhGCFGPXyjPYAsCchoBUhE099pcBXmsb4iZqROIc=
+github.com/jeremija/gosubmit v0.2.7/go.mod h1:Ui+HS073lCFREXBbdfrJzMB57OI/bdxTiLtrDHHhFPI=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/muhlemmer/gu v0.3.1 h1:7EAqmFrW7n3hETvuAdmFmn4hS8W+z3LgKtrnow+YzNM=
-github.com/muhlemmer/gu v0.3.1/go.mod h1:YHtHR+gxM+bKEIIs7Hmi9sPT3ZDUvTN/i88wQpZkrdM=
-github.com/muhlemmer/httpforwarded v0.1.0 h1:x4DLrzXdliq8mprgUMR0olDvHGkou5BJsK/vWUetyzY=
-github.com/muhlemmer/httpforwarded v0.1.0/go.mod h1:yo9czKedo2pdZhoXe+yDkGVbU0TJ0q9oQ90BVoDEtw0=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rs/cors v1.11.1 h1:eU3gRzXLRK57F5rKMGMZURNdIG4EoAmX8k94r9wXWHA=
-github.com/rs/cors v1.11.1/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU=
+github.com/rs/cors v1.10.1 h1:L0uuZVXIKlI1SShY2nhFfo44TYvDPQ1w4oFkUJNfhyo=
+github.com/rs/cors v1.10.1/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU=
+github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
-github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
-github.com/zitadel/logging v0.6.2 h1:MW2kDDR0ieQynPZ0KIZPrh9ote2WkxfBif5QoARDQcU=
-github.com/zitadel/logging v0.6.2/go.mod h1:z6VWLWUkJpnNVDSLzrPSQSQyttysKZ6bCRongw0ROK4=
-github.com/zitadel/schema v1.3.1 h1:QT3kwiRIRXXLVAs6gCK/u044WmUVh6IlbLXUsn6yRQU=
-github.com/zitadel/schema v1.3.1/go.mod h1:071u7D2LQacy1HAN+YnMd/mx1qVE2isb0Mjeqg46xnU=
-go.opentelemetry.io/otel v1.29.0 h1:PdomN/Al4q/lN6iBJEN3AwPvUiHPMlt93c8bqTG5Llw=
-go.opentelemetry.io/otel v1.29.0/go.mod h1:N/WtXPs1CNCUEx+Agz5uouwCba+i+bJGFicT8SR4NP8=
-go.opentelemetry.io/otel/metric v1.29.0 h1:vPf/HFWTNkPu1aYeIsc98l4ktOQaL6LeSoeV2g+8YLc=
-go.opentelemetry.io/otel/metric v1.29.0/go.mod h1:auu/QWieFVWx+DmQOUMgj0F8LHWdgalxXqvp7BII/W8=
-go.opentelemetry.io/otel/trace v1.29.0 h1:J/8ZNK4XgR7a21DZUAsbF8pZ5Jcw1VhACmnYt39JTi4=
-go.opentelemetry.io/otel/trace v1.29.0/go.mod h1:eHl3w0sp3paPkYstJOmAimxhiFXPg+MMTlEh3nsQgWQ=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+github.com/zitadel/logging v0.3.4 h1:9hZsTjMMTE3X2LUi0xcF9Q9EdLo+FAezeu52ireBbHM=
+github.com/zitadel/logging v0.3.4/go.mod h1:aPpLQhE+v6ocNK0TWrBrd363hZ95KcI17Q1ixAQwZF0=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34=
-golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc=
+golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
-golang.org/x/net v0.38.0 h1:vRMAPTMaeGqVhG5QyLJHqNDwecKTomGeqbnfZyKlBI8=
-golang.org/x/net v0.38.0/go.mod h1:ivrbrMbzFq5J41QOQh0siUuly180yBYtLp+CKbEaFx8=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
+golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
-golang.org/x/oauth2 v0.30.0 h1:dnDm7JmhM45NNpd8FDDeLhK6FwqbOf4MLCM9zb1BOHI=
-golang.org/x/oauth2 v0.30.0/go.mod h1:B++QgG3ZKulg6sRPGD/mqlHQs5rB3Ml9erfeDY7xKlU=
+golang.org/x/oauth2 v0.13.0 h1:jDDenyj+WgFtmV3zYVoi8aE2BwtXFLWOA67ZfNWftiY=
+golang.org/x/oauth2 v0.13.0/go.mod h1:/JMhi4ZRXAf4HG9LiNmxvk+45+96RUlVThiH8FzNBn0=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220207234003-57398862261d/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
-golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
+golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.26.0 h1:P42AVeLghgTYr4+xUnTRKDMqpar+PtX7KWuNQL21L8M=
-golang.org/x/text v0.26.0/go.mod h1:QK15LZJUUQVJxhz7wXgxSy/CJaTFjd0G+YLonydOVQA=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
+golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
+golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
+google.golang.org/appengine v1.6.8 h1:IhEN5q69dyKagZPYMSdIjS2HqprW324FRQZJcGqPAsM=
+google.golang.org/appengine v1.6.8/go.mod h1:1jJ3jBArFh5pcgW8gCtRJnepW8FzD1V44FJffLiz/Ds=
+google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
+google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
+google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
-gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
-gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
-gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b h1:QRR6H1YWRnHb4Y/HeNFCTJLFVxaq6wH4YuVdsUOr75U=
+gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/square/go-jose.v2 v2.6.0 h1:NGk74WTnPKBNUhNzQX7PYcTLUjoq7mzKk2OKbvwk2iI=
+gopkg.in/square/go-jose.v2 v2.6.0/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI=
+gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/internal/testutil/gen/gen.go b/internal/testutil/gen/gen.go
deleted file mode 100644
index 3e44b7d..0000000
--- a/internal/testutil/gen/gen.go
+++ /dev/null
@@ -1,58 +0,0 @@
-// Package gen allows generating of example tokens and claims.
-//
-// go run ./internal/testutil/gen
-package main
-
-import (
- "encoding/json"
- "fmt"
- "os"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
-)
-
-var custom = map[string]any{
- "foo": "Hello, World!",
- "bar": struct {
- Count int `json:"count,omitempty"`
- Tags []string `json:"tags,omitempty"`
- }{
- Count: 22,
- Tags: []string{"some", "tags"},
- },
-}
-
-func main() {
- enc := json.NewEncoder(os.Stdout)
- enc.SetIndent("", " ")
-
- accessToken, atClaims := tu.NewAccessTokenCustom(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration.AddDate(99, 0, 0), tu.ValidJWTID,
- tu.ValidClientID, tu.ValidSkew, custom,
- )
- atHash, err := oidc.ClaimHash(accessToken, tu.SignatureAlgorithm)
- if err != nil {
- panic(err)
- }
-
- idToken, idClaims := tu.NewIDTokenCustom(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration.AddDate(99, 0, 0), tu.ValidAuthTime,
- tu.ValidNonce, tu.ValidACR, tu.ValidAMR, tu.ValidClientID,
- tu.ValidSkew, atHash, custom,
- )
-
- fmt.Println("access token claims:")
- if err := enc.Encode(atClaims); err != nil {
- panic(err)
- }
- fmt.Printf("access token:\n%s\n", accessToken)
-
- fmt.Println("ID token claims:")
- if err := enc.Encode(idClaims); err != nil {
- panic(err)
- }
- fmt.Printf("ID token:\n%s\n", idToken)
-}
diff --git a/internal/testutil/token.go b/internal/testutil/token.go
deleted file mode 100644
index 72d08c5..0000000
--- a/internal/testutil/token.go
+++ /dev/null
@@ -1,180 +0,0 @@
-// Package testuril helps setting up required data for testing,
-// such as tokens, claims and verifiers.
-package testutil
-
-import (
- "context"
- "encoding/json"
- "errors"
- "time"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- jose "github.com/go-jose/go-jose/v4"
- "github.com/muhlemmer/gu"
-)
-
-// KeySet implements oidc.Keys
-type KeySet struct{}
-
-// VerifySignature implments op.KeySet.
-func (KeySet) VerifySignature(ctx context.Context, jws *jose.JSONWebSignature) (payload []byte, err error) {
- if err = ctx.Err(); err != nil {
- return nil, err
- }
-
- return jws.Verify(WebKey.Public())
-}
-
-// use a reproducible signing key
-const webkeyJSON = `{"kty":"RSA","kid":"1","alg":"PS512","n":"x6JoG8t2Li68JSwPwnh51TvHYFf3z72tQ3wmJG3VosU6MdJF0gSTCIwflOJ38OWE6hYtN1WAeyBy2CYdnXd1QZzkK_apGK4M7hsNA9jCTg8NOZjLPL0ww1jp7313Skla7mbm90uNdg4TUNp2n_r-sCYywI-9cfSlhzLSksxKK_BRdzy6xW20daAcI-mErQXIcvdYIguunJk_uTb8kJedsWMcQ4Mb57QujUok2Z2YabWyb9Fi1_StixXJvd_WEu93SHNMORB0u6ymnO3aZJdATLdhtcP-qsVicQhffpqVazmZQPf7K-7n4I5vJE4g9XXzZ2dSKSp3Ewe_nna_2kvbCw","e":"AQAB","d":"sl3F_QeF2O-CxQegMRYpbL6Tfd47GM6VDxXOkn_cACmNvFPudB4ILPvdf830cjTv06Lq1WS8fcZZNgygK0A_cNc3-pvRK67e-KMMtuIlgU7rdwmwlN1Iw1Ee-w6z1ZjC-PzR4iQMCW28DmKS2I-OnV4TvH7xOe7nMmvTPrvujV__YKfUxvAWXJG7_wtaJBGplezn5nNsKG2Ot9h0mhMdYUgGC36wLxo3Q5d4m79EXQYdhm89EfxogwvMmHRes5PNpHRuDZRHGAI4RZi2KvgmqF07e1Qdq4TqbQnY5pCYrdjqvEFFjGC6jTE-ak_b21FcSVy-9aZHyf04U4g5-cIUEQ","p":"7AaicFryJCHRekdSkx8tfPxaSiyEuN8jhP9cLqs4rLkIbrSHmanPhjnLe-Tlh3icQ8hPoy6WC8ktLwsrzbfGIh4U_zgAfvtD1Y_lZM-YSWZsxqlrGiI5do11iVzzoy4a1XdkgOjHQz9y6J-uoA9jY8ILG7VaEZQnaYwWZV3cspk","q":"2Ide9hlwthXJQJYqI0mibM5BiGBxJ4CafPmF1DYNXggBCczZ6ERGReNTGM_AEhy5mvLXUH6uBSOJlfHTYzx49C1GgIO3hEWVEGAKAytVRL6RfAkVSOXMQUp-HjXKpGg_Nx1SJxQf3rulbW8HXO4KqIlloyIXpPQSK7jB8A4hJUM","dp":"1nmc6F4sRNsaQHRJO_mL21RxM4_KtzfFThjCCoJ6iLHHUNnpkp_1PTKNjrLMRFM8JHgErfMqU-FmlqYfEtvZRq1xRQ39nWX0GT-eIwJljuVtGQVglqnc77bRxJXbqz-9EJdik6VzVM92Op7IDxiMp1zvvSkJhInNWqL6wvgNEZk","dq":"dlHizlAwiw90ndpwxD-khhhfLwqkSpW31br0KnYu78cn6hcKrCVC0UXbTp-XsU4JDmbMyauvpBc7Q7iVbpDI94UWFXvkeF8diYkxb3HqclpAXasI-oC4EKWILTHvvc9JW_Clx7zzfV7Ekvws5dcd8-LAq1gh232TwFiBgY_3BMk","qi":"E1k_9W3odXgcmIP2PCJztE7hB7jeuAL1ElAY88VJBBPY670uwOEjKL2VfQuz9q9IjzLAvcgf7vS9blw2RHP_XqHqSOlJWGwvMQTF0Q8zLknCgKt8q7HQQNWIJcBZ8qdUVn02-qf4E3tgZ3JHaHNs8imA_L-__WoUmzC4z5jH_lM"}`
-
-const SignatureAlgorithm = jose.RS256
-
-var (
- WebKey jose.JSONWebKey
- Signer jose.Signer
-)
-
-func init() {
- err := json.Unmarshal([]byte(webkeyJSON), &WebKey)
- if err != nil {
- panic(err)
- }
- Signer, err = jose.NewSigner(jose.SigningKey{Algorithm: SignatureAlgorithm, Key: WebKey}, nil)
- if err != nil {
- panic(err)
- }
-}
-
-type JWTProfileKeyStorage struct{}
-
-func (JWTProfileKeyStorage) GetKeyByIDAndClientID(ctx context.Context, keyID string, clientID string) (*jose.JSONWebKey, error) {
- if err := ctx.Err(); err != nil {
- return nil, err
- }
-
- return gu.Ptr(WebKey.Public()), nil
-}
-
-func signEncodeTokenClaims(claims any) string {
- payload, err := json.Marshal(claims)
- if err != nil {
- panic(err)
- }
- object, err := Signer.Sign(payload)
- if err != nil {
- panic(err)
- }
- token, err := object.CompactSerialize()
- if err != nil {
- panic(err)
- }
- return token
-}
-
-func claimsMap(claims any) map[string]any {
- data, err := json.Marshal(claims)
- if err != nil {
- panic(err)
- }
- dst := make(map[string]any)
- if err = json.Unmarshal(data, &dst); err != nil {
- panic(err)
- }
- return dst
-}
-
-func NewIDTokenCustom(issuer, subject string, audience []string, expiration, authTime time.Time, nonce string, acr string, amr []string, clientID string, skew time.Duration, atHash string, custom map[string]any) (string, *oidc.IDTokenClaims) {
- claims := oidc.NewIDTokenClaims(issuer, subject, audience, expiration, authTime, nonce, acr, amr, clientID, skew)
- claims.AccessTokenHash = atHash
- claims.Claims = custom
- token := signEncodeTokenClaims(claims)
-
- // set this so that assertion in tests will work
- claims.SignatureAlg = SignatureAlgorithm
- claims.Claims = claimsMap(claims)
- return token, claims
-}
-
-// NewIDToken creates a new IDTokenClaims with passed data and returns a signed token and claims.
-func NewIDToken(issuer, subject string, audience []string, expiration, authTime time.Time, nonce string, acr string, amr []string, clientID string, skew time.Duration, atHash string) (string, *oidc.IDTokenClaims) {
- return NewIDTokenCustom(issuer, subject, audience, expiration, authTime, nonce, acr, amr, clientID, skew, atHash, nil)
-}
-
-func NewAccessTokenCustom(issuer, subject string, audience []string, expiration time.Time, jwtid, clientID string, skew time.Duration, custom map[string]any) (string, *oidc.AccessTokenClaims) {
- claims := oidc.NewAccessTokenClaims(issuer, subject, audience, expiration, jwtid, clientID, skew)
- claims.Claims = custom
- token := signEncodeTokenClaims(claims)
-
- // set this so that assertion in tests will work
- claims.SignatureAlg = SignatureAlgorithm
- claims.Claims = claimsMap(claims)
- return token, claims
-}
-
-// NewAcccessToken creates a new AccessTokenClaims with passed data and returns a signed token and claims.
-func NewAccessToken(issuer, subject string, audience []string, expiration time.Time, jwtid, clientID string, skew time.Duration) (string, *oidc.AccessTokenClaims) {
- return NewAccessTokenCustom(issuer, subject, audience, expiration, jwtid, clientID, skew, nil)
-}
-
-func NewJWTProfileAssertion(issuer, clientID string, audience []string, issuedAt, expiration time.Time) (string, *oidc.JWTTokenRequest) {
- req := &oidc.JWTTokenRequest{
- Issuer: issuer,
- Subject: clientID,
- Audience: audience,
- ExpiresAt: oidc.FromTime(expiration),
- IssuedAt: oidc.FromTime(issuedAt),
- }
- // make sure the private claim map is set correctly
- data, err := json.Marshal(req)
- if err != nil {
- panic(err)
- }
- if err = json.Unmarshal(data, req); err != nil {
- panic(err)
- }
- return signEncodeTokenClaims(req), req
-}
-
-const InvalidSignatureToken = `eyJhbGciOiJQUzUxMiJ9.eyJpc3MiOiJsb2NhbC5jb20iLCJzdWIiOiJ0aW1AbG9jYWwuY29tIiwiYXVkIjpbInVuaXQiLCJ0ZXN0IiwiNTU1NjY2Il0sImV4cCI6MTY3Nzg0MDQzMSwiaWF0IjoxNjc3ODQwMzcwLCJhdXRoX3RpbWUiOjE2Nzc4NDAzMTAsIm5vbmNlIjoiMTIzNDUiLCJhY3IiOiJzb21ldGhpbmciLCJhbXIiOlsiZm9vIiwiYmFyIl0sImF6cCI6IjU1NTY2NiJ9.DtZmvVkuE4Hw48ijBMhRJbxEWCr_WEYuPQBMY73J9TP6MmfeNFkjVJf4nh4omjB9gVLnQ-xhEkNOe62FS5P0BB2VOxPuHZUj34dNspCgG3h98fGxyiMb5vlIYAHDF9T-w_LntlYItohv63MmdYR-hPpAqjXE7KOfErf-wUDGE9R3bfiQ4HpTdyFJB1nsToYrZ9lhP2mzjTCTs58ckZfQ28DFHn_lfHWpR4rJBgvLx7IH4rMrUayr09Ap-PxQLbv0lYMtmgG1z3JK8MXnuYR0UJdZnEIezOzUTlThhCXB-nvuAXYjYxZZTR0FtlgZUHhIpYK0V2abf_Q_Or36akNCUg`
-
-// These variables always result in a valid token
-var (
- ValidIssuer = "local.com"
- ValidSubject = "tim@local.com"
- ValidAudience = []string{"unit", "test"}
- ValidAuthTime = time.Now().Add(-time.Minute) // authtime is always 1 minute in the past
- ValidExpiration = ValidAuthTime.Add(2 * time.Minute) // token is always 1 more minute available
- ValidJWTID = "9876"
- ValidNonce = "12345"
- ValidACR = "something"
- ValidAMR = []string{"foo", "bar"}
- ValidClientID = "555666"
- ValidSkew = time.Second
-)
-
-// ValidIDToken returns a token and claims that are in the token.
-// It uses the Valid* global variables and the token will always
-// pass verification.
-func ValidIDToken() (string, *oidc.IDTokenClaims) {
- return NewIDToken(ValidIssuer, ValidSubject, ValidAudience, ValidExpiration, ValidAuthTime, ValidNonce, ValidACR, ValidAMR, ValidClientID, ValidSkew, "")
-}
-
-// ValidAccessToken returns a token and claims that are in the token.
-// It uses the Valid* global variables and the token always passes
-// verification within the same test run.
-func ValidAccessToken() (string, *oidc.AccessTokenClaims) {
- return NewAccessToken(ValidIssuer, ValidSubject, ValidAudience, ValidExpiration, ValidJWTID, ValidClientID, ValidSkew)
-}
-
-func ValidJWTProfileAssertion() (string, *oidc.JWTTokenRequest) {
- return NewJWTProfileAssertion(ValidClientID, ValidClientID, []string{ValidIssuer}, time.Now(), ValidExpiration)
-}
-
-// ACRVerify is a oidc.ACRVerifier func.
-func ACRVerify(acr string) error {
- if acr != ValidACR {
- return errors.New("invalid acr")
- }
- return nil
-}
diff --git a/pkg/client/client.go b/pkg/client/client.go
index 2e1f536..62f1019 100644
--- a/pkg/client/client.go
+++ b/pkg/client/client.go
@@ -1,53 +1,48 @@
package client
import (
- "context"
"errors"
"fmt"
"io"
"net/http"
"net/url"
+ "reflect"
"strings"
"time"
- "github.com/go-jose/go-jose/v4"
- "github.com/zitadel/logging"
- "go.opentelemetry.io/otel"
+ "github.com/gorilla/schema"
"golang.org/x/oauth2"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/crypto"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/crypto"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
-var (
- Encoder = httphelper.Encoder(oidc.NewEncoder())
- Tracer = otel.Tracer("github.com/zitadel/oidc/pkg/client")
-)
+var Encoder = func() httphelper.Encoder {
+ e := schema.NewEncoder()
+ e.RegisterEncoder(oidc.SpaceDelimitedArray{}, func(value reflect.Value) string {
+ return value.Interface().(oidc.SpaceDelimitedArray).Encode()
+ })
+ return e
+}()
// Discover calls the discovery endpoint of the provided issuer and returns its configuration
// It accepts an optional argument "wellknownUrl" which can be used to overide the dicovery endpoint url
-func Discover(ctx context.Context, issuer string, httpClient *http.Client, wellKnownUrl ...string) (*oidc.DiscoveryConfiguration, error) {
- ctx, span := Tracer.Start(ctx, "Discover")
- defer span.End()
-
+func Discover(issuer string, httpClient *http.Client, wellKnownUrl ...string) (*oidc.DiscoveryConfiguration, error) {
wellKnown := strings.TrimSuffix(issuer, "/") + oidc.DiscoveryEndpoint
if len(wellKnownUrl) == 1 && wellKnownUrl[0] != "" {
wellKnown = wellKnownUrl[0]
}
- req, err := http.NewRequestWithContext(ctx, http.MethodGet, wellKnown, nil)
+ req, err := http.NewRequest("GET", wellKnown, nil)
if err != nil {
return nil, err
}
discoveryConfig := new(oidc.DiscoveryConfiguration)
err = httphelper.HttpRequest(httpClient, req, &discoveryConfig)
if err != nil {
- return nil, errors.Join(oidc.ErrDiscoveryFailed, err)
+ return nil, err
}
- if logger, ok := logging.FromContext(ctx); ok {
- logger.Debug("discover", "config", discoveryConfig)
- }
-
if discoveryConfig.Issuer != issuer {
return nil, oidc.ErrIssuerInvalid
}
@@ -59,15 +54,12 @@ type TokenEndpointCaller interface {
HttpClient() *http.Client
}
-func CallTokenEndpoint(ctx context.Context, request any, caller TokenEndpointCaller) (newToken *oauth2.Token, err error) {
- return callTokenEndpoint(ctx, request, nil, caller)
+func CallTokenEndpoint(request interface{}, caller TokenEndpointCaller) (newToken *oauth2.Token, err error) {
+ return callTokenEndpoint(request, nil, caller)
}
-func callTokenEndpoint(ctx context.Context, request any, authFn any, caller TokenEndpointCaller) (newToken *oauth2.Token, err error) {
- ctx, span := Tracer.Start(ctx, "callTokenEndpoint")
- defer span.End()
-
- req, err := httphelper.FormRequest(ctx, caller.TokenEndpoint(), request, Encoder, authFn)
+func callTokenEndpoint(request interface{}, authFn interface{}, caller TokenEndpointCaller) (newToken *oauth2.Token, err error) {
+ req, err := httphelper.FormRequest(caller.TokenEndpoint(), request, Encoder, authFn)
if err != nil {
return nil, err
}
@@ -75,18 +67,12 @@ func callTokenEndpoint(ctx context.Context, request any, authFn any, caller Toke
if err := httphelper.HttpRequest(caller.HttpClient(), req, &tokenRes); err != nil {
return nil, err
}
- token := &oauth2.Token{
+ return &oauth2.Token{
AccessToken: tokenRes.AccessToken,
TokenType: tokenRes.TokenType,
RefreshToken: tokenRes.RefreshToken,
Expiry: time.Now().UTC().Add(time.Duration(tokenRes.ExpiresIn) * time.Second),
- }
- if tokenRes.IDToken != "" {
- token = token.WithExtra(map[string]any{
- "id_token": tokenRes.IDToken,
- })
- }
- return token, nil
+ }, nil
}
type EndSessionCaller interface {
@@ -94,16 +80,8 @@ type EndSessionCaller interface {
HttpClient() *http.Client
}
-func CallEndSessionEndpoint(ctx context.Context, request any, authFn any, caller EndSessionCaller) (*url.URL, error) {
- ctx, span := Tracer.Start(ctx, "CallEndSessionEndpoint")
- defer span.End()
-
- endpoint := caller.GetEndSessionEndpoint()
- if endpoint == "" {
- return nil, fmt.Errorf("end session %w", ErrEndpointNotSet)
- }
-
- req, err := httphelper.FormRequest(ctx, endpoint, request, Encoder, authFn)
+func CallEndSessionEndpoint(request interface{}, authFn interface{}, caller EndSessionCaller) (*url.URL, error) {
+ req, err := httphelper.FormRequest(caller.GetEndSessionEndpoint(), request, Encoder, authFn)
if err != nil {
return nil, err
}
@@ -112,9 +90,6 @@ func CallEndSessionEndpoint(ctx context.Context, request any, authFn any, caller
return http.ErrUseLastResponse
}
resp, err := client.Do(req)
- if err != nil {
- return nil, err
- }
defer resp.Body.Close()
if resp.StatusCode < 200 || resp.StatusCode >= 400 {
body, err := io.ReadAll(resp.Body)
@@ -145,16 +120,8 @@ type RevokeRequest struct {
ClientSecret string `schema:"client_secret"`
}
-func CallRevokeEndpoint(ctx context.Context, request any, authFn any, caller RevokeCaller) error {
- ctx, span := Tracer.Start(ctx, "CallRevokeEndpoint")
- defer span.End()
-
- endpoint := caller.GetRevokeEndpoint()
- if endpoint == "" {
- return fmt.Errorf("revoke %w", ErrEndpointNotSet)
- }
-
- req, err := httphelper.FormRequest(ctx, endpoint, request, Encoder, authFn)
+func CallRevokeEndpoint(request interface{}, authFn interface{}, caller RevokeCaller) error {
+ req, err := httphelper.FormRequest(caller.GetRevokeEndpoint(), request, Encoder, authFn)
if err != nil {
return err
}
@@ -181,28 +148,13 @@ func CallRevokeEndpoint(ctx context.Context, request any, authFn any, caller Rev
return nil
}
-func CallTokenExchangeEndpoint(ctx context.Context, request any, authFn any, caller TokenEndpointCaller) (resp *oidc.TokenExchangeResponse, err error) {
- ctx, span := Tracer.Start(ctx, "CallTokenExchangeEndpoint")
- defer span.End()
-
- req, err := httphelper.FormRequest(ctx, caller.TokenEndpoint(), request, Encoder, authFn)
- if err != nil {
- return nil, err
- }
- tokenRes := new(oidc.TokenExchangeResponse)
- if err := httphelper.HttpRequest(caller.HttpClient(), req, &tokenRes); err != nil {
- return nil, err
- }
- return tokenRes, nil
-}
-
func NewSignerFromPrivateKeyByte(key []byte, keyID string) (jose.Signer, error) {
- privateKey, algorithm, err := crypto.BytesToPrivateKey(key)
+ privateKey, err := crypto.BytesToPrivateKey(key)
if err != nil {
return nil, err
}
signingKey := jose.SigningKey{
- Algorithm: algorithm,
+ Algorithm: jose.RS256,
Key: &jose.JSONWebKey{Key: privateKey, KeyID: keyID},
}
return jose.NewSigner(signingKey, &jose.SignerOptions{})
@@ -215,98 +167,7 @@ func SignedJWTProfileAssertion(clientID string, audience []string, expiration ti
Issuer: clientID,
Subject: clientID,
Audience: audience,
- ExpiresAt: oidc.FromTime(exp),
- IssuedAt: oidc.FromTime(iat),
+ ExpiresAt: oidc.Time(exp),
+ IssuedAt: oidc.Time(iat),
}, signer)
}
-
-type DeviceAuthorizationCaller interface {
- GetDeviceAuthorizationEndpoint() string
- HttpClient() *http.Client
-}
-
-func CallDeviceAuthorizationEndpoint(ctx context.Context, request *oidc.ClientCredentialsRequest, caller DeviceAuthorizationCaller, authFn any) (*oidc.DeviceAuthorizationResponse, error) {
- ctx, span := Tracer.Start(ctx, "CallDeviceAuthorizationEndpoint")
- defer span.End()
-
- endpoint := caller.GetDeviceAuthorizationEndpoint()
- if endpoint == "" {
- return nil, fmt.Errorf("device authorization %w", ErrEndpointNotSet)
- }
-
- req, err := httphelper.FormRequest(ctx, endpoint, request, Encoder, authFn)
- if err != nil {
- return nil, err
- }
- if request.ClientSecret != "" {
- req.SetBasicAuth(request.ClientID, request.ClientSecret)
- }
-
- resp := new(oidc.DeviceAuthorizationResponse)
- if err := httphelper.HttpRequest(caller.HttpClient(), req, &resp); err != nil {
- return nil, err
- }
- return resp, nil
-}
-
-type DeviceAccessTokenRequest struct {
- *oidc.ClientCredentialsRequest
- oidc.DeviceAccessTokenRequest
-}
-
-func CallDeviceAccessTokenEndpoint(ctx context.Context, request *DeviceAccessTokenRequest, caller TokenEndpointCaller) (*oidc.AccessTokenResponse, error) {
- ctx, span := Tracer.Start(ctx, "CallDeviceAccessTokenEndpoint")
- defer span.End()
-
- req, err := httphelper.FormRequest(ctx, caller.TokenEndpoint(), request, Encoder, nil)
- if err != nil {
- return nil, err
- }
- if request.ClientSecret != "" {
- req.SetBasicAuth(request.ClientID, request.ClientSecret)
- }
-
- resp := new(oidc.AccessTokenResponse)
- if err := httphelper.HttpRequest(caller.HttpClient(), req, &resp); err != nil {
- return nil, err
- }
- return resp, nil
-}
-
-func PollDeviceAccessTokenEndpoint(ctx context.Context, interval time.Duration, request *DeviceAccessTokenRequest, caller TokenEndpointCaller) (*oidc.AccessTokenResponse, error) {
- ctx, span := Tracer.Start(ctx, "PollDeviceAccessTokenEndpoint")
- defer span.End()
-
- for {
- timer := time.After(interval)
- select {
- case <-ctx.Done():
- return nil, ctx.Err()
- case <-timer:
- }
-
- ctx, cancel := context.WithTimeout(ctx, interval)
- defer cancel()
-
- resp, err := CallDeviceAccessTokenEndpoint(ctx, request, caller)
- if err == nil {
- return resp, nil
- }
- if errors.Is(err, context.DeadlineExceeded) {
- interval += 5 * time.Second
- }
- var target *oidc.Error
- if !errors.As(err, &target) {
- return nil, err
- }
- switch target.ErrorType {
- case oidc.AuthorizationPending:
- continue
- case oidc.SlowDown:
- interval += 5 * time.Second
- continue
- default:
- return nil, err
- }
- }
-}
diff --git a/pkg/client/client_test.go b/pkg/client/client_test.go
deleted file mode 100644
index 9e21e8e..0000000
--- a/pkg/client/client_test.go
+++ /dev/null
@@ -1,59 +0,0 @@
-package client
-
-import (
- "context"
- "net/http"
- "testing"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestDiscover(t *testing.T) {
- type wantFields struct {
- UILocalesSupported bool
- }
-
- type args struct {
- issuer string
- wellKnownUrl []string
- }
- tests := []struct {
- name string
- args args
- wantFields *wantFields
- wantErr error
- }{
- {
- name: "spotify", // https://github.com/zitadel/oidc/issues/406
- args: args{
- issuer: "https://accounts.spotify.com",
- },
- wantFields: &wantFields{
- UILocalesSupported: true,
- },
- wantErr: nil,
- },
- {
- name: "discovery failed",
- args: args{
- issuer: "https://example.com",
- },
- wantErr: oidc.ErrDiscoveryFailed,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got, err := Discover(context.Background(), tt.args.issuer, http.DefaultClient, tt.args.wellKnownUrl...)
- require.ErrorIs(t, err, tt.wantErr)
- if tt.wantFields == nil {
- return
- }
- assert.Equal(t, tt.args.issuer, got.Issuer)
- if tt.wantFields.UILocalesSupported {
- assert.NotEmpty(t, got.UILocalesSupported)
- }
- })
- }
-}
diff --git a/pkg/client/errors.go b/pkg/client/errors.go
deleted file mode 100644
index 47210e5..0000000
--- a/pkg/client/errors.go
+++ /dev/null
@@ -1,5 +0,0 @@
-package client
-
-import "errors"
-
-var ErrEndpointNotSet = errors.New("endpoint not set")
diff --git a/pkg/client/integration_test.go b/pkg/client/integration_test.go
deleted file mode 100644
index 86a9ab7..0000000
--- a/pkg/client/integration_test.go
+++ /dev/null
@@ -1,594 +0,0 @@
-package client_test
-
-import (
- "bytes"
- "context"
- "fmt"
- "io"
- "log/slog"
- "math/rand"
- "net/http"
- "net/http/cookiejar"
- "net/http/httptest"
- "net/url"
- "os"
- "os/signal"
- "strconv"
- "syscall"
- "testing"
- "time"
-
- "github.com/jeremija/gosubmit"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "golang.org/x/oauth2"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/exampleop"
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/storage"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rs"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/tokenexchange"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
-)
-
-var Logger = slog.New(
- slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
- AddSource: true,
- Level: slog.LevelDebug,
- }),
-)
-
-var CTX context.Context
-
-func TestMain(m *testing.M) {
- os.Exit(func() int {
- ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGINT)
- defer cancel()
- CTX, cancel = context.WithTimeout(ctx, time.Minute)
- defer cancel()
- return m.Run()
- }())
-}
-
-func TestRelyingPartySession(t *testing.T) {
- for _, wrapServer := range []bool{false, true} {
- t.Run(fmt.Sprint("wrapServer ", wrapServer), func(t *testing.T) {
- testRelyingPartySession(t, wrapServer)
- })
- }
-}
-
-func testRelyingPartySession(t *testing.T, wrapServer bool) {
- t.Log("------- start example OP ------")
- targetURL := "http://local-site"
- exampleStorage := storage.NewStorage(storage.NewUserStore(targetURL))
- var dh deferredHandler
- opServer := httptest.NewServer(&dh)
- defer opServer.Close()
- t.Logf("auth server at %s", opServer.URL)
- dh.Handler = exampleop.SetupServer(opServer.URL, exampleStorage, Logger, wrapServer)
-
- seed := rand.New(rand.NewSource(int64(os.Getpid()) + time.Now().UnixNano()))
- clientID := t.Name() + "-" + strconv.FormatInt(seed.Int63(), 25)
-
- t.Log("------- run authorization code flow ------")
- provider, tokens := RunAuthorizationCodeFlow(t, opServer, clientID, "secret")
-
- t.Log("------- refresh tokens ------")
-
- newTokens, err := rp.RefreshTokens[*oidc.IDTokenClaims](CTX, provider, tokens.RefreshToken, "", "")
- require.NoError(t, err, "refresh token")
- assert.NotNil(t, newTokens, "access token")
- t.Logf("new access token %s", newTokens.AccessToken)
- t.Logf("new refresh token %s", newTokens.RefreshToken)
- t.Logf("new token type %s", newTokens.TokenType)
- t.Logf("new expiry %s", newTokens.Expiry.Format(time.RFC3339))
- require.NotEmpty(t, newTokens.AccessToken, "new accessToken")
- assert.NotEmpty(t, newTokens.IDToken, "new idToken")
- assert.NotNil(t, newTokens.IDTokenClaims)
- assert.Equal(t, newTokens.IDTokenClaims.Subject, tokens.IDTokenClaims.Subject)
-
- t.Log("------ end session (logout) ------")
-
- newLoc, err := rp.EndSession(CTX, provider, tokens.IDToken, "", "")
- require.NoError(t, err, "logout")
- if newLoc != nil {
- t.Logf("redirect to %s", newLoc)
- } else {
- t.Logf("no redirect")
- }
-
- t.Log("------ attempt refresh again (should fail) ------")
- t.Log("trying original refresh token", tokens.RefreshToken)
- _, err = rp.RefreshTokens[*oidc.IDTokenClaims](CTX, provider, tokens.RefreshToken, "", "")
- assert.Errorf(t, err, "refresh with original")
- if newTokens.RefreshToken != "" {
- t.Log("trying replacement refresh token", newTokens.RefreshToken)
- _, err = rp.RefreshTokens[*oidc.IDTokenClaims](CTX, provider, newTokens.RefreshToken, "", "")
- assert.Errorf(t, err, "refresh with replacement")
- }
-}
-
-func TestRelyingPartyWithSigningAlgsFromDiscovery(t *testing.T) {
- targetURL := "http://local-site"
- localURL, err := url.Parse(targetURL + "/login?requestID=1234")
- require.NoError(t, err, "local url")
-
- t.Log("------- start example OP ------")
- seed := rand.New(rand.NewSource(int64(os.Getpid()) + time.Now().UnixNano()))
- clientID := t.Name() + "-" + strconv.FormatInt(seed.Int63(), 25)
- clientSecret := "secret"
- client := storage.WebClient(clientID, clientSecret, targetURL)
- storage.RegisterClients(client)
- exampleStorage := storage.NewStorage(storage.NewUserStore(targetURL))
- var dh deferredHandler
- opServer := httptest.NewServer(&dh)
- defer opServer.Close()
- dh.Handler = exampleop.SetupServer(opServer.URL, exampleStorage, Logger, true)
-
- t.Log("------- create RP ------")
- provider, err := rp.NewRelyingPartyOIDC(
- CTX,
- opServer.URL,
- clientID,
- clientSecret,
- targetURL,
- []string{"openid"},
- rp.WithSigningAlgsFromDiscovery(),
- )
- require.NoError(t, err, "new rp")
-
- t.Log("------- run authorization code flow ------")
- jar, err := cookiejar.New(nil)
- require.NoError(t, err, "create cookie jar")
- httpClient := &http.Client{
- Timeout: time.Second * 5,
- CheckRedirect: func(_ *http.Request, _ []*http.Request) error {
- return http.ErrUseLastResponse
- },
- Jar: jar,
- }
- state := "state-" + strconv.FormatInt(seed.Int63(), 25)
- capturedW := httptest.NewRecorder()
- get := httptest.NewRequest("GET", localURL.String(), nil)
- rp.AuthURLHandler(func() string { return state }, provider,
- rp.WithPromptURLParam("Hello, World!", "Goodbye, World!"),
- rp.WithURLParam("custom", "param"),
- )(capturedW, get)
- defer func() {
- if t.Failed() {
- t.Log("response body (redirect from RP to OP)", capturedW.Body.String())
- }
- }()
- resp := capturedW.Result()
- startAuthURL, err := resp.Location()
- require.NoError(t, err, "get redirect")
- loginPageURL := getRedirect(t, "get redirect to login page", httpClient, startAuthURL)
- form := getForm(t, "get login form", httpClient, loginPageURL)
- defer func() {
- if t.Failed() {
- t.Logf("login form (unfilled): %s", string(form))
- }
- }()
- postLoginRedirectURL := fillForm(t, "fill login form", httpClient, form, loginPageURL,
- gosubmit.Set("username", "test-user@local-site"),
- gosubmit.Set("password", "verysecure"),
- )
- codeBearingURL := getRedirect(t, "get redirect with code", httpClient, postLoginRedirectURL)
- capturedW = httptest.NewRecorder()
- get = httptest.NewRequest("GET", codeBearingURL.String(), nil)
- var idToken string
- redirect := func(w http.ResponseWriter, r *http.Request, newTokens *oidc.Tokens[*oidc.IDTokenClaims], state string, rp rp.RelyingParty, info *oidc.UserInfo) {
- idToken = newTokens.IDToken
- http.Redirect(w, r, targetURL, http.StatusFound)
- }
- rp.CodeExchangeHandler(rp.UserinfoCallback(redirect), provider)(capturedW, get)
- defer func() {
- if t.Failed() {
- t.Log("token exchange response body", capturedW.Body.String())
- require.GreaterOrEqual(t, capturedW.Code, 200, "captured response code")
- }
- }()
-
- t.Log("------- verify id token ------")
- _, err = rp.VerifyIDToken[*oidc.IDTokenClaims](CTX, idToken, provider.IDTokenVerifier())
- require.NoError(t, err, "verify id token")
-}
-
-func TestResourceServerTokenExchange(t *testing.T) {
- for _, wrapServer := range []bool{false, true} {
- t.Run(fmt.Sprint("wrapServer ", wrapServer), func(t *testing.T) {
- testResourceServerTokenExchange(t, wrapServer)
- })
- }
-}
-
-func testResourceServerTokenExchange(t *testing.T, wrapServer bool) {
- t.Log("------- start example OP ------")
- targetURL := "http://local-site"
- exampleStorage := storage.NewStorage(storage.NewUserStore(targetURL))
- var dh deferredHandler
- opServer := httptest.NewServer(&dh)
- defer opServer.Close()
- t.Logf("auth server at %s", opServer.URL)
- dh.Handler = exampleop.SetupServer(opServer.URL, exampleStorage, Logger, wrapServer)
-
- seed := rand.New(rand.NewSource(int64(os.Getpid()) + time.Now().UnixNano()))
- clientID := t.Name() + "-" + strconv.FormatInt(seed.Int63(), 25)
- clientSecret := "secret"
-
- t.Log("------- run authorization code flow ------")
- provider, tokens := RunAuthorizationCodeFlow(t, opServer, clientID, clientSecret)
-
- resourceServer, err := rs.NewResourceServerClientCredentials(CTX, opServer.URL, clientID, clientSecret)
- require.NoError(t, err, "new resource server")
-
- t.Log("------- exchage refresh tokens (impersonation) ------")
-
- tokenExchangeResponse, err := tokenexchange.ExchangeToken(
- CTX,
- resourceServer,
- tokens.RefreshToken,
- oidc.RefreshTokenType,
- "",
- "",
- []string{},
- []string{},
- []string{"profile", "custom_scope:impersonate:id2"},
- oidc.RefreshTokenType,
- )
- require.NoError(t, err, "refresh token")
- require.NotNil(t, tokenExchangeResponse, "token exchange response")
- assert.Equal(t, tokenExchangeResponse.IssuedTokenType, oidc.RefreshTokenType)
- assert.NotEmpty(t, tokenExchangeResponse.AccessToken, "access token")
- assert.NotEmpty(t, tokenExchangeResponse.RefreshToken, "refresh token")
- assert.Equal(t, []string(tokenExchangeResponse.Scopes), []string{"profile", "custom_scope:impersonate:id2"})
-
- t.Log("------ end session (logout) ------")
-
- newLoc, err := rp.EndSession(CTX, provider, tokens.IDToken, "", "")
- require.NoError(t, err, "logout")
- if newLoc != nil {
- t.Logf("redirect to %s", newLoc)
- } else {
- t.Logf("no redirect")
- }
-
- t.Log("------- attempt exchage again (should fail) ------")
-
- tokenExchangeResponse, err = tokenexchange.ExchangeToken(
- CTX,
- resourceServer,
- tokens.RefreshToken,
- oidc.RefreshTokenType,
- "",
- "",
- []string{},
- []string{},
- []string{"profile", "custom_scope:impersonate:id2"},
- oidc.RefreshTokenType,
- )
- require.Error(t, err, "refresh token")
- assert.Contains(t, err.Error(), "subject_token is invalid")
- require.Nil(t, tokenExchangeResponse, "token exchange response")
-}
-
-func RunAuthorizationCodeFlow(t *testing.T, opServer *httptest.Server, clientID, clientSecret string) (provider rp.RelyingParty, tokens *oidc.Tokens[*oidc.IDTokenClaims]) {
- targetURL := "http://local-site"
- localURL, err := url.Parse(targetURL + "/login?requestID=1234")
- require.NoError(t, err, "local url")
-
- client := storage.WebClient(clientID, clientSecret, targetURL)
- storage.RegisterClients(client)
-
- jar, err := cookiejar.New(nil)
- require.NoError(t, err, "create cookie jar")
- httpClient := &http.Client{
- Timeout: time.Second * 5,
- CheckRedirect: func(_ *http.Request, _ []*http.Request) error {
- return http.ErrUseLastResponse
- },
- Jar: jar,
- }
-
- t.Log("------- create RP ------")
- key := []byte("test1234test1234")
- cookieHandler := httphelper.NewCookieHandler(key, key, httphelper.WithUnsecure())
- provider, err = rp.NewRelyingPartyOIDC(
- CTX,
- opServer.URL,
- clientID,
- clientSecret,
- targetURL,
- []string{"openid", "email", "profile", "offline_access"},
- rp.WithPKCE(cookieHandler),
- rp.WithAuthStyle(oauth2.AuthStyleInHeader),
- rp.WithVerifierOpts(
- rp.WithIssuedAtOffset(5*time.Second),
- rp.WithSupportedSigningAlgorithms("RS256", "RS384", "RS512", "ES256", "ES384", "ES512"),
- ),
- )
- require.NoError(t, err, "new rp")
-
- t.Log("------- get redirect from local client (rp) to OP ------")
- seed := rand.New(rand.NewSource(int64(os.Getpid()) + time.Now().UnixNano()))
- state := "state-" + strconv.FormatInt(seed.Int63(), 25)
- capturedW := httptest.NewRecorder()
- get := httptest.NewRequest("GET", localURL.String(), nil)
- rp.AuthURLHandler(func() string { return state }, provider,
- rp.WithPromptURLParam("Hello, World!", "Goodbye, World!"),
- rp.WithURLParam("custom", "param"),
- )(capturedW, get)
-
- defer func() {
- if t.Failed() {
- t.Log("response body (redirect from RP to OP)", capturedW.Body.String())
- }
- }()
- require.GreaterOrEqual(t, capturedW.Code, 200, "captured response code")
- require.Less(t, capturedW.Code, 400, "captured response code")
- require.Contains(t, capturedW.Body.String(), `prompt=Hello%2C+World%21+Goodbye%2C+World%21`)
- require.Contains(t, capturedW.Body.String(), `custom=param`)
-
- //nolint:bodyclose
- resp := capturedW.Result()
- jar.SetCookies(localURL, resp.Cookies())
-
- startAuthURL, err := resp.Location()
- require.NoError(t, err, "get redirect")
- assert.NotEmpty(t, startAuthURL, "login url")
- t.Log("Starting auth at", startAuthURL)
-
- t.Log("------- get redirect to OP to login page ------")
- loginPageURL := getRedirect(t, "get redirect to login page", httpClient, startAuthURL)
- t.Log("login page URL", loginPageURL)
-
- t.Log("------- get login form ------")
- form := getForm(t, "get login form", httpClient, loginPageURL)
- t.Log("login form (unfilled)", string(form))
- defer func() {
- if t.Failed() {
- t.Logf("login form (unfilled): %s", string(form))
- }
- }()
-
- t.Log("------- post to login form, get redirect to OP ------")
- postLoginRedirectURL := fillForm(t, "fill login form", httpClient, form, loginPageURL,
- gosubmit.Set("username", "test-user@local-site"),
- gosubmit.Set("password", "verysecure"))
- t.Logf("Get redirect from %s", postLoginRedirectURL)
-
- t.Log("------- redirect from OP back to RP ------")
- codeBearingURL := getRedirect(t, "get redirect with code", httpClient, postLoginRedirectURL)
- t.Logf("Redirect with code %s", codeBearingURL)
-
- t.Log("------- exchange code for tokens ------")
- capturedW = httptest.NewRecorder()
- get = httptest.NewRequest("GET", codeBearingURL.String(), nil)
- for _, cookie := range jar.Cookies(codeBearingURL) {
- get.Header["Cookie"] = append(get.Header["Cookie"], cookie.String())
- t.Logf("setting cookie %s", cookie)
- }
-
- var email string
- redirect := func(w http.ResponseWriter, r *http.Request, newTokens *oidc.Tokens[*oidc.IDTokenClaims], state string, rp rp.RelyingParty, info *oidc.UserInfo) {
- tokens = newTokens
- require.NotNil(t, tokens, "tokens")
- require.NotNil(t, info, "info")
- t.Log("access token", tokens.AccessToken)
- t.Log("refresh token", tokens.RefreshToken)
- t.Log("id token", tokens.IDToken)
- t.Log("email", info.Email)
-
- email = info.Email
- http.Redirect(w, r, targetURL, 302)
- }
- rp.CodeExchangeHandler(rp.UserinfoCallback(redirect), provider, rp.WithURLParam("custom", "param"))(capturedW, get)
-
- defer func() {
- if t.Failed() {
- t.Log("token exchange response body", capturedW.Body.String())
- require.GreaterOrEqual(t, capturedW.Code, 200, "captured response code")
- }
- }()
- require.Less(t, capturedW.Code, 400, "token exchange response code")
- // TODO: how to check the custom header was sent to the server?
-
- //nolint:bodyclose
- resp = capturedW.Result()
-
- authorizedURL, err := resp.Location()
- require.NoError(t, err, "get fully-authorizied redirect location")
- require.Equal(t, targetURL, authorizedURL.String(), "fully-authorizied redirect location")
-
- require.NotEmpty(t, tokens.IDToken, "id token")
- assert.NotEmpty(t, tokens.RefreshToken, "refresh token")
- assert.NotEmpty(t, tokens.AccessToken, "access token")
- assert.NotEmpty(t, email, "email")
-
- return provider, tokens
-}
-
-func TestClientCredentials(t *testing.T) {
- targetURL := "http://local-site"
- exampleStorage := storage.NewStorage(storage.NewUserStore(targetURL))
- var dh deferredHandler
- opServer := httptest.NewServer(&dh)
- defer opServer.Close()
- t.Logf("auth server at %s", opServer.URL)
- dh.Handler = exampleop.SetupServer(opServer.URL, exampleStorage, Logger, true)
-
- provider, err := rp.NewRelyingPartyOIDC(
- CTX,
- opServer.URL,
- "sid1",
- "verysecret",
- targetURL,
- []string{"openid"},
- )
- require.NoError(t, err, "new rp")
-
- token, err := rp.ClientCredentials(CTX, provider, nil)
- require.NoError(t, err, "ClientCredentials call")
- require.NotNil(t, token)
- assert.NotEmpty(t, token.AccessToken)
-}
-
-func TestErrorFromPromptNone(t *testing.T) {
- jar, err := cookiejar.New(nil)
- require.NoError(t, err, "create cookie jar")
- httpClient := &http.Client{
- Timeout: time.Second * 5,
- CheckRedirect: func(_ *http.Request, _ []*http.Request) error {
- return http.ErrUseLastResponse
- },
- Jar: jar,
- }
-
- t.Log("------- start example OP ------")
- targetURL := "http://local-site"
- exampleStorage := storage.NewStorage(storage.NewUserStore(targetURL))
- var dh deferredHandler
- opServer := httptest.NewServer(&dh)
- defer opServer.Close()
- t.Logf("auth server at %s", opServer.URL)
- dh.Handler = exampleop.SetupServer(opServer.URL, exampleStorage, Logger, false, op.WithHttpInterceptors(
- func(next http.Handler) http.Handler {
- return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- t.Logf("request to %s", r.URL)
- next.ServeHTTP(w, r)
- })
- },
- ))
- seed := rand.New(rand.NewSource(int64(os.Getpid()) + time.Now().UnixNano()))
- clientID := t.Name() + "-" + strconv.FormatInt(seed.Int63(), 25)
- clientSecret := "secret"
- client := storage.WebClient(clientID, clientSecret, targetURL)
- storage.RegisterClients(client)
-
- t.Log("------- create RP ------")
- key := []byte("test1234test1234")
- cookieHandler := httphelper.NewCookieHandler(key, key, httphelper.WithUnsecure())
- provider, err := rp.NewRelyingPartyOIDC(
- CTX,
- opServer.URL,
- clientID,
- clientSecret,
- targetURL,
- []string{"openid", "email", "profile", "offline_access"},
- rp.WithPKCE(cookieHandler),
- rp.WithVerifierOpts(
- rp.WithIssuedAtOffset(5*time.Second),
- rp.WithSupportedSigningAlgorithms("RS256", "RS384", "RS512", "ES256", "ES384", "ES512"),
- ),
- )
- require.NoError(t, err, "new rp")
-
- t.Log("------- start auth flow with prompt=none ------- ")
- state := "state-32892"
- capturedW := httptest.NewRecorder()
- localURL, err := url.Parse(targetURL + "/login")
- require.NoError(t, err)
-
- get := httptest.NewRequest("GET", localURL.String(), nil)
- rp.AuthURLHandler(func() string { return state }, provider,
- rp.WithPromptURLParam("none"),
- rp.WithResponseModeURLParam(oidc.ResponseModeFragment),
- )(capturedW, get)
-
- defer func() {
- if t.Failed() {
- t.Log("response body (redirect from RP to OP)", capturedW.Body.String())
- }
- }()
- require.GreaterOrEqual(t, capturedW.Code, 200, "captured response code")
- require.Less(t, capturedW.Code, 400, "captured response code")
-
- //nolint:bodyclose
- resp := capturedW.Result()
- jar.SetCookies(localURL, resp.Cookies())
-
- startAuthURL, err := resp.Location()
- require.NoError(t, err, "get redirect")
- assert.NotEmpty(t, startAuthURL, "login url")
- t.Log("Starting auth at", startAuthURL)
-
- t.Log("------- get redirect from OP ------")
- loginPageURL := getRedirect(t, "get redirect to login page", httpClient, startAuthURL)
- t.Log("login page URL", loginPageURL)
-
- require.Contains(t, loginPageURL.String(), `error=login_required`, "prompt=none should error")
- require.Contains(t, loginPageURL.String(), `local-site#error=`, "response_mode=fragment means '#' instead of '?'")
-}
-
-type deferredHandler struct {
- http.Handler
-}
-
-func getRedirect(t *testing.T, desc string, httpClient *http.Client, uri *url.URL) *url.URL {
- req := &http.Request{
- Method: "GET",
- URL: uri,
- Header: make(http.Header),
- }
- resp, err := httpClient.Do(req)
- require.NoError(t, err, "GET "+uri.String())
-
- defer func() {
- if t.Failed() {
- body, _ := io.ReadAll(resp.Body)
- t.Logf("%s: GET %s: body: %s", desc, uri, string(body))
- }
- }()
-
- //nolint:errcheck
- defer resp.Body.Close()
- redirect, err := resp.Location()
- require.NoErrorf(t, err, "%s: get redirect %s", desc, uri)
- require.NotEmptyf(t, redirect, "%s: get redirect %s", desc, uri)
- return redirect
-}
-
-func getForm(t *testing.T, desc string, httpClient *http.Client, uri *url.URL) []byte {
- req := &http.Request{
- Method: "GET",
- URL: uri,
- Header: make(http.Header),
- }
- resp, err := httpClient.Do(req)
- require.NoErrorf(t, err, "%s: GET %s", desc, uri)
- //nolint:errcheck
- defer resp.Body.Close()
- body, err := io.ReadAll(resp.Body)
- require.NoError(t, err, "%s: read GET %s", desc, uri)
- return body
-}
-
-func fillForm(t *testing.T, desc string, httpClient *http.Client, body []byte, uri *url.URL, opts ...gosubmit.Option) *url.URL {
- // TODO: switch to io.NopCloser when go1.15 support is dropped
- req := gosubmit.ParseWithURL(io.NopCloser(bytes.NewReader(body)), uri.String()).FirstForm().Testing(t).NewTestRequest(
- append([]gosubmit.Option{gosubmit.AutoFill()}, opts...)...,
- )
- if req.URL.Scheme == "" {
- req.URL = uri
- t.Log("request lost it's proto..., adding back... request now", req.URL)
- }
- req.RequestURI = "" // bug in gosubmit?
- resp, err := httpClient.Do(req)
- require.NoErrorf(t, err, "%s: POST %s", desc, uri)
-
- //nolint:errcheck
- defer resp.Body.Close()
- defer func() {
- if t.Failed() {
- body, _ := io.ReadAll(resp.Body)
- t.Logf("%s: GET %s: body: %s", desc, uri, string(body))
- }
- }()
-
- redirect, err := resp.Location()
- require.NoErrorf(t, err, "%s: redirect for POST %s", desc, uri)
- return redirect
-}
diff --git a/pkg/client/jwt_profile.go b/pkg/client/jwt_profile.go
index 98a54fd..a711de9 100644
--- a/pkg/client/jwt_profile.go
+++ b/pkg/client/jwt_profile.go
@@ -1,18 +1,17 @@
package client
import (
- "context"
"net/url"
"golang.org/x/oauth2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
// JWTProfileExchange handles the oauth2 jwt profile exchange
-func JWTProfileExchange(ctx context.Context, jwtProfileGrantRequest *oidc.JWTProfileGrantRequest, caller TokenEndpointCaller) (*oauth2.Token, error) {
- return CallTokenEndpoint(ctx, jwtProfileGrantRequest, caller)
+func JWTProfileExchange(jwtProfileGrantRequest *oidc.JWTProfileGrantRequest, caller TokenEndpointCaller) (*oauth2.Token, error) {
+ return CallTokenEndpoint(jwtProfileGrantRequest, caller)
}
func ClientAssertionCodeOptions(assertion string) []oauth2.AuthCodeOption {
diff --git a/pkg/client/key.go b/pkg/client/key.go
index 7f38311..740c6d3 100644
--- a/pkg/client/key.go
+++ b/pkg/client/key.go
@@ -2,7 +2,7 @@ package client
import (
"encoding/json"
- "os"
+ "io/ioutil"
)
const (
@@ -10,7 +10,7 @@ const (
applicationKey = "application"
)
-type KeyFile struct {
+type keyFile struct {
Type string `json:"type"` // serviceaccount or application
KeyID string `json:"keyId"`
Key string `json:"key"`
@@ -23,16 +23,16 @@ type KeyFile struct {
ClientID string `json:"clientId"`
}
-func ConfigFromKeyFile(path string) (*KeyFile, error) {
- data, err := os.ReadFile(path)
+func ConfigFromKeyFile(path string) (*keyFile, error) {
+ data, err := ioutil.ReadFile(path)
if err != nil {
return nil, err
}
return ConfigFromKeyFileData(data)
}
-func ConfigFromKeyFileData(data []byte) (*KeyFile, error) {
- var f KeyFile
+func ConfigFromKeyFileData(data []byte) (*keyFile, error) {
+ var f keyFile
if err := json.Unmarshal(data, &f); err != nil {
return nil, err
}
diff --git a/pkg/client/profile/jwt_profile.go b/pkg/client/profile/jwt_profile.go
index fb351f0..b29fcaa 100644
--- a/pkg/client/profile/jwt_profile.go
+++ b/pkg/client/profile/jwt_profile.go
@@ -1,25 +1,19 @@
package profile
import (
- "context"
"net/http"
"time"
- jose "github.com/go-jose/go-jose/v4"
"golang.org/x/oauth2"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/client"
+ "github.com/zitadel/oidc/pkg/oidc"
)
-type TokenSource interface {
- oauth2.TokenSource
- TokenCtx(context.Context) (*oauth2.Token, error)
-}
-
// jwtProfileTokenSource implement the oauth2.TokenSource
// it will request a token using the OAuth2 JWT Profile Grant
-// therefore sending an `assertion` by signing a JWT with the provided private key
+// therefore sending an `assertion` by singing a JWT with the provided private key
type jwtProfileTokenSource struct {
clientID string
audience []string
@@ -29,38 +23,23 @@ type jwtProfileTokenSource struct {
tokenEndpoint string
}
-// NewJWTProfileTokenSourceFromKeyFile returns an implementation of TokenSource
-// It will request a token using the OAuth2 JWT Profile Grant,
-// therefore sending an `assertion` by singing a JWT with the provided private key from jsonFile.
-//
-// The passed context is only used for the call to the Discover endpoint.
-func NewJWTProfileTokenSourceFromKeyFile(ctx context.Context, issuer, jsonFile string, scopes []string, options ...func(source *jwtProfileTokenSource)) (TokenSource, error) {
- keyData, err := client.ConfigFromKeyFile(jsonFile)
+func NewJWTProfileTokenSourceFromKeyFile(issuer, keyPath string, scopes []string, options ...func(source *jwtProfileTokenSource)) (oauth2.TokenSource, error) {
+ keyData, err := client.ConfigFromKeyFile(keyPath)
if err != nil {
return nil, err
}
- return NewJWTProfileTokenSource(ctx, issuer, keyData.UserID, keyData.KeyID, []byte(keyData.Key), scopes, options...)
+ return NewJWTProfileTokenSource(issuer, keyData.UserID, keyData.KeyID, []byte(keyData.Key), scopes, options...)
}
-// NewJWTProfileTokenSourceFromKeyFileData returns an implementation of oauth2.TokenSource
-// It will request a token using the OAuth2 JWT Profile Grant,
-// therefore sending an `assertion` by singing a JWT with the provided private key in jsonData.
-//
-// The passed context is only used for the call to the Discover endpoint.
-func NewJWTProfileTokenSourceFromKeyFileData(ctx context.Context, issuer string, jsonData []byte, scopes []string, options ...func(source *jwtProfileTokenSource)) (TokenSource, error) {
- keyData, err := client.ConfigFromKeyFileData(jsonData)
+func NewJWTProfileTokenSourceFromKeyFileData(issuer string, data []byte, scopes []string, options ...func(source *jwtProfileTokenSource)) (oauth2.TokenSource, error) {
+ keyData, err := client.ConfigFromKeyFileData(data)
if err != nil {
return nil, err
}
- return NewJWTProfileTokenSource(ctx, issuer, keyData.UserID, keyData.KeyID, []byte(keyData.Key), scopes, options...)
+ return NewJWTProfileTokenSource(issuer, keyData.UserID, keyData.KeyID, []byte(keyData.Key), scopes, options...)
}
-// NewJWTProfileSource returns an implementation of oauth2.TokenSource
-// It will request a token using the OAuth2 JWT Profile Grant,
-// therefore sending an `assertion` by singing a JWT with the provided private key.
-//
-// The passed context is only used for the call to the Discover endpoint.
-func NewJWTProfileTokenSource(ctx context.Context, issuer, clientID, keyID string, key []byte, scopes []string, options ...func(source *jwtProfileTokenSource)) (TokenSource, error) {
+func NewJWTProfileTokenSource(issuer, clientID, keyID string, key []byte, scopes []string, options ...func(source *jwtProfileTokenSource)) (oauth2.TokenSource, error) {
signer, err := client.NewSignerFromPrivateKeyByte(key, keyID)
if err != nil {
return nil, err
@@ -76,7 +55,7 @@ func NewJWTProfileTokenSource(ctx context.Context, issuer, clientID, keyID strin
opt(source)
}
if source.tokenEndpoint == "" {
- config, err := client.Discover(ctx, issuer, source.httpClient)
+ config, err := client.Discover(issuer, source.httpClient)
if err != nil {
return nil, err
}
@@ -85,13 +64,13 @@ func NewJWTProfileTokenSource(ctx context.Context, issuer, clientID, keyID strin
return source, nil
}
-func WithHTTPClient(client *http.Client) func(source *jwtProfileTokenSource) {
+func WithHTTPClient(client *http.Client) func(*jwtProfileTokenSource) {
return func(source *jwtProfileTokenSource) {
source.httpClient = client
}
}
-func WithStaticTokenEndpoint(issuer, tokenEndpoint string) func(source *jwtProfileTokenSource) {
+func WithStaticTokenEndpoint(issuer, tokenEndpoint string) func(*jwtProfileTokenSource) {
return func(source *jwtProfileTokenSource) {
source.tokenEndpoint = tokenEndpoint
}
@@ -106,13 +85,9 @@ func (j *jwtProfileTokenSource) HttpClient() *http.Client {
}
func (j *jwtProfileTokenSource) Token() (*oauth2.Token, error) {
- return j.TokenCtx(context.Background())
-}
-
-func (j *jwtProfileTokenSource) TokenCtx(ctx context.Context) (*oauth2.Token, error) {
assertion, err := client.SignedJWTProfileAssertion(j.clientID, j.audience, time.Hour, j.signer)
if err != nil {
return nil, err
}
- return client.JWTProfileExchange(ctx, oidc.NewJWTProfileGrantRequest(assertion, j.scopes...), j)
+ return client.JWTProfileExchange(oidc.NewJWTProfileGrantRequest(assertion, j.scopes...), j)
}
diff --git a/pkg/client/rp/cli/cli.go b/pkg/client/rp/cli/cli.go
index 10edaa7..6e30e4e 100644
--- a/pkg/client/rp/cli/cli.go
+++ b/pkg/client/rp/cli/cli.go
@@ -4,22 +4,22 @@ import (
"context"
"net/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/client/rp"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
const (
loginPath = "/login"
)
-func CodeFlow[C oidc.IDClaims](ctx context.Context, relyingParty rp.RelyingParty, callbackPath, port string, stateProvider func() string) *oidc.Tokens[C] {
+func CodeFlow(ctx context.Context, relyingParty rp.RelyingParty, callbackPath, port string, stateProvider func() string) *oidc.Tokens {
codeflowCtx, codeflowCancel := context.WithCancel(ctx)
defer codeflowCancel()
- tokenChan := make(chan *oidc.Tokens[C], 1)
+ tokenChan := make(chan *oidc.Tokens, 1)
- callback := func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens[C], state string, rp rp.RelyingParty) {
+ callback := func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, rp rp.RelyingParty) {
tokenChan <- tokens
msg := "Success!
"
msg = msg + "You are authenticated and can now return to the CLI.
"
diff --git a/pkg/client/rp/delegation.go b/pkg/client/rp/delegation.go
index fb4fc63..a2b1f00 100644
--- a/pkg/client/rp/delegation.go
+++ b/pkg/client/rp/delegation.go
@@ -1,13 +1,13 @@
package rp
import (
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc/grants/tokenexchange"
+ "github.com/zitadel/oidc/pkg/oidc/grants/tokenexchange"
)
// DelegationTokenRequest is an implementation of TokenExchangeRequest
// it exchanges an "urn:ietf:params:oauth:token-type:access_token" with an optional
-// "urn:ietf:params:oauth:token-type:access_token" actor token for an
-// "urn:ietf:params:oauth:token-type:access_token" delegation token
+//"urn:ietf:params:oauth:token-type:access_token" actor token for an
+//"urn:ietf:params:oauth:token-type:access_token" delegation token
func DelegationTokenRequest(subjectToken string, opts ...tokenexchange.TokenExchangeOption) *tokenexchange.TokenExchangeRequest {
return tokenexchange.NewTokenExchangeRequest(subjectToken, tokenexchange.AccessTokenType, opts...)
}
diff --git a/pkg/client/rp/device.go b/pkg/client/rp/device.go
deleted file mode 100644
index 1fadd56..0000000
--- a/pkg/client/rp/device.go
+++ /dev/null
@@ -1,69 +0,0 @@
-package rp
-
-import (
- "context"
- "fmt"
- "time"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
-)
-
-func newDeviceClientCredentialsRequest(scopes []string, rp RelyingParty) (*oidc.ClientCredentialsRequest, error) {
- confg := rp.OAuthConfig()
- req := &oidc.ClientCredentialsRequest{
- Scope: scopes,
- ClientID: confg.ClientID,
- ClientSecret: confg.ClientSecret,
- }
-
- if signer := rp.Signer(); signer != nil {
- assertion, err := client.SignedJWTProfileAssertion(rp.OAuthConfig().ClientID, []string{rp.Issuer()}, time.Hour, signer)
- if err != nil {
- return nil, fmt.Errorf("failed to build assertion: %w", err)
- }
- req.ClientAssertion = assertion
- req.ClientAssertionType = oidc.ClientAssertionTypeJWTAssertion
- }
-
- return req, nil
-}
-
-// DeviceAuthorization starts a new Device Authorization flow as defined
-// in RFC 8628, section 3.1 and 3.2:
-// https://www.rfc-editor.org/rfc/rfc8628#section-3.1
-func DeviceAuthorization(ctx context.Context, scopes []string, rp RelyingParty, authFn any) (*oidc.DeviceAuthorizationResponse, error) {
- ctx, span := client.Tracer.Start(ctx, "DeviceAuthorization")
- defer span.End()
-
- ctx = logCtxWithRPData(ctx, rp, "function", "DeviceAuthorization")
- req, err := newDeviceClientCredentialsRequest(scopes, rp)
- if err != nil {
- return nil, err
- }
-
- return client.CallDeviceAuthorizationEndpoint(ctx, req, rp, authFn)
-}
-
-// DeviceAccessToken attempts to obtain tokens from a Device Authorization,
-// by means of polling as defined in RFC, section 3.3 and 3.4:
-// https://www.rfc-editor.org/rfc/rfc8628#section-3.4
-func DeviceAccessToken(ctx context.Context, deviceCode string, interval time.Duration, rp RelyingParty) (resp *oidc.AccessTokenResponse, err error) {
- ctx, span := client.Tracer.Start(ctx, "DeviceAccessToken")
- defer span.End()
-
- ctx = logCtxWithRPData(ctx, rp, "function", "DeviceAccessToken")
- req := &client.DeviceAccessTokenRequest{
- DeviceAccessTokenRequest: oidc.DeviceAccessTokenRequest{
- GrantType: oidc.GrantTypeDeviceCode,
- DeviceCode: deviceCode,
- },
- }
-
- req.ClientCredentialsRequest, err = newDeviceClientCredentialsRequest(nil, rp)
- if err != nil {
- return nil, err
- }
-
- return client.PollDeviceAccessTokenEndpoint(ctx, interval, req, tokenEndpointCaller{rp})
-}
diff --git a/pkg/client/rp/errors.go b/pkg/client/rp/errors.go
deleted file mode 100644
index b95420b..0000000
--- a/pkg/client/rp/errors.go
+++ /dev/null
@@ -1,5 +0,0 @@
-package rp
-
-import "errors"
-
-var ErrRelyingPartyNotSupportRevokeCaller = errors.New("RelyingParty does not support RevokeCaller")
diff --git a/pkg/client/rp/integration_test.go b/pkg/client/rp/integration_test.go
new file mode 100644
index 0000000..732a4bf
--- /dev/null
+++ b/pkg/client/rp/integration_test.go
@@ -0,0 +1,279 @@
+package rp_test
+
+import (
+ "bytes"
+ "context"
+ "io"
+ "io/ioutil"
+ "math/rand"
+ "net/http"
+ "net/http/cookiejar"
+ "net/http/httptest"
+ "net/url"
+ "os"
+ "strconv"
+ "testing"
+ "time"
+
+ "github.com/zitadel/oidc/example/server/exampleop"
+ "github.com/zitadel/oidc/example/server/storage"
+
+ "github.com/jeremija/gosubmit"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+ "github.com/zitadel/oidc/pkg/client/rp"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
+)
+
+func TestRelyingPartySession(t *testing.T) {
+ t.Log("------- start example OP ------")
+ ctx := context.Background()
+ exampleStorage := storage.NewStorage(storage.NewUserStore())
+ var dh deferredHandler
+ opServer := httptest.NewServer(&dh)
+ defer opServer.Close()
+ t.Logf("auth server at %s", opServer.URL)
+ dh.Handler = exampleop.SetupServer(ctx, opServer.URL, exampleStorage)
+
+ targetURL := "http://local-site"
+ localURL, err := url.Parse(targetURL + "/login?requestID=1234")
+ require.NoError(t, err, "local url")
+
+ seed := rand.New(rand.NewSource(int64(os.Getpid()) + time.Now().UnixNano()))
+ clientID := t.Name() + "-" + strconv.FormatInt(seed.Int63(), 25)
+ client := storage.WebClient(clientID, "secret", targetURL)
+ storage.RegisterClients(client)
+
+ jar, err := cookiejar.New(nil)
+ require.NoError(t, err, "create cookie jar")
+ httpClient := &http.Client{
+ Timeout: time.Second * 5,
+ CheckRedirect: func(_ *http.Request, _ []*http.Request) error {
+ return http.ErrUseLastResponse
+ },
+ Jar: jar,
+ }
+
+ t.Log("------- create RP ------")
+ key := []byte("test1234test1234")
+ cookieHandler := httphelper.NewCookieHandler(key, key, httphelper.WithUnsecure())
+ provider, err := rp.NewRelyingPartyOIDC(
+ opServer.URL,
+ clientID,
+ "secret",
+ targetURL,
+ []string{"openid", "email", "profile", "offline_access"},
+ rp.WithPKCE(cookieHandler),
+ rp.WithVerifierOpts(
+ rp.WithIssuedAtOffset(5*time.Second),
+ rp.WithSupportedSigningAlgorithms("RS256", "RS384", "RS512", "ES256", "ES384", "ES512"),
+ ),
+ )
+
+ t.Log("------- get redirect from local client (rp) to OP ------")
+ state := "state-" + strconv.FormatInt(seed.Int63(), 25)
+ capturedW := httptest.NewRecorder()
+ get := httptest.NewRequest("GET", localURL.String(), nil)
+ rp.AuthURLHandler(func() string { return state }, provider,
+ rp.WithPromptURLParam("Hello, World!", "Goodbye, World!"),
+ rp.WithURLParam("custom", "param"),
+ )(capturedW, get)
+
+ defer func() {
+ if t.Failed() {
+ t.Log("response body (redirect from RP to OP)", capturedW.Body.String())
+ }
+ }()
+ require.GreaterOrEqual(t, capturedW.Code, 200, "captured response code")
+ require.Less(t, capturedW.Code, 400, "captured response code")
+ require.Contains(t, capturedW.Body.String(), `prompt=Hello%2C+World%21+Goodbye%2C+World%21`)
+ require.Contains(t, capturedW.Body.String(), `custom=param`)
+
+ //nolint:bodyclose
+ resp := capturedW.Result()
+ jar.SetCookies(localURL, resp.Cookies())
+
+ startAuthURL, err := resp.Location()
+ require.NoError(t, err, "get redirect")
+ assert.NotEmpty(t, startAuthURL, "login url")
+ t.Log("Starting auth at", startAuthURL)
+
+ t.Log("------- get redirect to OP to login page ------")
+ loginPageURL := getRedirect(t, "get redirect to login page", httpClient, startAuthURL)
+ t.Log("login page URL", loginPageURL)
+
+ t.Log("------- get login form ------")
+ form := getForm(t, "get login form", httpClient, loginPageURL)
+ t.Log("login form (unfilled)", string(form))
+ defer func() {
+ if t.Failed() {
+ t.Logf("login form (unfilled): %s", string(form))
+ }
+ }()
+
+ t.Log("------- post to login form, get redirect to OP ------")
+ postLoginRedirectURL := fillForm(t, "fill login form", httpClient, form, loginPageURL,
+ gosubmit.Set("username", "test-user"),
+ gosubmit.Set("password", "verysecure"))
+ t.Logf("Get redirect from %s", postLoginRedirectURL)
+
+ t.Log("------- redirect from OP back to RP ------")
+ codeBearingURL := getRedirect(t, "get redirect with code", httpClient, postLoginRedirectURL)
+ t.Logf("Redirect with code %s", codeBearingURL)
+
+ t.Log("------- exchange code for tokens ------")
+ capturedW = httptest.NewRecorder()
+ get = httptest.NewRequest("GET", codeBearingURL.String(), nil)
+ for _, cookie := range jar.Cookies(codeBearingURL) {
+ get.Header["Cookie"] = append(get.Header["Cookie"], cookie.String())
+ t.Logf("setting cookie %s", cookie)
+ }
+
+ var accessToken, refreshToken, idToken, email string
+ redirect := func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, rp rp.RelyingParty, info oidc.UserInfo) {
+ require.NotNil(t, tokens, "tokens")
+ require.NotNil(t, info, "info")
+ t.Log("access token", tokens.AccessToken)
+ t.Log("refresh token", tokens.RefreshToken)
+ t.Log("id token", tokens.IDToken)
+ t.Log("email", info.GetEmail())
+
+ accessToken = tokens.AccessToken
+ refreshToken = tokens.RefreshToken
+ idToken = tokens.IDToken
+ email = info.GetEmail()
+ http.Redirect(w, r, targetURL, 302)
+ }
+ rp.CodeExchangeHandler(rp.UserinfoCallback(redirect), provider, rp.WithURLParam("custom", "param"))(capturedW, get)
+
+ defer func() {
+ if t.Failed() {
+ t.Log("token exchange response body", capturedW.Body.String())
+ require.GreaterOrEqual(t, capturedW.Code, 200, "captured response code")
+ }
+ }()
+ require.Less(t, capturedW.Code, 400, "token exchange response code")
+ require.Less(t, capturedW.Code, 400, "token exchange response code")
+ // TODO: how to check the custom header was sent to the server?
+
+ //nolint:bodyclose
+ resp = capturedW.Result()
+
+ authorizedURL, err := resp.Location()
+ require.NoError(t, err, "get fully-authorizied redirect location")
+ require.Equal(t, targetURL, authorizedURL.String(), "fully-authorizied redirect location")
+
+ require.NotEmpty(t, idToken, "id token")
+ assert.NotEmpty(t, refreshToken, "refresh token")
+ assert.NotEmpty(t, accessToken, "access token")
+ assert.NotEmpty(t, email, "email")
+
+ t.Log("------- refresh tokens ------")
+
+ newTokens, err := rp.RefreshAccessToken(provider, refreshToken, "", "")
+ require.NoError(t, err, "refresh token")
+ assert.NotNil(t, newTokens, "access token")
+ t.Logf("new access token %s", newTokens.AccessToken)
+ t.Logf("new refresh token %s", newTokens.RefreshToken)
+ t.Logf("new token type %s", newTokens.TokenType)
+ t.Logf("new expiry %s", newTokens.Expiry.Format(time.RFC3339))
+ require.NotEmpty(t, newTokens.AccessToken, "new accessToken")
+
+ t.Log("------ end session (logout) ------")
+
+ newLoc, err := rp.EndSession(provider, idToken, "", "")
+ require.NoError(t, err, "logout")
+ if newLoc != nil {
+ t.Logf("redirect to %s", newLoc)
+ } else {
+ t.Logf("no redirect")
+ }
+
+ t.Log("------ attempt refresh again (should fail) ------")
+ t.Log("trying original refresh token", refreshToken)
+ _, err = rp.RefreshAccessToken(provider, refreshToken, "", "")
+ assert.Errorf(t, err, "refresh with original")
+ if newTokens.RefreshToken != "" {
+ t.Log("trying replacement refresh token", newTokens.RefreshToken)
+ _, err = rp.RefreshAccessToken(provider, newTokens.RefreshToken, "", "")
+ assert.Errorf(t, err, "refresh with replacement")
+ }
+
+ t.Run("WithPrompt", func(t *testing.T) {
+ opts := rp.WithPrompt("foo", "bar")()
+ url := provider.OAuthConfig().AuthCodeURL("some", opts...)
+
+ require.Contains(t, url, "prompt=foo+bar")
+ })
+}
+
+type deferredHandler struct {
+ http.Handler
+}
+
+func getRedirect(t *testing.T, desc string, httpClient *http.Client, uri *url.URL) *url.URL {
+ req := &http.Request{
+ Method: "GET",
+ URL: uri,
+ Header: make(http.Header),
+ }
+ resp, err := httpClient.Do(req)
+ require.NoError(t, err, "GET "+uri.String())
+
+ defer func() {
+ if t.Failed() {
+ body, _ := io.ReadAll(resp.Body)
+ t.Logf("%s: GET %s: body: %s", desc, uri, string(body))
+ }
+ }()
+
+ //nolint:errcheck
+ defer resp.Body.Close()
+ redirect, err := resp.Location()
+ require.NoErrorf(t, err, "%s: get redirect %s", desc, uri)
+ require.NotEmptyf(t, redirect, "%s: get redirect %s", desc, uri)
+ return redirect
+}
+
+func getForm(t *testing.T, desc string, httpClient *http.Client, uri *url.URL) []byte {
+ req := &http.Request{
+ Method: "GET",
+ URL: uri,
+ Header: make(http.Header),
+ }
+ resp, err := httpClient.Do(req)
+ require.NoErrorf(t, err, "%s: GET %s", desc, uri)
+ //nolint:errcheck
+ defer resp.Body.Close()
+ body, err := io.ReadAll(resp.Body)
+ require.NoError(t, err, "%s: read GET %s", desc, uri)
+ return body
+}
+
+func fillForm(t *testing.T, desc string, httpClient *http.Client, body []byte, uri *url.URL, opts ...gosubmit.Option) *url.URL {
+ // TODO: switch to io.NopCloser when go1.15 support is dropped
+ req := gosubmit.ParseWithURL(ioutil.NopCloser(bytes.NewReader(body)), uri.String()).FirstForm().Testing(t).NewTestRequest(
+ append([]gosubmit.Option{gosubmit.AutoFill()}, opts...)...,
+ )
+ if req.URL.Scheme == "" {
+ req.URL = uri
+ t.Log("request lost it's proto..., adding back... request now", req.URL)
+ }
+ req.RequestURI = "" // bug in gosubmit?
+ resp, err := httpClient.Do(req)
+ require.NoErrorf(t, err, "%s: POST %s", desc, uri)
+
+ //nolint:errcheck
+ defer resp.Body.Close()
+ defer func() {
+ if t.Failed() {
+ body, _ := io.ReadAll(resp.Body)
+ t.Logf("%s: GET %s: body: %s", desc, uri, string(body))
+ }
+ }()
+
+ redirect, err := resp.Location()
+ require.NoErrorf(t, err, "%s: redirect for POST %s", desc, uri)
+ return redirect
+}
diff --git a/pkg/client/rp/jwks.go b/pkg/client/rp/jwks.go
index 0ccbad2..cc49eb7 100644
--- a/pkg/client/rp/jwks.go
+++ b/pkg/client/rp/jwks.go
@@ -7,11 +7,10 @@ import (
"net/http"
"sync"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
func NewRemoteKeySet(client *http.Client, jwksURL string, opts ...func(*remoteKeySet)) oidc.KeySet {
@@ -84,9 +83,6 @@ func (i *inflight) result() ([]jose.JSONWebKey, error) {
}
func (r *remoteKeySet) VerifySignature(ctx context.Context, jws *jose.JSONWebSignature) ([]byte, error) {
- ctx, span := client.Tracer.Start(ctx, "VerifySignature")
- defer span.End()
-
keyID, alg := oidc.GetKeyIDAndAlg(jws)
if alg == "" {
alg = r.defaultAlg
@@ -139,9 +135,6 @@ func (r *remoteKeySet) exactMatch(jwkID, jwsID string) bool {
}
func (r *remoteKeySet) verifySignatureRemote(ctx context.Context, jws *jose.JSONWebSignature, keyID, alg string) ([]byte, error) {
- ctx, span := client.Tracer.Start(ctx, "verifySignatureRemote")
- defer span.End()
-
keys, err := r.keysFromRemote(ctx)
if err != nil {
return nil, fmt.Errorf("unable to fetch key for signature validation: %w", err)
@@ -166,9 +159,6 @@ func (r *remoteKeySet) keysFromCache() (keys []jose.JSONWebKey) {
// keysFromRemote syncs the key set from the remote set, records the values in the
// cache, and returns the key set.
func (r *remoteKeySet) keysFromRemote(ctx context.Context) ([]jose.JSONWebKey, error) {
- ctx, span := client.Tracer.Start(ctx, "keysFromRemote")
- defer span.End()
-
// Need to lock to inspect the inflight request field.
r.mu.Lock()
// If there's not a current inflight request, create one.
@@ -192,9 +182,6 @@ func (r *remoteKeySet) keysFromRemote(ctx context.Context) ([]jose.JSONWebKey, e
}
func (r *remoteKeySet) updateKeys(ctx context.Context) {
- ctx, span := client.Tracer.Start(ctx, "updateKeys")
- defer span.End()
-
// Sync keys and finish inflight when that's done.
keys, err := r.fetchRemoteKeys(ctx)
@@ -214,10 +201,7 @@ func (r *remoteKeySet) updateKeys(ctx context.Context) {
}
func (r *remoteKeySet) fetchRemoteKeys(ctx context.Context) ([]jose.JSONWebKey, error) {
- ctx, span := client.Tracer.Start(ctx, "fetchRemoteKeys")
- defer span.End()
-
- req, err := http.NewRequestWithContext(ctx, "GET", r.jwksURL, nil)
+ req, err := http.NewRequest("GET", r.jwksURL, nil)
if err != nil {
return nil, fmt.Errorf("oidc: can't create request: %v", err)
}
diff --git a/pkg/client/rp/log.go b/pkg/client/rp/log.go
deleted file mode 100644
index 556220c..0000000
--- a/pkg/client/rp/log.go
+++ /dev/null
@@ -1,17 +0,0 @@
-package rp
-
-import (
- "context"
- "log/slog"
-
- "github.com/zitadel/logging"
-)
-
-func logCtxWithRPData(ctx context.Context, rp RelyingParty, attrs ...any) context.Context {
- logger, ok := rp.Logger(ctx)
- if !ok {
- return ctx
- }
- logger = logger.With(slog.Group("rp", attrs...))
- return logging.ToContext(ctx, logger)
-}
diff --git a/pkg/client/rp/mock/generate.go b/pkg/client/rp/mock/generate.go
new file mode 100644
index 0000000..1e05701
--- /dev/null
+++ b/pkg/client/rp/mock/generate.go
@@ -0,0 +1,3 @@
+package mock
+
+//go:generate mockgen -package mock -destination ./verifier.mock.go github.com/zitadel/oidc/pkg/rp Verifier
diff --git a/pkg/client/rp/mock/verifier.mock.go b/pkg/client/rp/mock/verifier.mock.go
new file mode 100644
index 0000000..b20db68
--- /dev/null
+++ b/pkg/client/rp/mock/verifier.mock.go
@@ -0,0 +1,67 @@
+// Code generated by MockGen. DO NOT EDIT.
+// Source: github.com/zitadel/oidc/pkg/rp (interfaces: Verifier)
+
+// Package mock is a generated GoMock package.
+package mock
+
+import (
+ "context"
+ "reflect"
+
+ "github.com/golang/mock/gomock"
+
+ "github.com/zitadel/oidc/pkg/oidc"
+)
+
+// MockVerifier is a mock of Verifier interface
+type MockVerifier struct {
+ ctrl *gomock.Controller
+ recorder *MockVerifierMockRecorder
+}
+
+// MockVerifierMockRecorder is the mock recorder for MockVerifier
+type MockVerifierMockRecorder struct {
+ mock *MockVerifier
+}
+
+// NewMockVerifier creates a new mock instance
+func NewMockVerifier(ctrl *gomock.Controller) *MockVerifier {
+ mock := &MockVerifier{ctrl: ctrl}
+ mock.recorder = &MockVerifierMockRecorder{mock}
+ return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use
+func (m *MockVerifier) EXPECT() *MockVerifierMockRecorder {
+ return m.recorder
+}
+
+// Verify mocks base method
+func (m *MockVerifier) Verify(arg0 context.Context, arg1, arg2 string) (*oidc.IDTokenClaims, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "Verify", arg0, arg1, arg2)
+ ret0, _ := ret[0].(*oidc.IDTokenClaims)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// Verify indicates an expected call of Verify
+func (mr *MockVerifierMockRecorder) Verify(arg0, arg1, arg2 interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Verify", reflect.TypeOf((*MockVerifier)(nil).Verify), arg0, arg1, arg2)
+}
+
+// VerifyIDToken mocks base method
+func (m *MockVerifier) VerifyIDToken(arg0 context.Context, arg1 string) (*oidc.IDTokenClaims, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "VerifyIDToken", arg0, arg1)
+ ret0, _ := ret[0].(*oidc.IDTokenClaims)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// VerifyIDToken indicates an expected call of VerifyIDToken
+func (mr *MockVerifierMockRecorder) VerifyIDToken(arg0, arg1 interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "VerifyIDToken", reflect.TypeOf((*MockVerifier)(nil).VerifyIDToken), arg0, arg1)
+}
diff --git a/pkg/client/rp/relying_party.go b/pkg/client/rp/relying_party.go
index c2759a2..3758601 100644
--- a/pkg/client/rp/relying_party.go
+++ b/pkg/client/rp/relying_party.go
@@ -4,20 +4,19 @@ import (
"context"
"encoding/base64"
"errors"
- "log/slog"
+ "fmt"
"net/http"
"net/url"
+ "strings"
"time"
- "github.com/go-jose/go-jose/v4"
"github.com/google/uuid"
"golang.org/x/oauth2"
- "golang.org/x/oauth2/clientcredentials"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/zitadel/logging"
+ "github.com/zitadel/oidc/pkg/client"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
const (
@@ -55,60 +54,39 @@ type RelyingParty interface {
GetEndSessionEndpoint() string
// GetRevokeEndpoint returns the endpoint to revoke a specific token
- GetRevokeEndpoint() string
+ // "GetRevokeEndpoint() string" will be added in a future release
// UserinfoEndpoint returns the userinfo
UserinfoEndpoint() string
- // GetDeviceAuthorizationEndpoint returns the endpoint which can
- // be used to start a DeviceAuthorization flow.
- GetDeviceAuthorizationEndpoint() string
-
- // IDTokenVerifier returns the verifier used for oidc id_token verification
- IDTokenVerifier() *IDTokenVerifier
-
+ // IDTokenVerifier returns the verifier interface used for oidc id_token verification
+ IDTokenVerifier() IDTokenVerifier
// ErrorHandler returns the handler used for callback errors
+
ErrorHandler() func(http.ResponseWriter, *http.Request, string, string, string)
-
- // Logger from the context, or a fallback if set.
- Logger(context.Context) (logger *slog.Logger, ok bool)
-}
-
-type HasUnauthorizedHandler interface {
- // UnauthorizedHandler returns the handler used for unauthorized errors
- UnauthorizedHandler() func(w http.ResponseWriter, r *http.Request, desc string, state string)
}
type ErrorHandler func(w http.ResponseWriter, r *http.Request, errorType string, errorDesc string, state string)
-type UnauthorizedHandler func(w http.ResponseWriter, r *http.Request, desc string, state string)
var DefaultErrorHandler ErrorHandler = func(w http.ResponseWriter, r *http.Request, errorType string, errorDesc string, state string) {
http.Error(w, errorType+": "+errorDesc, http.StatusInternalServerError)
}
-var DefaultUnauthorizedHandler UnauthorizedHandler = func(w http.ResponseWriter, r *http.Request, desc string, state string) {
- http.Error(w, desc, http.StatusUnauthorized)
-}
type relyingParty struct {
- issuer string
- DiscoveryEndpoint string
- endpoints Endpoints
- oauthConfig *oauth2.Config
- oauth2Only bool
- pkce bool
- useSigningAlgsFromDiscovery bool
+ issuer string
+ DiscoveryEndpoint string
+ endpoints Endpoints
+ oauthConfig *oauth2.Config
+ oauth2Only bool
+ pkce bool
httpClient *http.Client
cookieHandler *httphelper.CookieHandler
- oauthAuthStyle oauth2.AuthStyle
-
- errorHandler func(http.ResponseWriter, *http.Request, string, string, string)
- unauthorizedHandler func(http.ResponseWriter, *http.Request, string, string)
- idTokenVerifier *IDTokenVerifier
- verifierOpts []VerifierOption
- signer jose.Signer
- logger *slog.Logger
+ errorHandler func(http.ResponseWriter, *http.Request, string, string, string)
+ idTokenVerifier IDTokenVerifier
+ verifierOpts []VerifierOption
+ signer jose.Signer
}
func (rp *relyingParty) OAuthConfig() *oauth2.Config {
@@ -143,10 +121,6 @@ func (rp *relyingParty) UserinfoEndpoint() string {
return rp.endpoints.UserinfoURL
}
-func (rp *relyingParty) GetDeviceAuthorizationEndpoint() string {
- return rp.endpoints.DeviceAuthorizationURL
-}
-
func (rp *relyingParty) GetEndSessionEndpoint() string {
return rp.endpoints.EndSessionURL
}
@@ -155,7 +129,7 @@ func (rp *relyingParty) GetRevokeEndpoint() string {
return rp.endpoints.RevokeURL
}
-func (rp *relyingParty) IDTokenVerifier() *IDTokenVerifier {
+func (rp *relyingParty) IDTokenVerifier() IDTokenVerifier {
if rp.idTokenVerifier == nil {
rp.idTokenVerifier = NewIDTokenVerifier(rp.issuer, rp.oauthConfig.ClientID, NewRemoteKeySet(rp.httpClient, rp.endpoints.JKWsURL), rp.verifierOpts...)
}
@@ -169,31 +143,14 @@ func (rp *relyingParty) ErrorHandler() func(http.ResponseWriter, *http.Request,
return rp.errorHandler
}
-func (rp *relyingParty) UnauthorizedHandler() func(http.ResponseWriter, *http.Request, string, string) {
- if rp.unauthorizedHandler == nil {
- rp.unauthorizedHandler = DefaultUnauthorizedHandler
- }
- return rp.unauthorizedHandler
-}
-
-func (rp *relyingParty) Logger(ctx context.Context) (logger *slog.Logger, ok bool) {
- logger, ok = logging.FromContext(ctx)
- if ok {
- return logger, ok
- }
- return rp.logger, rp.logger != nil
-}
-
// NewRelyingPartyOAuth creates an (OAuth2) RelyingParty with the given
// OAuth2 Config and possible configOptions
// it will use the AuthURL and TokenURL set in config
func NewRelyingPartyOAuth(config *oauth2.Config, options ...Option) (RelyingParty, error) {
rp := &relyingParty{
- oauthConfig: config,
- httpClient: httphelper.DefaultHTTPClient,
- oauth2Only: true,
- unauthorizedHandler: DefaultUnauthorizedHandler,
- oauthAuthStyle: oauth2.AuthStyleAutoDetect,
+ oauthConfig: config,
+ httpClient: httphelper.DefaultHTTPClient,
+ oauth2Only: true,
}
for _, optFunc := range options {
@@ -202,12 +159,9 @@ func NewRelyingPartyOAuth(config *oauth2.Config, options ...Option) (RelyingPart
}
}
- rp.oauthConfig.Endpoint.AuthStyle = rp.oauthAuthStyle
-
// avoid races by calling these early
- _ = rp.IDTokenVerifier() // sets idTokenVerifier
- _ = rp.ErrorHandler() // sets errorHandler
- _ = rp.UnauthorizedHandler() // sets unauthorizedHandler
+ _ = rp.IDTokenVerifier() // sets idTokenVerifier
+ _ = rp.ErrorHandler() // sets errorHandler
return rp, nil
}
@@ -215,7 +169,7 @@ func NewRelyingPartyOAuth(config *oauth2.Config, options ...Option) (RelyingPart
// NewRelyingPartyOIDC creates an (OIDC) RelyingParty with the given
// issuer, clientID, clientSecret, redirectURI, scopes and possible configOptions
// it will run discovery on the provided issuer and use the found endpoints
-func NewRelyingPartyOIDC(ctx context.Context, issuer, clientID, clientSecret, redirectURI string, scopes []string, options ...Option) (RelyingParty, error) {
+func NewRelyingPartyOIDC(issuer, clientID, clientSecret, redirectURI string, scopes []string, options ...Option) (RelyingParty, error) {
rp := &relyingParty{
issuer: issuer,
oauthConfig: &oauth2.Config{
@@ -224,9 +178,8 @@ func NewRelyingPartyOIDC(ctx context.Context, issuer, clientID, clientSecret, re
RedirectURL: redirectURI,
Scopes: scopes,
},
- httpClient: httphelper.DefaultHTTPClient,
- oauth2Only: false,
- oauthAuthStyle: oauth2.AuthStyleAutoDetect,
+ httpClient: httphelper.DefaultHTTPClient,
+ oauth2Only: false,
}
for _, optFunc := range options {
@@ -234,25 +187,17 @@ func NewRelyingPartyOIDC(ctx context.Context, issuer, clientID, clientSecret, re
return nil, err
}
}
- ctx = logCtxWithRPData(ctx, rp, "function", "NewRelyingPartyOIDC")
- discoveryConfiguration, err := client.Discover(ctx, rp.issuer, rp.httpClient, rp.DiscoveryEndpoint)
+ discoveryConfiguration, err := client.Discover(rp.issuer, rp.httpClient, rp.DiscoveryEndpoint)
if err != nil {
return nil, err
}
- if rp.useSigningAlgsFromDiscovery {
- rp.verifierOpts = append(rp.verifierOpts, WithSupportedSigningAlgorithms(discoveryConfiguration.IDTokenSigningAlgValuesSupported...))
- }
endpoints := GetEndpoints(discoveryConfiguration)
rp.oauthConfig.Endpoint = endpoints.Endpoint
rp.endpoints = endpoints
- rp.oauthConfig.Endpoint.AuthStyle = rp.oauthAuthStyle
- rp.endpoints.Endpoint.AuthStyle = rp.oauthAuthStyle
-
// avoid races by calling these early
- _ = rp.IDTokenVerifier() // sets idTokenVerifier
- _ = rp.ErrorHandler() // sets errorHandler
- _ = rp.UnauthorizedHandler() // sets unauthorizedHandler
+ _ = rp.IDTokenVerifier() // sets idTokenVerifier
+ _ = rp.ErrorHandler() // sets errorHandler
return rp, nil
}
@@ -301,20 +246,6 @@ func WithErrorHandler(errorHandler ErrorHandler) Option {
}
}
-func WithUnauthorizedHandler(unauthorizedHandler UnauthorizedHandler) Option {
- return func(rp *relyingParty) error {
- rp.unauthorizedHandler = unauthorizedHandler
- return nil
- }
-}
-
-func WithAuthStyle(oauthAuthStyle oauth2.AuthStyle) Option {
- return func(rp *relyingParty) error {
- rp.oauthAuthStyle = oauthAuthStyle
- return nil
- }
-}
-
func WithVerifierOpts(opts ...VerifierOption) Option {
return func(rp *relyingParty) error {
rp.verifierOpts = opts
@@ -343,24 +274,6 @@ func WithJWTProfile(signerFromKey SignerFromKey) Option {
}
}
-// WithLogger sets a logger that is used
-// in case the request context does not contain a logger.
-func WithLogger(logger *slog.Logger) Option {
- return func(rp *relyingParty) error {
- rp.logger = logger
- return nil
- }
-}
-
-// WithSigningAlgsFromDiscovery appends the [WithSupportedSigningAlgorithms] option to the Verifier Options.
-// The algorithms returned in the `id_token_signing_alg_values_supported` from the discovery response will be set.
-func WithSigningAlgsFromDiscovery() Option {
- return func(rp *relyingParty) error {
- rp.useSigningAlgsFromDiscovery = true
- return nil
- }
-}
-
type SignerFromKey func() (jose.Signer, error)
func SignerFromKeyPath(path string) SignerFromKey {
@@ -389,6 +302,26 @@ func SignerFromKeyAndKeyID(key []byte, keyID string) SignerFromKey {
}
}
+// Discover calls the discovery endpoint of the provided issuer and returns the found endpoints
+//
+// deprecated: use client.Discover
+func Discover(issuer string, httpClient *http.Client) (Endpoints, error) {
+ wellKnown := strings.TrimSuffix(issuer, "/") + oidc.DiscoveryEndpoint
+ req, err := http.NewRequest("GET", wellKnown, nil)
+ if err != nil {
+ return Endpoints{}, err
+ }
+ discoveryConfig := new(oidc.DiscoveryConfiguration)
+ err = httphelper.HttpRequest(httpClient, req, &discoveryConfig)
+ if err != nil {
+ return Endpoints{}, err
+ }
+ if discoveryConfig.Issuer != issuer {
+ return Endpoints{}, oidc.ErrIssuerInvalid
+ }
+ return GetEndpoints(discoveryConfig), nil
+}
+
// AuthURL returns the auth request url
// (wrapping the oauth2 `AuthCodeURL`)
func AuthURL(state string, rp RelyingParty, opts ...AuthURLOpt) string {
@@ -401,7 +334,7 @@ func AuthURL(state string, rp RelyingParty, opts ...AuthURLOpt) string {
// AuthURLHandler extends the `AuthURL` method with a http redirect handler
// including handling setting cookie for secure `state` transfer.
-// Custom parameters can optionally be set to the redirect URL.
+// Custom paramaters can optionally be set to the redirect URL.
func AuthURLHandler(stateFn func() string, rp RelyingParty, urlParam ...URLParamOpt) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
opts := make([]AuthURLOpt, len(urlParam))
@@ -411,13 +344,13 @@ func AuthURLHandler(stateFn func() string, rp RelyingParty, urlParam ...URLParam
state := stateFn()
if err := trySetStateCookie(w, state, rp); err != nil {
- unauthorizedError(w, r, "failed to create state cookie: "+err.Error(), state, rp)
+ http.Error(w, "failed to create state cookie: "+err.Error(), http.StatusUnauthorized)
return
}
if rp.IsPKCE() {
codeChallenge, err := GenerateAndStoreCodeChallenge(w, rp)
if err != nil {
- unauthorizedError(w, r, "failed to create code challenge: "+err.Error(), state, rp)
+ http.Error(w, "failed to create code challenge: "+err.Error(), http.StatusUnauthorized)
return
}
opts = append(opts, WithCodeChallenge(codeChallenge))
@@ -436,94 +369,53 @@ func GenerateAndStoreCodeChallenge(w http.ResponseWriter, rp RelyingParty) (stri
return oidc.NewSHACodeChallenge(codeVerifier), nil
}
-// ErrMissingIDToken is returned when an id_token was expected,
-// but not received in the token response.
-var ErrMissingIDToken = errors.New("id_token missing")
-
-func verifyTokenResponse[C oidc.IDClaims](ctx context.Context, token *oauth2.Token, rp RelyingParty) (*oidc.Tokens[C], error) {
- ctx, span := client.Tracer.Start(ctx, "verifyTokenResponse")
- defer span.End()
-
- if rp.IsOAuth2Only() {
- return &oidc.Tokens[C]{Token: token}, nil
- }
- idTokenString, ok := token.Extra(idTokenKey).(string)
- if !ok {
- return &oidc.Tokens[C]{Token: token}, ErrMissingIDToken
- }
- idToken, err := VerifyTokens[C](ctx, token.AccessToken, idTokenString, rp.IDTokenVerifier())
- if err != nil {
- return nil, err
- }
- return &oidc.Tokens[C]{Token: token, IDTokenClaims: idToken, IDToken: idTokenString}, nil
-}
-
// CodeExchange handles the oauth2 code exchange, extracting and validating the id_token
// returning it parsed together with the oauth2 tokens (access, refresh)
-func CodeExchange[C oidc.IDClaims](ctx context.Context, code string, rp RelyingParty, opts ...CodeExchangeOpt) (tokens *oidc.Tokens[C], err error) {
- ctx, codeExchangeSpan := client.Tracer.Start(ctx, "CodeExchange")
- defer codeExchangeSpan.End()
-
- ctx = logCtxWithRPData(ctx, rp, "function", "CodeExchange")
+func CodeExchange(ctx context.Context, code string, rp RelyingParty, opts ...CodeExchangeOpt) (tokens *oidc.Tokens, err error) {
ctx = context.WithValue(ctx, oauth2.HTTPClient, rp.HttpClient())
codeOpts := make([]oauth2.AuthCodeOption, 0)
for _, opt := range opts {
codeOpts = append(codeOpts, opt()...)
}
- ctx, oauthExchangeSpan := client.Tracer.Start(ctx, "OAuthExchange")
token, err := rp.OAuthConfig().Exchange(ctx, code, codeOpts...)
if err != nil {
return nil, err
}
- oauthExchangeSpan.End()
- return verifyTokenResponse[C](ctx, token, rp)
-}
-// ClientCredentials requests an access token using the `client_credentials` grant,
-// as defined in [RFC 6749, section 4.4].
-//
-// As there is no user associated to the request an ID Token can never be returned.
-// Client Credentials are undefined in OpenID Connect and is a pure OAuth2 grant.
-// Furthermore the server SHOULD NOT return a refresh token.
-//
-// [RFC 6749, section 4.4]: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
-func ClientCredentials(ctx context.Context, rp RelyingParty, endpointParams url.Values) (token *oauth2.Token, err error) {
- ctx = logCtxWithRPData(ctx, rp, "function", "ClientCredentials")
- ctx, span := client.Tracer.Start(ctx, "ClientCredentials")
- defer span.End()
-
- ctx = context.WithValue(ctx, oauth2.HTTPClient, rp.HttpClient())
- config := clientcredentials.Config{
- ClientID: rp.OAuthConfig().ClientID,
- ClientSecret: rp.OAuthConfig().ClientSecret,
- TokenURL: rp.OAuthConfig().Endpoint.TokenURL,
- Scopes: rp.OAuthConfig().Scopes,
- EndpointParams: endpointParams,
- AuthStyle: rp.OAuthConfig().Endpoint.AuthStyle,
+ if rp.IsOAuth2Only() {
+ return &oidc.Tokens{Token: token}, nil
}
- return config.Token(ctx)
+
+ idTokenString, ok := token.Extra(idTokenKey).(string)
+ if !ok {
+ return nil, errors.New("id_token missing")
+ }
+
+ idToken, err := VerifyTokens(ctx, token.AccessToken, idTokenString, rp.IDTokenVerifier())
+ if err != nil {
+ return nil, err
+ }
+
+ return &oidc.Tokens{Token: token, IDTokenClaims: idToken, IDToken: idTokenString}, nil
}
-type CodeExchangeCallback[C oidc.IDClaims] func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens[C], state string, rp RelyingParty)
+type CodeExchangeCallback func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, rp RelyingParty)
// CodeExchangeHandler extends the `CodeExchange` method with a http handler
// including cookie handling for secure `state` transfer
// and optional PKCE code verifier checking.
-// Custom parameters can optionally be set to the token URL.
-func CodeExchangeHandler[C oidc.IDClaims](callback CodeExchangeCallback[C], rp RelyingParty, urlParam ...URLParamOpt) http.HandlerFunc {
+// Custom paramaters can optionally be set to the token URL.
+func CodeExchangeHandler(callback CodeExchangeCallback, rp RelyingParty, urlParam ...URLParamOpt) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
- ctx, span := client.Tracer.Start(r.Context(), "CodeExchangeHandler")
- r = r.WithContext(ctx)
- defer span.End()
-
state, err := tryReadStateCookie(w, r, rp)
if err != nil {
- unauthorizedError(w, r, "failed to get state: "+err.Error(), state, rp)
+ http.Error(w, "failed to get state: "+err.Error(), http.StatusUnauthorized)
return
}
- if errValue := r.FormValue("error"); errValue != "" {
- rp.ErrorHandler()(w, r, errValue, r.FormValue("error_description"), state)
+ params := r.URL.Query()
+ if params.Get("error") != "" {
+ rp.ErrorHandler()(w, r, params.Get("error"), params.Get("error_description"), state)
return
}
codeOpts := make([]CodeExchangeOpt, len(urlParam))
@@ -534,75 +426,57 @@ func CodeExchangeHandler[C oidc.IDClaims](callback CodeExchangeCallback[C], rp R
if rp.IsPKCE() {
codeVerifier, err := rp.CookieHandler().CheckCookie(r, pkceCode)
if err != nil {
- unauthorizedError(w, r, "failed to get code verifier: "+err.Error(), state, rp)
+ http.Error(w, "failed to get code verifier: "+err.Error(), http.StatusUnauthorized)
return
}
codeOpts = append(codeOpts, WithCodeVerifier(codeVerifier))
- rp.CookieHandler().DeleteCookie(w, pkceCode)
}
if rp.Signer() != nil {
- assertion, err := client.SignedJWTProfileAssertion(rp.OAuthConfig().ClientID, []string{rp.Issuer(), rp.OAuthConfig().Endpoint.TokenURL}, time.Hour, rp.Signer())
+ assertion, err := client.SignedJWTProfileAssertion(rp.OAuthConfig().ClientID, []string{rp.Issuer()}, time.Hour, rp.Signer())
if err != nil {
- unauthorizedError(w, r, "failed to build assertion: "+err.Error(), state, rp)
+ http.Error(w, "failed to build assertion: "+err.Error(), http.StatusUnauthorized)
return
}
codeOpts = append(codeOpts, WithClientAssertionJWT(assertion))
}
- tokens, err := CodeExchange[C](r.Context(), r.FormValue("code"), rp, codeOpts...)
+ tokens, err := CodeExchange(r.Context(), params.Get("code"), rp, codeOpts...)
if err != nil {
- unauthorizedError(w, r, "failed to exchange token: "+err.Error(), state, rp)
+ http.Error(w, "failed to exchange token: "+err.Error(), http.StatusUnauthorized)
return
}
callback(w, r, tokens, state, rp)
}
}
-type SubjectGetter interface {
- GetSubject() string
-}
-
-type CodeExchangeUserinfoCallback[C oidc.IDClaims, U SubjectGetter] func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens[C], state string, provider RelyingParty, info U)
+type CodeExchangeUserinfoCallback func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, provider RelyingParty, info oidc.UserInfo)
// UserinfoCallback wraps the callback function of the CodeExchangeHandler
// and calls the userinfo endpoint with the access token
// on success it will pass the userinfo into its callback function as well
-func UserinfoCallback[C oidc.IDClaims, U SubjectGetter](f CodeExchangeUserinfoCallback[C, U]) CodeExchangeCallback[C] {
- return func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens[C], state string, rp RelyingParty) {
- ctx, span := client.Tracer.Start(r.Context(), "UserinfoCallback")
- r = r.WithContext(ctx)
- defer span.End()
-
- info, err := Userinfo[U](r.Context(), tokens.AccessToken, tokens.TokenType, tokens.IDTokenClaims.GetSubject(), rp)
+func UserinfoCallback(f CodeExchangeUserinfoCallback) CodeExchangeCallback {
+ return func(w http.ResponseWriter, r *http.Request, tokens *oidc.Tokens, state string, rp RelyingParty) {
+ info, err := Userinfo(tokens.AccessToken, tokens.TokenType, tokens.IDTokenClaims.GetSubject(), rp)
if err != nil {
- unauthorizedError(w, r, "userinfo failed: "+err.Error(), state, rp)
+ http.Error(w, "userinfo failed: "+err.Error(), http.StatusUnauthorized)
return
}
f(w, r, tokens, state, rp, info)
}
}
-// Userinfo will call the OIDC [UserInfo] Endpoint with the provided token and returns
-// the response in an instance of type U.
-// [*oidc.UserInfo] can be used as a good example, or use a custom type if type-safe
-// access to custom claims is needed.
-//
-// [UserInfo]: https://openid.net/specs/openid-connect-core-1_0.html#UserInfo
-func Userinfo[U SubjectGetter](ctx context.Context, token, tokenType, subject string, rp RelyingParty) (userinfo U, err error) {
- var nilU U
- ctx = logCtxWithRPData(ctx, rp, "function", "Userinfo")
- ctx, span := client.Tracer.Start(ctx, "Userinfo")
- defer span.End()
-
- req, err := http.NewRequestWithContext(ctx, http.MethodGet, rp.UserinfoEndpoint(), nil)
+// Userinfo will call the OIDC Userinfo Endpoint with the provided token
+func Userinfo(token, tokenType, subject string, rp RelyingParty) (oidc.UserInfo, error) {
+ req, err := http.NewRequest("GET", rp.UserinfoEndpoint(), nil)
if err != nil {
- return nilU, err
+ return nil, err
}
req.Header.Set("authorization", tokenType+" "+token)
+ userinfo := oidc.NewUserInfo()
if err := httphelper.HttpRequest(rp.HttpClient(), req, &userinfo); err != nil {
- return nilU, err
+ return nil, err
}
if userinfo.GetSubject() != subject {
- return nilU, ErrUserInfoSubNotMatching
+ return nil, ErrUserInfoSubNotMatching
}
return userinfo, nil
}
@@ -632,30 +506,29 @@ type OptionFunc func(RelyingParty)
type Endpoints struct {
oauth2.Endpoint
- IntrospectURL string
- UserinfoURL string
- JKWsURL string
- EndSessionURL string
- RevokeURL string
- DeviceAuthorizationURL string
+ IntrospectURL string
+ UserinfoURL string
+ JKWsURL string
+ EndSessionURL string
+ RevokeURL string
}
func GetEndpoints(discoveryConfig *oidc.DiscoveryConfiguration) Endpoints {
return Endpoints{
Endpoint: oauth2.Endpoint{
- AuthURL: discoveryConfig.AuthorizationEndpoint,
- TokenURL: discoveryConfig.TokenEndpoint,
+ AuthURL: discoveryConfig.AuthorizationEndpoint,
+ AuthStyle: oauth2.AuthStyleAutoDetect,
+ TokenURL: discoveryConfig.TokenEndpoint,
},
- IntrospectURL: discoveryConfig.IntrospectionEndpoint,
- UserinfoURL: discoveryConfig.UserinfoEndpoint,
- JKWsURL: discoveryConfig.JwksURI,
- EndSessionURL: discoveryConfig.EndSessionEndpoint,
- RevokeURL: discoveryConfig.RevocationEndpoint,
- DeviceAuthorizationURL: discoveryConfig.DeviceAuthorizationEndpoint,
+ IntrospectURL: discoveryConfig.IntrospectionEndpoint,
+ UserinfoURL: discoveryConfig.UserinfoEndpoint,
+ JKWsURL: discoveryConfig.JwksURI,
+ EndSessionURL: discoveryConfig.EndSessionEndpoint,
+ RevokeURL: discoveryConfig.RevocationEndpoint,
}
}
-// withURLParam sets custom url parameters.
+// withURLParam sets custom url paramaters.
// This is the generalized, unexported, function used by both
// URLParamOpt and AuthURLOpt.
func withURLParam(key, value string) func() []oauth2.AuthCodeOption {
@@ -670,7 +543,7 @@ func withURLParam(key, value string) func() []oauth2.AuthCodeOption {
// This is the generalized, unexported, function used by both
// URLParamOpt and AuthURLOpt.
func withPrompt(prompt ...string) func() []oauth2.AuthCodeOption {
- return withURLParam("prompt", oidc.SpaceDelimitedArray(prompt).String())
+ return withURLParam("prompt", oidc.SpaceDelimitedArray(prompt).Encode())
}
type URLParamOpt func() []oauth2.AuthCodeOption
@@ -686,11 +559,6 @@ func WithPromptURLParam(prompt ...string) URLParamOpt {
return withPrompt(prompt...)
}
-// WithResponseModeURLParam sets the `response_mode` parameter in a URL.
-func WithResponseModeURLParam(mode oidc.ResponseMode) URLParamOpt {
- return withURLParam("response_mode", string(mode))
-}
-
type AuthURLOpt func() []oauth2.AuthCodeOption
// WithCodeChallenge sets the `code_challenge` params in the auth request
@@ -734,26 +602,15 @@ func (t tokenEndpointCaller) TokenEndpoint() string {
type RefreshTokenRequest struct {
RefreshToken string `schema:"refresh_token"`
- Scopes oidc.SpaceDelimitedArray `schema:"scope,omitempty"`
- ClientID string `schema:"client_id,omitempty"`
- ClientSecret string `schema:"client_secret,omitempty"`
- ClientAssertion string `schema:"client_assertion,omitempty"`
- ClientAssertionType string `schema:"client_assertion_type,omitempty"`
+ Scopes oidc.SpaceDelimitedArray `schema:"scope"`
+ ClientID string `schema:"client_id"`
+ ClientSecret string `schema:"client_secret"`
+ ClientAssertion string `schema:"client_assertion"`
+ ClientAssertionType string `schema:"client_assertion_type"`
GrantType oidc.GrantType `schema:"grant_type"`
}
-// RefreshTokens performs a token refresh. If it doesn't error, it will always
-// provide a new AccessToken. It may provide a new RefreshToken, and if it does, then
-// the old one should be considered invalid.
-//
-// In case the RP is not OAuth2 only and an IDToken was part of the response,
-// the IDToken and AccessToken will be verified
-// and the IDToken and IDTokenClaims fields will be populated in the returned object.
-func RefreshTokens[C oidc.IDClaims](ctx context.Context, rp RelyingParty, refreshToken, clientAssertion, clientAssertionType string) (*oidc.Tokens[C], error) {
- ctx, span := client.Tracer.Start(ctx, "RefreshTokens")
- defer span.End()
-
- ctx = logCtxWithRPData(ctx, rp, "function", "RefreshTokens")
+func RefreshAccessToken(rp RelyingParty, refreshToken, clientAssertion, clientAssertionType string) (*oauth2.Token, error) {
request := RefreshTokenRequest{
RefreshToken: refreshToken,
Scopes: rp.OAuthConfig().Scopes,
@@ -763,31 +620,17 @@ func RefreshTokens[C oidc.IDClaims](ctx context.Context, rp RelyingParty, refres
ClientAssertionType: clientAssertionType,
GrantType: oidc.GrantTypeRefreshToken,
}
- newToken, err := client.CallTokenEndpoint(ctx, request, tokenEndpointCaller{RelyingParty: rp})
- if err != nil {
- return nil, err
- }
- tokens, err := verifyTokenResponse[C](ctx, newToken, rp)
- if err == nil || errors.Is(err, ErrMissingIDToken) {
- // https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokenResponse
- // ...except that it might not contain an id_token.
- return tokens, nil
- }
- return nil, err
+ return client.CallTokenEndpoint(request, tokenEndpointCaller{RelyingParty: rp})
}
-func EndSession(ctx context.Context, rp RelyingParty, idToken, optionalRedirectURI, optionalState string) (*url.URL, error) {
- ctx = logCtxWithRPData(ctx, rp, "function", "EndSession")
- ctx, span := client.Tracer.Start(ctx, "RefreshTokens")
- defer span.End()
-
+func EndSession(rp RelyingParty, idToken, optionalRedirectURI, optionalState string) (*url.URL, error) {
request := oidc.EndSessionRequest{
IdTokenHint: idToken,
ClientID: rp.OAuthConfig().ClientID,
PostLogoutRedirectURI: optionalRedirectURI,
State: optionalState,
}
- return client.CallEndSessionEndpoint(ctx, request, nil, rp)
+ return client.CallEndSessionEndpoint(request, nil, rp)
}
// RevokeToken requires a RelyingParty that is also a client.RevokeCaller. The RelyingParty
@@ -795,10 +638,7 @@ func EndSession(ctx context.Context, rp RelyingParty, idToken, optionalRedirectU
// NewRelyingPartyOAuth() does not.
//
// tokenTypeHint should be either "id_token" or "refresh_token".
-func RevokeToken(ctx context.Context, rp RelyingParty, token string, tokenTypeHint string) error {
- ctx = logCtxWithRPData(ctx, rp, "function", "RevokeToken")
- ctx, span := client.Tracer.Start(ctx, "RefreshTokens")
- defer span.End()
+func RevokeToken(rp RelyingParty, token string, tokenTypeHint string) error {
request := client.RevokeRequest{
Token: token,
TokenTypeHint: tokenTypeHint,
@@ -806,15 +646,7 @@ func RevokeToken(ctx context.Context, rp RelyingParty, token string, tokenTypeHi
ClientSecret: rp.OAuthConfig().ClientSecret,
}
if rc, ok := rp.(client.RevokeCaller); ok && rc.GetRevokeEndpoint() != "" {
- return client.CallRevokeEndpoint(ctx, request, nil, rc)
+ return client.CallRevokeEndpoint(request, nil, rc)
}
- return ErrRelyingPartyNotSupportRevokeCaller
-}
-
-func unauthorizedError(w http.ResponseWriter, r *http.Request, desc string, state string, rp RelyingParty) {
- if rp, ok := rp.(HasUnauthorizedHandler); ok {
- rp.UnauthorizedHandler()(w, r, desc, state)
- return
- }
- http.Error(w, desc, http.StatusUnauthorized)
+ return fmt.Errorf("RelyingParty does not support RevokeCaller")
}
diff --git a/pkg/client/rp/relying_party_test.go b/pkg/client/rp/relying_party_test.go
deleted file mode 100644
index b3bb6ee..0000000
--- a/pkg/client/rp/relying_party_test.go
+++ /dev/null
@@ -1,107 +0,0 @@
-package rp
-
-import (
- "context"
- "testing"
- "time"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "golang.org/x/oauth2"
-)
-
-func Test_verifyTokenResponse(t *testing.T) {
- verifier := &IDTokenVerifier{
- Issuer: tu.ValidIssuer,
- MaxAgeIAT: 2 * time.Minute,
- ClientID: tu.ValidClientID,
- Offset: time.Second,
- SupportedSignAlgs: []string{string(tu.SignatureAlgorithm)},
- KeySet: tu.KeySet{},
- MaxAge: 2 * time.Minute,
- ACR: tu.ACRVerify,
- Nonce: func(context.Context) string { return tu.ValidNonce },
- }
- tests := []struct {
- name string
- oauth2Only bool
- tokens func() (token *oauth2.Token, want *oidc.Tokens[*oidc.IDTokenClaims])
- wantErr error
- }{
- {
- name: "succes, oauth2 only",
- oauth2Only: true,
- tokens: func() (*oauth2.Token, *oidc.Tokens[*oidc.IDTokenClaims]) {
- accesToken, _ := tu.ValidAccessToken()
- token := &oauth2.Token{
- AccessToken: accesToken,
- }
- return token, &oidc.Tokens[*oidc.IDTokenClaims]{
- Token: token,
- }
- },
- },
- {
- name: "id_token missing error",
- oauth2Only: false,
- tokens: func() (*oauth2.Token, *oidc.Tokens[*oidc.IDTokenClaims]) {
- accesToken, _ := tu.ValidAccessToken()
- token := &oauth2.Token{
- AccessToken: accesToken,
- }
- return token, &oidc.Tokens[*oidc.IDTokenClaims]{
- Token: token,
- }
- },
- wantErr: ErrMissingIDToken,
- },
- {
- name: "verify tokens error",
- oauth2Only: false,
- tokens: func() (*oauth2.Token, *oidc.Tokens[*oidc.IDTokenClaims]) {
- accesToken, _ := tu.ValidAccessToken()
- token := &oauth2.Token{
- AccessToken: accesToken,
- }
- token = token.WithExtra(map[string]any{
- "id_token": "foobar",
- })
- return token, nil
- },
- wantErr: oidc.ErrParse,
- },
- {
- name: "success, with id_token",
- oauth2Only: false,
- tokens: func() (*oauth2.Token, *oidc.Tokens[*oidc.IDTokenClaims]) {
- accesToken, _ := tu.ValidAccessToken()
- token := &oauth2.Token{
- AccessToken: accesToken,
- }
- idToken, claims := tu.ValidIDToken()
- token = token.WithExtra(map[string]any{
- "id_token": idToken,
- })
- return token, &oidc.Tokens[*oidc.IDTokenClaims]{
- Token: token,
- IDTokenClaims: claims,
- IDToken: idToken,
- }
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- rp := &relyingParty{
- oauth2Only: tt.oauth2Only,
- idTokenVerifier: verifier,
- }
- token, want := tt.tokens()
- got, err := verifyTokenResponse[*oidc.IDTokenClaims](context.Background(), token, rp)
- require.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, want, got)
- })
- }
-}
diff --git a/pkg/client/rp/tockenexchange.go b/pkg/client/rp/tockenexchange.go
index aa2cf99..3950fe1 100644
--- a/pkg/client/rp/tockenexchange.go
+++ b/pkg/client/rp/tockenexchange.go
@@ -5,7 +5,7 @@ import (
"golang.org/x/oauth2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc/grants/tokenexchange"
+ "github.com/zitadel/oidc/pkg/oidc/grants/tokenexchange"
)
// TokenExchangeRP extends the `RelyingParty` interface for the *draft* oauth2 `Token Exchange`
diff --git a/pkg/client/rp/userinfo_example_test.go b/pkg/client/rp/userinfo_example_test.go
deleted file mode 100644
index 78e014e..0000000
--- a/pkg/client/rp/userinfo_example_test.go
+++ /dev/null
@@ -1,45 +0,0 @@
-package rp_test
-
-import (
- "context"
- "fmt"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
-)
-
-type UserInfo struct {
- Subject string `json:"sub,omitempty"`
- oidc.UserInfoProfile
- oidc.UserInfoEmail
- oidc.UserInfoPhone
- Address *oidc.UserInfoAddress `json:"address,omitempty"`
-
- // Foo and Bar are custom claims
- Foo string `json:"foo,omitempty"`
- Bar struct {
- Val1 string `json:"val_1,omitempty"`
- Val2 string `json:"val_2,omitempty"`
- } `json:"bar,omitempty"`
-
- // Claims are all the combined claims, including custom.
- Claims map[string]any `json:"-,omitempty"`
-}
-
-func (u *UserInfo) GetSubject() string {
- return u.Subject
-}
-
-func ExampleUserinfo_custom() {
- rpo, err := rp.NewRelyingPartyOIDC(context.TODO(), "http://localhost:8080", "clientid", "clientsecret", "http://example.com/redirect", []string{oidc.ScopeOpenID, oidc.ScopeProfile, oidc.ScopeEmail, oidc.ScopePhone})
- if err != nil {
- panic(err)
- }
-
- info, err := rp.Userinfo[*UserInfo](context.TODO(), "accesstokenstring", "Bearer", "userid", rpo)
- if err != nil {
- panic(err)
- }
-
- fmt.Println(info)
-}
diff --git a/pkg/client/rp/verifier.go b/pkg/client/rp/verifier.go
index 0088b81..6b3b3fd 100644
--- a/pkg/client/rp/verifier.go
+++ b/pkg/client/rp/verifier.go
@@ -4,95 +4,92 @@ import (
"context"
"time"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/oidc"
)
+type IDTokenVerifier interface {
+ oidc.Verifier
+ ClientID() string
+ SupportedSignAlgs() []string
+ KeySet() oidc.KeySet
+ Nonce(context.Context) string
+ ACR() oidc.ACRVerifier
+ MaxAge() time.Duration
+}
+
// VerifyTokens implement the Token Response Validation as defined in OIDC specification
-// https://openid.net/specs/openid-connect-core-1_0.html#TokenResponseValidation
-func VerifyTokens[C oidc.IDClaims](ctx context.Context, accessToken, idToken string, v *IDTokenVerifier) (claims C, err error) {
- ctx, span := client.Tracer.Start(ctx, "VerifyTokens")
- defer span.End()
-
- var nilClaims C
-
- claims, err = VerifyIDToken[C](ctx, idToken, v)
+//https://openid.net/specs/openid-connect-core-1_0.html#TokenResponseValidation
+func VerifyTokens(ctx context.Context, accessToken, idTokenString string, v IDTokenVerifier) (oidc.IDTokenClaims, error) {
+ idToken, err := VerifyIDToken(ctx, idTokenString, v)
if err != nil {
- return nilClaims, err
+ return nil, err
}
- if err := VerifyAccessToken(accessToken, claims.GetAccessTokenHash(), claims.GetSignatureAlgorithm()); err != nil {
- return nilClaims, err
+ if err := VerifyAccessToken(accessToken, idToken.GetAccessTokenHash(), idToken.GetSignatureAlgorithm()); err != nil {
+ return nil, err
}
- return claims, nil
+ return idToken, nil
}
// VerifyIDToken validates the id token according to
-// https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
-func VerifyIDToken[C oidc.Claims](ctx context.Context, token string, v *IDTokenVerifier) (claims C, err error) {
- ctx, span := client.Tracer.Start(ctx, "VerifyIDToken")
- defer span.End()
-
- var nilClaims C
+//https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
+func VerifyIDToken(ctx context.Context, token string, v IDTokenVerifier) (oidc.IDTokenClaims, error) {
+ claims := oidc.EmptyIDTokenClaims()
decrypted, err := oidc.DecryptToken(token)
if err != nil {
- return nilClaims, err
+ return nil, err
}
- payload, err := oidc.ParseToken(decrypted, &claims)
+ payload, err := oidc.ParseToken(decrypted, claims)
if err != nil {
- return nilClaims, err
+ return nil, err
}
if err := oidc.CheckSubject(claims); err != nil {
- return nilClaims, err
+ return nil, err
}
- if err = oidc.CheckIssuer(claims, v.Issuer); err != nil {
- return nilClaims, err
+ if err = oidc.CheckIssuer(claims, v.Issuer()); err != nil {
+ return nil, err
}
- if err = oidc.CheckAudience(claims, v.ClientID); err != nil {
- return nilClaims, err
+ if err = oidc.CheckAudience(claims, v.ClientID()); err != nil {
+ return nil, err
}
- if err = oidc.CheckAuthorizedParty(claims, v.ClientID); err != nil {
- return nilClaims, err
+ if err = oidc.CheckAuthorizedParty(claims, v.ClientID()); err != nil {
+ return nil, err
}
- if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs, v.KeySet); err != nil {
- return nilClaims, err
+ if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs(), v.KeySet()); err != nil {
+ return nil, err
}
- if err = oidc.CheckExpiration(claims, v.Offset); err != nil {
- return nilClaims, err
+ if err = oidc.CheckExpiration(claims, v.Offset()); err != nil {
+ return nil, err
}
- if err = oidc.CheckIssuedAt(claims, v.MaxAgeIAT, v.Offset); err != nil {
- return nilClaims, err
+ if err = oidc.CheckIssuedAt(claims, v.MaxAgeIAT(), v.Offset()); err != nil {
+ return nil, err
}
- if v.Nonce != nil {
- if err = oidc.CheckNonce(claims, v.Nonce(ctx)); err != nil {
- return nilClaims, err
- }
+ if err = oidc.CheckNonce(claims, v.Nonce(ctx)); err != nil {
+ return nil, err
}
- if err = oidc.CheckAuthorizationContextClassReference(claims, v.ACR); err != nil {
- return nilClaims, err
+ if err = oidc.CheckAuthorizationContextClassReference(claims, v.ACR()); err != nil {
+ return nil, err
}
- if err = oidc.CheckAuthTime(claims, v.MaxAge); err != nil {
- return nilClaims, err
+ if err = oidc.CheckAuthTime(claims, v.MaxAge()); err != nil {
+ return nil, err
}
return claims, nil
}
-type IDTokenVerifier oidc.Verifier
-
// VerifyAccessToken validates the access token according to
-// https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowTokenValidation
+//https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowTokenValidation
func VerifyAccessToken(accessToken, atHash string, sigAlgorithm jose.SignatureAlgorithm) error {
if atHash == "" {
return nil
@@ -108,14 +105,15 @@ func VerifyAccessToken(accessToken, atHash string, sigAlgorithm jose.SignatureAl
return nil
}
-// NewIDTokenVerifier returns a oidc.Verifier suitable for ID token verification.
-func NewIDTokenVerifier(issuer, clientID string, keySet oidc.KeySet, options ...VerifierOption) *IDTokenVerifier {
- v := &IDTokenVerifier{
- Issuer: issuer,
- ClientID: clientID,
- KeySet: keySet,
- Offset: time.Second,
- Nonce: func(_ context.Context) string {
+// NewIDTokenVerifier returns an implementation of `IDTokenVerifier`
+// for `VerifyTokens` and `VerifyIDToken`
+func NewIDTokenVerifier(issuer, clientID string, keySet oidc.KeySet, options ...VerifierOption) IDTokenVerifier {
+ v := &idTokenVerifier{
+ issuer: issuer,
+ clientID: clientID,
+ keySet: keySet,
+ offset: 1 * time.Second,
+ nonce: func(_ context.Context) string {
return ""
},
}
@@ -128,47 +126,95 @@ func NewIDTokenVerifier(issuer, clientID string, keySet oidc.KeySet, options ...
}
// VerifierOption is the type for providing dynamic options to the IDTokenVerifier
-type VerifierOption func(*IDTokenVerifier)
+type VerifierOption func(*idTokenVerifier)
// WithIssuedAtOffset mitigates the risk of iat to be in the future
// because of clock skews with the ability to add an offset to the current time
-func WithIssuedAtOffset(offset time.Duration) VerifierOption {
- return func(v *IDTokenVerifier) {
- v.Offset = offset
+func WithIssuedAtOffset(offset time.Duration) func(*idTokenVerifier) {
+ return func(v *idTokenVerifier) {
+ v.offset = offset
}
}
// WithIssuedAtMaxAge provides the ability to define the maximum duration between iat and now
-func WithIssuedAtMaxAge(maxAge time.Duration) VerifierOption {
- return func(v *IDTokenVerifier) {
- v.MaxAgeIAT = maxAge
+func WithIssuedAtMaxAge(maxAge time.Duration) func(*idTokenVerifier) {
+ return func(v *idTokenVerifier) {
+ v.maxAge = maxAge
}
}
// WithNonce sets the function to check the nonce
func WithNonce(nonce func(context.Context) string) VerifierOption {
- return func(v *IDTokenVerifier) {
- v.Nonce = nonce
+ return func(v *idTokenVerifier) {
+ v.nonce = nonce
}
}
// WithACRVerifier sets the verifier for the acr claim
func WithACRVerifier(verifier oidc.ACRVerifier) VerifierOption {
- return func(v *IDTokenVerifier) {
- v.ACR = verifier
+ return func(v *idTokenVerifier) {
+ v.acr = verifier
}
}
// WithAuthTimeMaxAge provides the ability to define the maximum duration between auth_time and now
func WithAuthTimeMaxAge(maxAge time.Duration) VerifierOption {
- return func(v *IDTokenVerifier) {
- v.MaxAge = maxAge
+ return func(v *idTokenVerifier) {
+ v.maxAge = maxAge
}
}
// WithSupportedSigningAlgorithms overwrites the default RS256 signing algorithm
func WithSupportedSigningAlgorithms(algs ...string) VerifierOption {
- return func(v *IDTokenVerifier) {
- v.SupportedSignAlgs = algs
+ return func(v *idTokenVerifier) {
+ v.supportedSignAlgs = algs
}
}
+
+type idTokenVerifier struct {
+ issuer string
+ maxAgeIAT time.Duration
+ offset time.Duration
+ clientID string
+ supportedSignAlgs []string
+ keySet oidc.KeySet
+ acr oidc.ACRVerifier
+ maxAge time.Duration
+ nonce func(ctx context.Context) string
+}
+
+func (i *idTokenVerifier) Issuer() string {
+ return i.issuer
+}
+
+func (i *idTokenVerifier) MaxAgeIAT() time.Duration {
+ return i.maxAgeIAT
+}
+
+func (i *idTokenVerifier) Offset() time.Duration {
+ return i.offset
+}
+
+func (i *idTokenVerifier) ClientID() string {
+ return i.clientID
+}
+
+func (i *idTokenVerifier) SupportedSignAlgs() []string {
+ return i.supportedSignAlgs
+}
+
+func (i *idTokenVerifier) KeySet() oidc.KeySet {
+ return i.keySet
+}
+
+func (i *idTokenVerifier) Nonce(ctx context.Context) string {
+ return i.nonce(ctx)
+}
+
+func (i *idTokenVerifier) ACR() oidc.ACRVerifier {
+ return i.acr
+}
+
+func (i *idTokenVerifier) MaxAge() time.Duration {
+ return i.maxAge
+}
diff --git a/pkg/client/rp/verifier_test.go b/pkg/client/rp/verifier_test.go
deleted file mode 100644
index 38f5a4a..0000000
--- a/pkg/client/rp/verifier_test.go
+++ /dev/null
@@ -1,359 +0,0 @@
-package rp
-
-import (
- "context"
- "testing"
- "time"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- jose "github.com/go-jose/go-jose/v4"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestVerifyTokens(t *testing.T) {
- verifier := &IDTokenVerifier{
- Issuer: tu.ValidIssuer,
- MaxAgeIAT: 2 * time.Minute,
- Offset: time.Second,
- SupportedSignAlgs: []string{string(tu.SignatureAlgorithm)},
- KeySet: tu.KeySet{},
- MaxAge: 2 * time.Minute,
- ACR: tu.ACRVerify,
- Nonce: func(context.Context) string { return tu.ValidNonce },
- ClientID: tu.ValidClientID,
- }
- accessToken, _ := tu.ValidAccessToken()
- atHash, err := oidc.ClaimHash(accessToken, tu.SignatureAlgorithm)
- require.NoError(t, err)
-
- tests := []struct {
- name string
- accessToken string
- idTokenClaims func() (string, *oidc.IDTokenClaims)
- wantErr bool
- }{
- {
- name: "without access token",
- idTokenClaims: tu.ValidIDToken,
- },
- {
- name: "with access token",
- accessToken: accessToken,
- idTokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, atHash,
- )
- },
- },
- {
- name: "expired id token",
- accessToken: accessToken,
- idTokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration.Add(-time.Hour), tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, atHash,
- )
- },
- wantErr: true,
- },
- {
- name: "wrong access token",
- accessToken: accessToken,
- idTokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "~~~",
- )
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- idToken, want := tt.idTokenClaims()
- got, err := VerifyTokens[*oidc.IDTokenClaims](context.Background(), tt.accessToken, idToken, verifier)
- if tt.wantErr {
- assert.Error(t, err)
- assert.Nil(t, got)
- return
- }
- require.NoError(t, err)
- require.NotNil(t, got)
- assert.Equal(t, got, want)
- })
- }
-}
-
-func TestVerifyIDToken(t *testing.T) {
- verifier := &IDTokenVerifier{
- Issuer: tu.ValidIssuer,
- MaxAgeIAT: 2 * time.Minute,
- Offset: time.Second,
- SupportedSignAlgs: []string{string(tu.SignatureAlgorithm)},
- KeySet: tu.KeySet{},
- MaxAge: 2 * time.Minute,
- ACR: tu.ACRVerify,
- Nonce: func(context.Context) string { return tu.ValidNonce },
- ClientID: tu.ValidClientID,
- }
-
- tests := []struct {
- name string
- tokenClaims func() (string, *oidc.IDTokenClaims)
- customVerifier func(verifier *IDTokenVerifier)
- wantErr bool
- }{
- {
- name: "success",
- tokenClaims: tu.ValidIDToken,
- },
- {
- name: "custom claims",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDTokenCustom(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- map[string]any{"some": "thing"},
- )
- },
- },
- {
- name: "skip nonce check",
- customVerifier: func(verifier *IDTokenVerifier) {
- verifier.Nonce = nil
- },
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, "foo",
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- },
- {
- name: "parse err",
- tokenClaims: func() (string, *oidc.IDTokenClaims) { return "~~~~", nil },
- wantErr: true,
- },
- {
- name: "invalid signature",
- tokenClaims: func() (string, *oidc.IDTokenClaims) { return tu.InvalidSignatureToken, nil },
- wantErr: true,
- },
- {
- name: "empty subject",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, "", tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: true,
- },
- {
- name: "wrong issuer",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- "foo", tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: true,
- },
- {
- name: "wrong clientID",
- customVerifier: func(verifier *IDTokenVerifier) {
- verifier.ClientID = "foo"
- },
- tokenClaims: tu.ValidIDToken,
- wantErr: true,
- },
- {
- name: "expired",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration.Add(-time.Hour), tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: true,
- },
- {
- name: "wrong IAT",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, -time.Hour, "",
- )
- },
- wantErr: true,
- },
- {
- name: "wrong acr",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- "else", tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: true,
- },
- {
- name: "expired auth",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime.Add(-time.Hour), tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: true,
- },
- {
- name: "wrong nonce",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, "foo",
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- token, want := tt.tokenClaims()
- if tt.customVerifier != nil {
- tt.customVerifier(verifier)
- }
-
- got, err := VerifyIDToken[*oidc.IDTokenClaims](context.Background(), token, verifier)
- if tt.wantErr {
- assert.Error(t, err)
- assert.Nil(t, got)
- return
- }
- require.NoError(t, err)
- require.NotNil(t, got)
- assert.Equal(t, got, want)
- })
- }
-}
-
-func TestVerifyAccessToken(t *testing.T) {
- token, _ := tu.ValidAccessToken()
- hash, err := oidc.ClaimHash(token, tu.SignatureAlgorithm)
- require.NoError(t, err)
-
- type args struct {
- accessToken string
- atHash string
- sigAlgorithm jose.SignatureAlgorithm
- }
- tests := []struct {
- name string
- args args
- wantErr bool
- }{
- {
- name: "empty hash",
- },
- {
- name: "success",
- args: args{
- accessToken: token,
- atHash: hash,
- sigAlgorithm: tu.SignatureAlgorithm,
- },
- },
- {
- name: "invalid algorithm",
- args: args{
- accessToken: token,
- atHash: hash,
- sigAlgorithm: "foo",
- },
- wantErr: true,
- },
- {
- name: "mismatch",
- args: args{
- accessToken: token,
- atHash: "~~",
- sigAlgorithm: tu.SignatureAlgorithm,
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := VerifyAccessToken(tt.args.accessToken, tt.args.atHash, tt.args.sigAlgorithm)
- if tt.wantErr {
- assert.Error(t, err)
- return
- }
- require.NoError(t, err)
- })
- }
-}
-
-func TestNewIDTokenVerifier(t *testing.T) {
- type args struct {
- issuer string
- clientID string
- keySet oidc.KeySet
- options []VerifierOption
- }
- tests := []struct {
- name string
- args args
- want *IDTokenVerifier
- }{
- {
- name: "nil nonce", // otherwise assert.Equal will fail on the function
- args: args{
- issuer: tu.ValidIssuer,
- clientID: tu.ValidClientID,
- keySet: tu.KeySet{},
- options: []VerifierOption{
- WithIssuedAtOffset(time.Minute),
- WithIssuedAtMaxAge(time.Hour),
- WithNonce(nil), // otherwise assert.Equal will fail on the function
- WithACRVerifier(nil),
- WithAuthTimeMaxAge(2 * time.Hour),
- WithSupportedSigningAlgorithms("ABC", "DEF"),
- },
- },
- want: &IDTokenVerifier{
- Issuer: tu.ValidIssuer,
- Offset: time.Minute,
- MaxAgeIAT: time.Hour,
- ClientID: tu.ValidClientID,
- KeySet: tu.KeySet{},
- Nonce: nil,
- ACR: nil,
- MaxAge: 2 * time.Hour,
- SupportedSignAlgs: []string{"ABC", "DEF"},
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := NewIDTokenVerifier(tt.args.issuer, tt.args.clientID, tt.args.keySet, tt.args.options...)
- assert.Equal(t, tt.want, got)
- })
- }
-}
diff --git a/pkg/client/rp/verifier_tokens_example_test.go b/pkg/client/rp/verifier_tokens_example_test.go
deleted file mode 100644
index 7ae68d6..0000000
--- a/pkg/client/rp/verifier_tokens_example_test.go
+++ /dev/null
@@ -1,86 +0,0 @@
-package rp_test
-
-import (
- "context"
- "fmt"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rp"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
-)
-
-// MyCustomClaims extends the TokenClaims base,
-// so it implmeents the oidc.Claims interface.
-// Instead of carrying a map, we add needed fields// to the struct for type safe access.
-type MyCustomClaims struct {
- oidc.TokenClaims
- NotBefore oidc.Time `json:"nbf,omitempty"`
- AccessTokenHash string `json:"at_hash,omitempty"`
- Foo string `json:"foo,omitempty"`
- Bar *Nested `json:"bar,omitempty"`
-}
-
-// GetAccessTokenHash is required to implement
-// the oidc.IDClaims interface.
-func (c *MyCustomClaims) GetAccessTokenHash() string {
- return c.AccessTokenHash
-}
-
-// Nested struct types are also possible.
-type Nested struct {
- Count int `json:"count,omitempty"`
- Tags []string `json:"tags,omitempty"`
-}
-
-/*
-idToken carries the following claims. foo and bar are custom claims
-
- {
- "acr": "something",
- "amr": [
- "foo",
- "bar"
- ],
- "at_hash": "2dzbm_vIxy-7eRtqUIGPPw",
- "aud": [
- "unit",
- "test",
- "555666"
- ],
- "auth_time": 1678100961,
- "azp": "555666",
- "bar": {
- "count": 22,
- "tags": [
- "some",
- "tags"
- ]
- },
- "client_id": "555666",
- "exp": 4802238682,
- "foo": "Hello, World!",
- "iat": 1678101021,
- "iss": "local.com",
- "jti": "9876",
- "nbf": 1678101021,
- "nonce": "12345",
- "sub": "tim@local.com"
- }
-*/
-const idToken = `eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJhY3IiOiJzb21ldGhpbmciLCJhbXIiOlsiZm9vIiwiYmFyIl0sImF0X2hhc2giOiIyZHpibV92SXh5LTdlUnRxVUlHUFB3IiwiYXVkIjpbInVuaXQiLCJ0ZXN0IiwiNTU1NjY2Il0sImF1dGhfdGltZSI6MTY3ODEwMDk2MSwiYXpwIjoiNTU1NjY2IiwiYmFyIjp7ImNvdW50IjoyMiwidGFncyI6WyJzb21lIiwidGFncyJdfSwiY2xpZW50X2lkIjoiNTU1NjY2IiwiZXhwIjo0ODAyMjM4NjgyLCJmb28iOiJIZWxsbywgV29ybGQhIiwiaWF0IjoxNjc4MTAxMDIxLCJpc3MiOiJsb2NhbC5jb20iLCJqdGkiOiI5ODc2IiwibmJmIjoxNjc4MTAxMDIxLCJub25jZSI6IjEyMzQ1Iiwic3ViIjoidGltQGxvY2FsLmNvbSJ9.t3GXSfVNNwiW1Suv9_84v0sdn2_-RWHVxhphhRozDXnsO7SDNOlGnEioemXABESxSzMclM7gB7mYy5Qah2ZUNx7eP5t2njoxEYfavgHwx7UJZ2NCg8NDPQyr-hlxelEcfdXK-I0oTd-FRDvF4rqPkD9Us52IpnplChCxnHFgh4wKwPqZZjv2IXVCtn0ilKW3hff1rMOYKEuLRcN2YP0gkyuqyHvcf2dMmjod0t4sLOTJ82rsCbMBC5CLpqv3nIC9HOGITkt1Kd-Am0n1LrdZvWwTo6RFe8AnzF0gpqjcB5Wg4Qeh58DIjZOz4f_8wnmJ_gCqyRh5vfSW4XHdbum0Tw`
-const accessToken = `eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJhdWQiOlsidW5pdCIsInRlc3QiXSwiYmFyIjp7ImNvdW50IjoyMiwidGFncyI6WyJzb21lIiwidGFncyJdfSwiZXhwIjo0ODAyMjM4NjgyLCJmb28iOiJIZWxsbywgV29ybGQhIiwiaWF0IjoxNjc4MTAxMDIxLCJpc3MiOiJsb2NhbC5jb20iLCJqdGkiOiI5ODc2IiwibmJmIjoxNjc4MTAxMDIxLCJzdWIiOiJ0aW1AbG9jYWwuY29tIn0.Zrz3LWSRjCMJZUMaI5dUbW4vGdSmEeJQ3ouhaX0bcW9rdFFLgBI4K2FWJhNivq8JDmCGSxwLu3mI680GWmDaEoAx1M5sCO9lqfIZHGZh-lfAXk27e6FPLlkTDBq8Bx4o4DJ9Fw0hRJGjUTjnYv5cq1vo2-UqldasL6CwTbkzNC_4oQFfRtuodC4Ql7dZ1HRv5LXuYx7KPkOssLZtV9cwtJp5nFzKjcf2zEE_tlbjcpynMwypornRUp1EhCWKRUGkJhJeiP71ECY5pQhShfjBu9Nc5wDpSnZmnk2S4YsPrRK3QkE-iEkas8BfsOCrGoErHjEJexAIDjasGO5PFLWfCA`
-
-func ExampleVerifyTokens_customClaims() {
- v := rp.NewIDTokenVerifier("local.com", "555666", tu.KeySet{},
- rp.WithNonce(func(ctx context.Context) string { return "12345" }),
- )
-
- // VerifyAccessToken can be called with the *MyCustomClaims.
- claims, err := rp.VerifyTokens[*MyCustomClaims](context.TODO(), accessToken, idToken, v)
- if err != nil {
- panic(err)
- }
- // Here we have typesafe access to the custom claims
- fmt.Println(claims.Foo, claims.Bar.Count, claims.Bar.Tags)
- // Output: Hello, World! 22 [some tags]
-}
diff --git a/pkg/client/rs/introspect_example_test.go b/pkg/client/rs/introspect_example_test.go
deleted file mode 100644
index 1f67d11..0000000
--- a/pkg/client/rs/introspect_example_test.go
+++ /dev/null
@@ -1,52 +0,0 @@
-package rs_test
-
-import (
- "context"
- "fmt"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client/rs"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
-)
-
-type IntrospectionResponse struct {
- Active bool `json:"active"`
- Scope oidc.SpaceDelimitedArray `json:"scope,omitempty"`
- ClientID string `json:"client_id,omitempty"`
- TokenType string `json:"token_type,omitempty"`
- Expiration oidc.Time `json:"exp,omitempty"`
- IssuedAt oidc.Time `json:"iat,omitempty"`
- NotBefore oidc.Time `json:"nbf,omitempty"`
- Subject string `json:"sub,omitempty"`
- Audience oidc.Audience `json:"aud,omitempty"`
- Issuer string `json:"iss,omitempty"`
- JWTID string `json:"jti,omitempty"`
- Username string `json:"username,omitempty"`
- oidc.UserInfoProfile
- oidc.UserInfoEmail
- oidc.UserInfoPhone
- Address *oidc.UserInfoAddress `json:"address,omitempty"`
-
- // Foo and Bar are custom claims
- Foo string `json:"foo,omitempty"`
- Bar struct {
- Val1 string `json:"val_1,omitempty"`
- Val2 string `json:"val_2,omitempty"`
- } `json:"bar,omitempty"`
-
- // Claims are all the combined claims, including custom.
- Claims map[string]any `json:"-,omitempty"`
-}
-
-func ExampleIntrospect_custom() {
- rss, err := rs.NewResourceServerClientCredentials(context.TODO(), "http://localhost:8080", "clientid", "clientsecret")
- if err != nil {
- panic(err)
- }
-
- resp, err := rs.Introspect[*IntrospectionResponse](context.TODO(), rss, "accesstokenstring")
- if err != nil {
- panic(err)
- }
-
- fmt.Println(resp)
-}
diff --git a/pkg/client/rs/resource_server.go b/pkg/client/rs/resource_server.go
index 993796e..b1bc47e 100644
--- a/pkg/client/rs/resource_server.go
+++ b/pkg/client/rs/resource_server.go
@@ -6,16 +6,15 @@ import (
"net/http"
"time"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/client"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type ResourceServer interface {
IntrospectionURL() string
- TokenEndpoint() string
HttpClient() *http.Client
- AuthFn() (any, error)
+ AuthFn() (interface{}, error)
}
type resourceServer struct {
@@ -23,48 +22,44 @@ type resourceServer struct {
tokenURL string
introspectURL string
httpClient *http.Client
- authFn func() (any, error)
+ authFn func() (interface{}, error)
}
func (r *resourceServer) IntrospectionURL() string {
return r.introspectURL
}
-func (r *resourceServer) TokenEndpoint() string {
- return r.tokenURL
-}
-
func (r *resourceServer) HttpClient() *http.Client {
return r.httpClient
}
-func (r *resourceServer) AuthFn() (any, error) {
+func (r *resourceServer) AuthFn() (interface{}, error) {
return r.authFn()
}
-func NewResourceServerClientCredentials(ctx context.Context, issuer, clientID, clientSecret string, option ...Option) (ResourceServer, error) {
- authorizer := func() (any, error) {
+func NewResourceServerClientCredentials(issuer, clientID, clientSecret string, option ...Option) (ResourceServer, error) {
+ authorizer := func() (interface{}, error) {
return httphelper.AuthorizeBasic(clientID, clientSecret), nil
}
- return newResourceServer(ctx, issuer, authorizer, option...)
+ return newResourceServer(issuer, authorizer, option...)
}
-func NewResourceServerJWTProfile(ctx context.Context, issuer, clientID, keyID string, key []byte, options ...Option) (ResourceServer, error) {
+func NewResourceServerJWTProfile(issuer, clientID, keyID string, key []byte, options ...Option) (ResourceServer, error) {
signer, err := client.NewSignerFromPrivateKeyByte(key, keyID)
if err != nil {
return nil, err
}
- authorizer := func() (any, error) {
+ authorizer := func() (interface{}, error) {
assertion, err := client.SignedJWTProfileAssertion(clientID, []string{issuer}, time.Hour, signer)
if err != nil {
return nil, err
}
return client.ClientAssertionFormAuthorization(assertion), nil
}
- return newResourceServer(ctx, issuer, authorizer, options...)
+ return newResourceServer(issuer, authorizer, options...)
}
-func newResourceServer(ctx context.Context, issuer string, authorizer func() (any, error), options ...Option) (*resourceServer, error) {
+func newResourceServer(issuer string, authorizer func() (interface{}, error), options ...Option) (*resourceServer, error) {
rs := &resourceServer{
issuer: issuer,
httpClient: httphelper.DefaultHTTPClient,
@@ -73,30 +68,26 @@ func newResourceServer(ctx context.Context, issuer string, authorizer func() (an
optFunc(rs)
}
if rs.introspectURL == "" || rs.tokenURL == "" {
- config, err := client.Discover(ctx, rs.issuer, rs.httpClient)
+ config, err := client.Discover(rs.issuer, rs.httpClient)
if err != nil {
return nil, err
}
- if rs.tokenURL == "" {
- rs.tokenURL = config.TokenEndpoint
- }
- if rs.introspectURL == "" {
- rs.introspectURL = config.IntrospectionEndpoint
- }
+ rs.tokenURL = config.TokenEndpoint
+ rs.introspectURL = config.IntrospectionEndpoint
}
- if rs.tokenURL == "" {
- return nil, errors.New("tokenURL is empty: please provide with either `WithStaticEndpoints` or a discovery url")
+ if rs.introspectURL == "" || rs.tokenURL == "" {
+ return nil, errors.New("introspectURL and/or tokenURL is empty: please provide with either `WithStaticEndpoints` or a discovery url")
}
rs.authFn = authorizer
return rs, nil
}
-func NewResourceServerFromKeyFile(ctx context.Context, issuer, path string, options ...Option) (ResourceServer, error) {
+func NewResourceServerFromKeyFile(issuer, path string, options ...Option) (ResourceServer, error) {
c, err := client.ConfigFromKeyFile(path)
if err != nil {
return nil, err
}
- return NewResourceServerJWTProfile(ctx, issuer, c.ClientID, c.KeyID, []byte(c.Key), options...)
+ return NewResourceServerJWTProfile(issuer, c.ClientID, c.KeyID, []byte(c.Key), options...)
}
type Option func(*resourceServer)
@@ -116,30 +107,18 @@ func WithStaticEndpoints(tokenURL, introspectURL string) Option {
}
}
-// Introspect calls the [RFC7662] Token Introspection
-// endpoint and returns the response in an instance of type R.
-// [*oidc.IntrospectionResponse] can be used as a good example, or use a custom type if type-safe
-// access to custom claims is needed.
-//
-// [RFC7662]: https://www.rfc-editor.org/rfc/rfc7662
-func Introspect[R any](ctx context.Context, rp ResourceServer, token string) (resp R, err error) {
- ctx, span := client.Tracer.Start(ctx, "Introspect")
- defer span.End()
-
- if rp.IntrospectionURL() == "" {
- return resp, errors.New("resource server: introspection URL is empty")
- }
+func Introspect(ctx context.Context, rp ResourceServer, token string) (oidc.IntrospectionResponse, error) {
authFn, err := rp.AuthFn()
if err != nil {
- return resp, err
+ return nil, err
}
- req, err := httphelper.FormRequest(ctx, rp.IntrospectionURL(), &oidc.IntrospectionRequest{Token: token}, client.Encoder, authFn)
+ req, err := httphelper.FormRequest(rp.IntrospectionURL(), &oidc.IntrospectionRequest{Token: token}, client.Encoder, authFn)
if err != nil {
- return resp, err
+ return nil, err
}
-
- if err := httphelper.HttpRequest(rp.HttpClient(), req, &resp); err != nil {
- return resp, err
+ resp := oidc.NewIntrospectionResponse()
+ if err := httphelper.HttpRequest(rp.HttpClient(), req, resp); err != nil {
+ return nil, err
}
return resp, nil
}
diff --git a/pkg/client/rs/resource_server_test.go b/pkg/client/rs/resource_server_test.go
deleted file mode 100644
index afd7441..0000000
--- a/pkg/client/rs/resource_server_test.go
+++ /dev/null
@@ -1,221 +0,0 @@
-package rs
-
-import (
- "context"
- "testing"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestNewResourceServer(t *testing.T) {
- type args struct {
- issuer string
- authorizer func() (any, error)
- options []Option
- }
- type wantFields struct {
- issuer string
- tokenURL string
- introspectURL string
- authFn func() (any, error)
- }
- tests := []struct {
- name string
- args args
- wantFields *wantFields
- wantErr bool
- }{
- {
- name: "spotify-full-discovery",
- args: args{
- issuer: "https://accounts.spotify.com",
- authorizer: nil,
- options: []Option{},
- },
- wantFields: &wantFields{
- issuer: "https://accounts.spotify.com",
- tokenURL: "https://accounts.spotify.com/api/token",
- introspectURL: "",
- authFn: nil,
- },
- wantErr: false,
- },
- {
- name: "spotify-with-static-tokenurl",
- args: args{
- issuer: "https://accounts.spotify.com",
- authorizer: nil,
- options: []Option{
- WithStaticEndpoints(
- "https://some.host/token-url",
- "",
- ),
- },
- },
- wantFields: &wantFields{
- issuer: "https://accounts.spotify.com",
- tokenURL: "https://some.host/token-url",
- introspectURL: "",
- authFn: nil,
- },
- wantErr: false,
- },
- {
- name: "spotify-with-static-introspecturl",
- args: args{
- issuer: "https://accounts.spotify.com",
- authorizer: nil,
- options: []Option{
- WithStaticEndpoints(
- "",
- "https://some.host/instrospect-url",
- ),
- },
- },
- wantFields: &wantFields{
- issuer: "https://accounts.spotify.com",
- tokenURL: "https://accounts.spotify.com/api/token",
- introspectURL: "https://some.host/instrospect-url",
- authFn: nil,
- },
- wantErr: false,
- },
- {
- name: "spotify-with-all-static-endpoints",
- args: args{
- issuer: "https://accounts.spotify.com",
- authorizer: nil,
- options: []Option{
- WithStaticEndpoints(
- "https://some.host/token-url",
- "https://some.host/instrospect-url",
- ),
- },
- },
- wantFields: &wantFields{
- issuer: "https://accounts.spotify.com",
- tokenURL: "https://some.host/token-url",
- introspectURL: "https://some.host/instrospect-url",
- authFn: nil,
- },
- wantErr: false,
- },
- {
- name: "bad-discovery",
- args: args{
- issuer: "https://127.0.0.1:65535",
- authorizer: nil,
- options: []Option{},
- },
- wantFields: nil,
- wantErr: true,
- },
- {
- name: "bad-discovery-with-static-tokenurl",
- args: args{
- issuer: "https://127.0.0.1:65535",
- authorizer: nil,
- options: []Option{
- WithStaticEndpoints(
- "https://some.host/token-url",
- "",
- ),
- },
- },
- wantFields: nil,
- wantErr: true,
- },
- {
- name: "bad-discovery-with-static-introspecturl",
- args: args{
- issuer: "https://127.0.0.1:65535",
- authorizer: nil,
- options: []Option{
- WithStaticEndpoints(
- "",
- "https://some.host/instrospect-url",
- ),
- },
- },
- wantFields: nil,
- wantErr: true,
- },
- {
- name: "bad-discovery-with-all-static-endpoints",
- args: args{
- issuer: "https://127.0.0.1:65535",
- authorizer: nil,
- options: []Option{
- WithStaticEndpoints(
- "https://some.host/token-url",
- "https://some.host/instrospect-url",
- ),
- },
- },
- wantFields: &wantFields{
- issuer: "https://127.0.0.1:65535",
- tokenURL: "https://some.host/token-url",
- introspectURL: "https://some.host/instrospect-url",
- authFn: nil,
- },
- wantErr: false,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got, err := newResourceServer(context.Background(), tt.args.issuer, tt.args.authorizer, tt.args.options...)
- if tt.wantErr {
- assert.Error(t, err)
- return
- }
- require.NoError(t, err)
- if tt.wantFields == nil {
- return
- }
- assert.Equal(t, tt.wantFields.issuer, got.issuer)
- assert.Equal(t, tt.wantFields.tokenURL, got.tokenURL)
- assert.Equal(t, tt.wantFields.introspectURL, got.introspectURL)
- })
- }
-}
-
-func TestIntrospect(t *testing.T) {
- type args struct {
- ctx context.Context
- rp ResourceServer
- token string
- }
- rp, err := newResourceServer(
- context.Background(),
- "https://accounts.spotify.com",
- nil,
- )
- require.NoError(t, err)
- tests := []struct {
- name string
- args args
- wantErr bool
- }{
- {
- name: "missing-introspect-url",
- args: args{
- ctx: context.Background(),
- rp: rp,
- token: "my-token",
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- _, err := Introspect[*oidc.IntrospectionResponse](tt.args.ctx, tt.args.rp, tt.args.token)
- if tt.wantErr {
- assert.Error(t, err)
- return
- }
- require.NoError(t, err)
- })
- }
-}
diff --git a/pkg/client/tokenexchange/tokenexchange.go b/pkg/client/tokenexchange/tokenexchange.go
deleted file mode 100644
index 9cc1328..0000000
--- a/pkg/client/tokenexchange/tokenexchange.go
+++ /dev/null
@@ -1,145 +0,0 @@
-package tokenexchange
-
-import (
- "context"
- "errors"
- "net/http"
- "time"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/go-jose/go-jose/v4"
-)
-
-type TokenExchanger interface {
- TokenEndpoint() string
- HttpClient() *http.Client
- AuthFn() (any, error)
-}
-
-type OAuthTokenExchange struct {
- httpClient *http.Client
- tokenEndpoint string
- authFn func() (any, error)
-}
-
-func NewTokenExchanger(ctx context.Context, issuer string, options ...func(source *OAuthTokenExchange)) (TokenExchanger, error) {
- return newOAuthTokenExchange(ctx, issuer, nil, options...)
-}
-
-func NewTokenExchangerClientCredentials(ctx context.Context, issuer, clientID, clientSecret string, options ...func(source *OAuthTokenExchange)) (TokenExchanger, error) {
- authorizer := func() (any, error) {
- return httphelper.AuthorizeBasic(clientID, clientSecret), nil
- }
- return newOAuthTokenExchange(ctx, issuer, authorizer, options...)
-}
-
-func NewTokenExchangerJWTProfile(ctx context.Context, issuer, clientID string, signer jose.Signer, options ...func(source *OAuthTokenExchange)) (TokenExchanger, error) {
- authorizer := func() (any, error) {
- assertion, err := client.SignedJWTProfileAssertion(clientID, []string{issuer}, time.Hour, signer)
- if err != nil {
- return nil, err
- }
- return client.ClientAssertionFormAuthorization(assertion), nil
- }
- return newOAuthTokenExchange(ctx, issuer, authorizer, options...)
-}
-
-func newOAuthTokenExchange(ctx context.Context, issuer string, authorizer func() (any, error), options ...func(source *OAuthTokenExchange)) (*OAuthTokenExchange, error) {
- te := &OAuthTokenExchange{
- httpClient: httphelper.DefaultHTTPClient,
- }
- for _, opt := range options {
- opt(te)
- }
-
- if te.tokenEndpoint == "" {
- config, err := client.Discover(ctx, issuer, te.httpClient)
- if err != nil {
- return nil, err
- }
-
- te.tokenEndpoint = config.TokenEndpoint
- }
-
- if te.tokenEndpoint == "" {
- return nil, errors.New("tokenURL is empty: please provide with either `WithStaticTokenEndpoint` or a discovery url")
- }
-
- te.authFn = authorizer
-
- return te, nil
-}
-
-func WithHTTPClient(client *http.Client) func(*OAuthTokenExchange) {
- return func(source *OAuthTokenExchange) {
- source.httpClient = client
- }
-}
-
-func WithStaticTokenEndpoint(issuer, tokenEndpoint string) func(*OAuthTokenExchange) {
- return func(source *OAuthTokenExchange) {
- source.tokenEndpoint = tokenEndpoint
- }
-}
-
-func (te *OAuthTokenExchange) TokenEndpoint() string {
- return te.tokenEndpoint
-}
-
-func (te *OAuthTokenExchange) HttpClient() *http.Client {
- return te.httpClient
-}
-
-func (te *OAuthTokenExchange) AuthFn() (any, error) {
- if te.authFn != nil {
- return te.authFn()
- }
-
- return nil, nil
-}
-
-// ExchangeToken sends a token exchange request (rfc 8693) to te's token endpoint.
-// SubjectToken and SubjectTokenType are required parameters.
-func ExchangeToken(
- ctx context.Context,
- te TokenExchanger,
- SubjectToken string,
- SubjectTokenType oidc.TokenType,
- ActorToken string,
- ActorTokenType oidc.TokenType,
- Resource []string,
- Audience []string,
- Scopes []string,
- RequestedTokenType oidc.TokenType,
-) (*oidc.TokenExchangeResponse, error) {
- ctx, span := client.Tracer.Start(ctx, "ExchangeToken")
- defer span.End()
-
- if SubjectToken == "" {
- return nil, errors.New("empty subject_token")
- }
- if SubjectTokenType == "" {
- return nil, errors.New("empty subject_token_type")
- }
-
- authFn, err := te.AuthFn()
- if err != nil {
- return nil, err
- }
-
- request := oidc.TokenExchangeRequest{
- GrantType: oidc.GrantTypeTokenExchange,
- SubjectToken: SubjectToken,
- SubjectTokenType: SubjectTokenType,
- ActorToken: ActorToken,
- ActorTokenType: ActorTokenType,
- Resource: Resource,
- Audience: Audience,
- Scopes: Scopes,
- RequestedTokenType: RequestedTokenType,
- }
-
- return client.CallTokenExchangeEndpoint(ctx, request, authFn, te)
-}
diff --git a/pkg/crypto/hash.go b/pkg/crypto/hash.go
index 14acdee..6fcc71f 100644
--- a/pkg/crypto/hash.go
+++ b/pkg/crypto/hash.go
@@ -8,7 +8,7 @@ import (
"fmt"
"hash"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
)
var ErrUnsupportedAlgorithm = errors.New("unsupported signing algorithm")
@@ -21,14 +21,6 @@ func GetHashAlgorithm(sigAlgorithm jose.SignatureAlgorithm) (hash.Hash, error) {
return sha512.New384(), nil
case jose.RS512, jose.ES512, jose.PS512:
return sha512.New(), nil
-
- // There is no published spec for this yet, but we have confirmation it will get published.
- // There is consensus here: https://bitbucket.org/openid/connect/issues/1125/_hash-algorithm-for-eddsa-id-tokens
- // Currently Go and go-jose only supports the ed25519 curve key for EdDSA, so we can safely assume sha512 here.
- // It is unlikely ed448 will ever be supported: https://github.com/golang/go/issues/29390
- case jose.EdDSA:
- return sha512.New(), nil
-
default:
return nil, fmt.Errorf("%w: %q", ErrUnsupportedAlgorithm, sigAlgorithm)
}
diff --git a/pkg/crypto/key.go b/pkg/crypto/key.go
index 12bca28..d75d1ab 100644
--- a/pkg/crypto/key.go
+++ b/pkg/crypto/key.go
@@ -1,45 +1,17 @@
package crypto
import (
- "crypto"
- "crypto/ecdsa"
- "crypto/ed25519"
"crypto/rsa"
"crypto/x509"
"encoding/pem"
- "errors"
-
- "github.com/go-jose/go-jose/v4"
)
-var (
- ErrPEMDecode = errors.New("PEM decode failed")
- ErrUnsupportedFormat = errors.New("key is neither in PKCS#1 nor PKCS#8 format")
- ErrUnsupportedPrivateKey = errors.New("unsupported key type, must be RSA, ECDSA or ED25519 private key")
-)
-
-func BytesToPrivateKey(b []byte) (crypto.PublicKey, jose.SignatureAlgorithm, error) {
- block, _ := pem.Decode(b)
- if block == nil {
- return nil, "", ErrPEMDecode
- }
-
- privateKey, err := x509.ParsePKCS1PrivateKey(block.Bytes)
- if err == nil {
- return privateKey, jose.RS256, nil
- }
- key, err := x509.ParsePKCS8PrivateKey(block.Bytes)
+func BytesToPrivateKey(priv []byte) (*rsa.PrivateKey, error) {
+ block, _ := pem.Decode(priv)
+ b := block.Bytes
+ key, err := x509.ParsePKCS1PrivateKey(b)
if err != nil {
- return nil, "", ErrUnsupportedFormat
- }
- switch privateKey := key.(type) {
- case *rsa.PrivateKey:
- return privateKey, jose.RS256, nil
- case ed25519.PrivateKey:
- return privateKey, jose.EdDSA, nil
- case *ecdsa.PrivateKey:
- return privateKey, jose.ES256, nil
- default:
- return nil, "", ErrUnsupportedPrivateKey
+ return nil, err
}
+ return key, nil
}
diff --git a/pkg/crypto/key_test.go b/pkg/crypto/key_test.go
deleted file mode 100644
index a6fa493..0000000
--- a/pkg/crypto/key_test.go
+++ /dev/null
@@ -1,134 +0,0 @@
-package crypto_test
-
-import (
- "crypto"
- "crypto/ecdsa"
- "crypto/ed25519"
- "crypto/rsa"
- "testing"
-
- "github.com/go-jose/go-jose/v4"
- "github.com/stretchr/testify/assert"
-
- zcrypto "git.christmann.info/LARA/zitadel-oidc/v3/pkg/crypto"
-)
-
-func TestBytesToPrivateKey(t *testing.T) {
- type args struct {
- key []byte
- }
- type want struct {
- key crypto.Signer
- algorithm jose.SignatureAlgorithm
- err error
- }
- tests := []struct {
- name string
- args args
- want want
- }{
- {
- name: "PEMDecodeError",
- args: args{
- key: []byte("The non-PEM sequence"),
- },
- want: want{
- err: zcrypto.ErrPEMDecode,
- },
- },
- {
- name: "PKCS#1 RSA",
- args: args{
- key: []byte(`-----BEGIN RSA PRIVATE KEY-----
-MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8Qu
-KUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
-o3qGy0t6z09AIJtH+5OeRV1be+N4cDYJKffGzDa88vQENZiRm0GRq6a+HPGQMd2k
-TQIhAKMSvzIBnni7ot/OSie2TmJLY4SwTQAevXysE2RbFDYdAiEBCUEaRQnMnbp7
-9mxDXDf6AU0cN/RPBjb9qSHDcWZHGzUCIG2Es59z8ugGrDY+pxLQnwfotadxd+Uy
-v/Ow5T0q5gIJAiEAyS4RaI9YG8EWx/2w0T67ZUVAw8eOMB6BIUg0Xcu+3okCIBOs
-/5OiPgoTdSy7bcF9IGpSE8ZgGKzgYQVZeN97YE00
------END RSA PRIVATE KEY-----`),
- },
- want: want{
- key: &rsa.PrivateKey{},
- algorithm: jose.RS256,
- err: nil,
- },
- },
- {
- name: "PKCS#8 RSA",
- args: args{
- key: []byte(`-----BEGIN PRIVATE KEY-----
-MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCfaDB7pK/fmP/I
-7IusSK8lTCBnPZghqIbVLt2QHYAMoEF1CaF4F4rxo2vl1Mt8gwsq4T3osQFZMvnL
-YHb7KNyUoJgTjLxJQADv2u4Q3U38heAzK5Tp4ry4MCnuyJIqAPK1GiruwEq4zQrx
-+WzVix8otO37SuW9tzklqlNGMiAYBL0TBKHvS5XMbjP1idBMB8erMz29w/TVQnEB
-Kj0vCdZjrbVPKygptt5kcSrL5f4xCZwU+ufz7cp0GLwpRMJ+shG9YJJFBxb0itPF
-sy51vAyEtdBC7jgAU96ZVeQ06nryDq1D2EpoVMElqNyL46Jo3lnKbGquGKzXzQYU
-BN32/scDAgMBAAECggEBAJE/mo3PLgILo2YtQ8ekIxNVHmF0Gl7w9IrjvTdH6hmX
-HI3MTLjkmtI7GmG9V/0IWvCjdInGX3grnrjWGRQZ04QKIQgPQLFuBGyJjEsJm7nx
-MqztlS7YTyV1nX/aenSTkJO8WEpcJLnm+4YoxCaAMdAhrIdBY71OamALpv1bRysa
-FaiCGcemT2yqZn0GqIS8O26Tz5zIqrTN2G1eSmgh7DG+7FoddMz35cute8R10xUG
-hF5YU+6fcXiRQ/Kh7nlxelPGqdZFPMk7LpVHzkQKwdJ+N0P23lPDIfNsvpG1n0OP
-3g5km7gHSrSU2yZ3eFl6DB9x1IFNS9BaQQuSxYJtKwECgYEA1C8jjzpXZDLvlYsV
-2jlMzkrbsIrX2dzblVrNsPs2jRbjYU8mg2DUDO6lOhtxHfqZG6sO+gmWi/zvoy9l
-yolGbXe1Jqx66p9fznIcecSwar8+ACa356Wk74Nt1PlBOfCMqaJnYLOLaFJa29Vy
-u5ClZVzKd5AVXl7yFVd4XfLv/WECgYEAwFMMtFoasdF92c0d31rZ1uoPOtFz6xq6
-uQggdm5zzkhnfwUAGqppS/u1CHcJ7T/74++jLbFTsaohGr4jEzWSGvJpomEUChy3
-r25YofMclUhJ5pCEStsLtqiCR1Am6LlI8HMdBEP1QDgEC5q8bQW4+UHuew1E1zxz
-osZOhe09WuMCgYEA0G9aFCnwjUqIFjQiDFP7gi8BLqTFs4uE3Wvs4W11whV42i+B
-ms90nxuTjchFT3jMDOT1+mOO0wdudLRr3xEI8SIF/u6ydGaJG+j21huEXehtxIJE
-aDdNFcfbDbqo+3y1ATK7MMBPMvSrsoY0hdJq127WqasNgr3sO1DIuima3SECgYEA
-nkM5TyhekzlbIOHD1UsDu/D7+2DkzPE/+oePfyXBMl0unb3VqhvVbmuBO6gJiSx/
-8b//PdiQkMD5YPJaFrKcuoQFHVRZk0CyfzCEyzAts0K7XXpLAvZiGztriZeRjSz7
-srJnjF0H8oKmAY6hw+1Tm/n/b08p+RyL48TgVSE2vhUCgYA3BWpkD4PlCcn/FZsq
-OrLFyFXI6jIaxskFtsRW1IxxIlAdZmxfB26P/2gx6VjLdxJI/RRPkJyEN2dP7CbR
-BDjb565dy1O9D6+UrY70Iuwjz+OcALRBBGTaiF2pLn6IhSzNI2sy/tXX8q8dBlg9
-OFCrqT/emes3KytTPfa5NZtYeQ==
------END PRIVATE KEY-----`),
- },
- want: want{
- key: &rsa.PrivateKey{},
- algorithm: jose.RS256,
- err: nil,
- },
- },
- {
- name: "PKCS#8 ECDSA",
- args: args{
- key: []byte(`-----BEGIN PRIVATE KEY-----
-MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgwwOZSU4GlP7ps/Wp
-V6o0qRwxultdfYo/uUuj48QZjSuhRANCAATMiI2Han+ABKmrk5CNlxRAGC61w4d3
-G4TAeuBpyzqJ7x/6NjCxoQzJzZHtNjIfjVATI59XFZWF59GhtSZbShAr
------END PRIVATE KEY-----`),
- },
- want: want{
- key: &ecdsa.PrivateKey{},
- algorithm: jose.ES256,
- err: nil,
- },
- },
- {
- name: "PKCS#8 ED25519",
- args: args{
- key: []byte(`-----BEGIN PRIVATE KEY-----
-MC4CAQAwBQYDK2VwBCIEIHu6ZtDsjjauMasBxnS9Fg87UJwKfcT/oiq6S0ktbky8
------END PRIVATE KEY-----`),
- },
- want: want{
- key: ed25519.PrivateKey{},
- algorithm: jose.EdDSA,
- err: nil,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- key, algorithm, err := zcrypto.BytesToPrivateKey(tt.args.key)
- assert.IsType(t, tt.want.key, key)
- assert.Equal(t, tt.want.algorithm, algorithm)
- assert.ErrorIs(t, tt.want.err, err)
- })
-
- }
-}
diff --git a/pkg/crypto/sign.go b/pkg/crypto/sign.go
index 937a846..a0b9cae 100644
--- a/pkg/crypto/sign.go
+++ b/pkg/crypto/sign.go
@@ -4,10 +4,10 @@ import (
"encoding/json"
"errors"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
)
-func Sign(object any, signer jose.Signer) (string, error) {
+func Sign(object interface{}, signer jose.Signer) (string, error) {
payload, err := json.Marshal(object)
if err != nil {
return "", err
diff --git a/pkg/http/http.go b/pkg/http/http.go
index aa0ff6f..d3c5b4f 100644
--- a/pkg/http/http.go
+++ b/pkg/http/http.go
@@ -10,8 +10,6 @@ import (
"net/url"
"strings"
"time"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
)
var DefaultHTTPClient = &http.Client{
@@ -19,11 +17,11 @@ var DefaultHTTPClient = &http.Client{
}
type Decoder interface {
- Decode(dst any, src map[string][]string) error
+ Decode(dst interface{}, src map[string][]string) error
}
type Encoder interface {
- Encode(src any, dst map[string][]string) error
+ Encode(src interface{}, dst map[string][]string) error
}
type FormAuthorization func(url.Values)
@@ -35,7 +33,7 @@ func AuthorizeBasic(user, password string) RequestAuthorization {
}
}
-func FormRequest(ctx context.Context, endpoint string, request any, encoder Encoder, authFn any) (*http.Request, error) {
+func FormRequest(endpoint string, request interface{}, encoder Encoder, authFn interface{}) (*http.Request, error) {
form := url.Values{}
if err := encoder.Encode(request, form); err != nil {
return nil, err
@@ -44,7 +42,7 @@ func FormRequest(ctx context.Context, endpoint string, request any, encoder Enco
fn(form)
}
body := strings.NewReader(form.Encode())
- req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, body)
+ req, err := http.NewRequest("POST", endpoint, body)
if err != nil {
return nil, err
}
@@ -55,7 +53,7 @@ func FormRequest(ctx context.Context, endpoint string, request any, encoder Enco
return req, nil
}
-func HttpRequest(client *http.Client, req *http.Request, response any) error {
+func HttpRequest(client *http.Client, req *http.Request, response interface{}) error {
resp, err := client.Do(req)
if err != nil {
return err
@@ -68,12 +66,7 @@ func HttpRequest(client *http.Client, req *http.Request, response any) error {
}
if resp.StatusCode != http.StatusOK {
- var oidcErr oidc.Error
- err = json.Unmarshal(body, &oidcErr)
- if err != nil || oidcErr.ErrorType == "" {
- return fmt.Errorf("http status not ok: %s %s", resp.Status, body)
- }
- return &oidcErr
+ return fmt.Errorf("http status not ok: %s %s", resp.Status, body)
}
err = json.Unmarshal(body, response)
@@ -83,7 +76,7 @@ func HttpRequest(client *http.Client, req *http.Request, response any) error {
return nil
}
-func URLEncodeParams(resp any, encoder Encoder) (url.Values, error) {
+func URLEncodeParams(resp interface{}, encoder Encoder) (url.Values, error) {
values := make(map[string][]string)
err := encoder.Encode(resp, values)
if err != nil {
diff --git a/pkg/http/marshal.go b/pkg/http/marshal.go
index 71ed2c2..794a28a 100644
--- a/pkg/http/marshal.go
+++ b/pkg/http/marshal.go
@@ -8,11 +8,11 @@ import (
"reflect"
)
-func MarshalJSON(w http.ResponseWriter, i any) {
+func MarshalJSON(w http.ResponseWriter, i interface{}) {
MarshalJSONWithStatus(w, i, http.StatusOK)
}
-func MarshalJSONWithStatus(w http.ResponseWriter, i any, status int) {
+func MarshalJSONWithStatus(w http.ResponseWriter, i interface{}, status int) {
w.Header().Set("content-type", "application/json")
w.WriteHeader(status)
if i == nil || (reflect.ValueOf(i).Kind() == reflect.Ptr && reflect.ValueOf(i).IsNil()) {
diff --git a/pkg/http/marshal_test.go b/pkg/http/marshal_test.go
index dcc7fdd..3838a44 100644
--- a/pkg/http/marshal_test.go
+++ b/pkg/http/marshal_test.go
@@ -94,7 +94,7 @@ func TestConcatenateJSON(t *testing.T) {
func TestMarshalJSONWithStatus(t *testing.T) {
type args struct {
- i any
+ i interface{}
status int
}
type res struct {
diff --git a/pkg/oidc/authorization.go b/pkg/oidc/authorization.go
index fa37dbf..f620ecb 100644
--- a/pkg/oidc/authorization.go
+++ b/pkg/oidc/authorization.go
@@ -1,9 +1,5 @@
package oidc
-import (
- "log/slog"
-)
-
const (
// ScopeOpenID defines the scope `openid`
// OpenID Connect requests MUST contain the `openid` scope value
@@ -48,7 +44,6 @@ const (
ResponseModeQuery ResponseMode = "query"
ResponseModeFragment ResponseMode = "fragment"
- ResponseModeFormPost ResponseMode = "form_post"
// PromptNone (`none`) disallows the Authorization Server to display any authentication or consent user interface pages.
// An error (login_required, interaction_required, ...) will be returned if the user is not already authenticated or consent is needed
@@ -65,7 +60,7 @@ const (
)
// AuthRequest according to:
-// https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
+//https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
type AuthRequest struct {
Scopes SpaceDelimitedArray `json:"scope" schema:"scope"`
ResponseType ResponseType `json:"response_type" schema:"response_type"`
@@ -82,7 +77,7 @@ type AuthRequest struct {
UILocales Locales `json:"ui_locales" schema:"ui_locales"`
IDTokenHint string `json:"id_token_hint" schema:"id_token_hint"`
LoginHint string `json:"login_hint" schema:"login_hint"`
- ACRValues SpaceDelimitedArray `json:"acr_values" schema:"acr_values"`
+ ACRValues []string `json:"acr_values" schema:"acr_values"`
CodeChallenge string `json:"code_challenge" schema:"code_challenge"`
CodeChallengeMethod CodeChallengeMethod `json:"code_challenge_method" schema:"code_challenge_method"`
@@ -91,15 +86,6 @@ type AuthRequest struct {
RequestParam string `schema:"request"`
}
-func (a *AuthRequest) LogValue() slog.Value {
- return slog.GroupValue(
- slog.Any("scopes", a.Scopes),
- slog.String("response_type", string(a.ResponseType)),
- slog.String("client_id", a.ClientID),
- slog.String("redirect_uri", a.RedirectURI),
- )
-}
-
// GetRedirectURI returns the redirect_uri value for the ErrAuthRequest interface
func (a *AuthRequest) GetRedirectURI() string {
return a.RedirectURI
@@ -114,8 +100,3 @@ func (a *AuthRequest) GetResponseType() ResponseType {
func (a *AuthRequest) GetState() string {
return a.State
}
-
-// GetResponseMode returns the optional ResponseMode
-func (a *AuthRequest) GetResponseMode() ResponseMode {
- return a.ResponseMode
-}
diff --git a/pkg/oidc/authorization_test.go b/pkg/oidc/authorization_test.go
deleted file mode 100644
index 1446efa..0000000
--- a/pkg/oidc/authorization_test.go
+++ /dev/null
@@ -1,27 +0,0 @@
-//go:build go1.20
-
-package oidc
-
-import (
- "log/slog"
- "testing"
-
- "github.com/stretchr/testify/assert"
-)
-
-func TestAuthRequest_LogValue(t *testing.T) {
- a := &AuthRequest{
- Scopes: SpaceDelimitedArray{"a", "b"},
- ResponseType: "respType",
- ClientID: "123",
- RedirectURI: "http://example.com/callback",
- }
- want := slog.GroupValue(
- slog.Any("scopes", SpaceDelimitedArray{"a", "b"}),
- slog.String("response_type", "respType"),
- slog.String("client_id", "123"),
- slog.String("redirect_uri", "http://example.com/callback"),
- )
- got := a.LogValue()
- assert.Equal(t, want, got)
-}
diff --git a/pkg/oidc/code_challenge.go b/pkg/oidc/code_challenge.go
index 0c593df..e1e459c 100644
--- a/pkg/oidc/code_challenge.go
+++ b/pkg/oidc/code_challenge.go
@@ -3,7 +3,7 @@ package oidc
import (
"crypto/sha256"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/crypto"
+ "github.com/zitadel/oidc/pkg/crypto"
)
const (
diff --git a/pkg/oidc/device_authorization.go b/pkg/oidc/device_authorization.go
deleted file mode 100644
index a6417ba..0000000
--- a/pkg/oidc/device_authorization.go
+++ /dev/null
@@ -1,51 +0,0 @@
-package oidc
-
-import "encoding/json"
-
-// DeviceAuthorizationRequest implements
-// https://www.rfc-editor.org/rfc/rfc8628#section-3.1,
-// 3.1 Device Authorization Request.
-type DeviceAuthorizationRequest struct {
- Scopes SpaceDelimitedArray `schema:"scope"`
- ClientID string `schema:"client_id"`
-}
-
-// DeviceAuthorizationResponse implements
-// https://www.rfc-editor.org/rfc/rfc8628#section-3.2
-// 3.2. Device Authorization Response.
-type DeviceAuthorizationResponse struct {
- DeviceCode string `json:"device_code"`
- UserCode string `json:"user_code"`
- VerificationURI string `json:"verification_uri"`
- VerificationURIComplete string `json:"verification_uri_complete,omitempty"`
- ExpiresIn int `json:"expires_in"`
- Interval int `json:"interval,omitempty"`
-}
-
-func (resp *DeviceAuthorizationResponse) UnmarshalJSON(data []byte) error {
- type Alias DeviceAuthorizationResponse
- aux := &struct {
- // workaround misspelling of verification_uri
- // https://stackoverflow.com/q/76696956/5690223
- // https://developers.google.com/identity/protocols/oauth2/limited-input-device?hl=fr#success-response
- VerificationURL string `json:"verification_url"`
- *Alias
- }{
- Alias: (*Alias)(resp),
- }
- if err := json.Unmarshal(data, &aux); err != nil {
- return err
- }
- if resp.VerificationURI == "" {
- resp.VerificationURI = aux.VerificationURL
- }
- return nil
-}
-
-// DeviceAccessTokenRequest implements
-// https://www.rfc-editor.org/rfc/rfc8628#section-3.4,
-// Device Access Token Request.
-type DeviceAccessTokenRequest struct {
- GrantType GrantType `json:"grant_type" schema:"grant_type"`
- DeviceCode string `json:"device_code" schema:"device_code"`
-}
diff --git a/pkg/oidc/device_authorization_test.go b/pkg/oidc/device_authorization_test.go
deleted file mode 100644
index c4c6637..0000000
--- a/pkg/oidc/device_authorization_test.go
+++ /dev/null
@@ -1,30 +0,0 @@
-package oidc
-
-import (
- "testing"
-
- "github.com/stretchr/testify/assert"
-)
-
-func TestDeviceAuthorizationResponse_UnmarshalJSON(t *testing.T) {
- jsonStr := `{
- "device_code": "deviceCode",
- "user_code": "userCode",
- "verification_url": "http://example.com/verify",
- "expires_in": 3600,
- "interval": 5
- }`
-
- expected := &DeviceAuthorizationResponse{
- DeviceCode: "deviceCode",
- UserCode: "userCode",
- VerificationURI: "http://example.com/verify",
- ExpiresIn: 3600,
- Interval: 5,
- }
-
- var resp DeviceAuthorizationResponse
- err := resp.UnmarshalJSON([]byte(jsonStr))
- assert.NoError(t, err)
- assert.Equal(t, expected, &resp)
-}
diff --git a/pkg/oidc/discovery.go b/pkg/oidc/discovery.go
index 62288d1..fbc417b 100644
--- a/pkg/oidc/discovery.go
+++ b/pkg/oidc/discovery.go
@@ -1,5 +1,9 @@
package oidc
+import (
+ "golang.org/x/text/language"
+)
+
const (
DiscoveryEndpoint = "/.well-known/openid-configuration"
)
@@ -26,8 +30,6 @@ type DiscoveryConfiguration struct {
// EndSessionEndpoint is a URL where the RP can perform a redirect to request that the End-User be logged out at the OP.
EndSessionEndpoint string `json:"end_session_endpoint,omitempty"`
- DeviceAuthorizationEndpoint string `json:"device_authorization_endpoint,omitempty"`
-
// CheckSessionIframe is a URL where the OP provides an iframe that support cross-origin communications for session state information with the RP Client.
CheckSessionIframe string `json:"check_session_iframe,omitempty"`
@@ -126,10 +128,10 @@ type DiscoveryConfiguration struct {
ServiceDocumentation string `json:"service_documentation,omitempty"`
// ClaimsLocalesSupported contains a list of BCP47 language tag values that the OP supports for values of Claims returned.
- ClaimsLocalesSupported Locales `json:"claims_locales_supported,omitempty"`
+ ClaimsLocalesSupported []language.Tag `json:"claims_locales_supported,omitempty"`
// UILocalesSupported contains a list of BCP47 language tag values that the OP supports for the user interface.
- UILocalesSupported Locales `json:"ui_locales_supported,omitempty"`
+ UILocalesSupported []language.Tag `json:"ui_locales_supported,omitempty"`
// RequestParameterSupported specifies whether the OP supports use of the `request` parameter. If omitted, the default value is false.
RequestParameterSupported bool `json:"request_parameter_supported,omitempty"`
@@ -145,14 +147,6 @@ type DiscoveryConfiguration struct {
// OPTermsOfServiceURI is a URL the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.
OPTermsOfServiceURI string `json:"op_tos_uri,omitempty"`
-
- // BackChannelLogoutSupported specifies whether the OP supports back-channel logout (https://openid.net/specs/openid-connect-backchannel-1_0.html),
- // with true indicating support. If omitted, the default value is false.
- BackChannelLogoutSupported bool `json:"backchannel_logout_supported,omitempty"`
-
- // BackChannelLogoutSessionSupported specifies whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP.
- // If supported, the sid Claim is also included in ID Tokens issued by the OP. If omitted, the default value is false.
- BackChannelLogoutSessionSupported bool `json:"backchannel_logout_session_supported,omitempty"`
}
type AuthMethod string
diff --git a/pkg/oidc/error.go b/pkg/oidc/error.go
index d93cf44..5797a59 100644
--- a/pkg/oidc/error.go
+++ b/pkg/oidc/error.go
@@ -1,10 +1,8 @@
package oidc
import (
- "encoding/json"
"errors"
"fmt"
- "log/slog"
)
type errorType string
@@ -20,19 +18,6 @@ const (
InteractionRequired errorType = "interaction_required"
LoginRequired errorType = "login_required"
RequestNotSupported errorType = "request_not_supported"
-
- // Additional error codes as defined in
- // https://www.rfc-editor.org/rfc/rfc8628#section-3.5
- // Device Access Token Response
- AuthorizationPending errorType = "authorization_pending"
- SlowDown errorType = "slow_down"
- AccessDenied errorType = "access_denied"
- ExpiredToken errorType = "expired_token"
-
- // InvalidTarget error is returned by Token Exchange if
- // the requested target or audience is invalid.
- // [RFC 8693, Section 2.2.2: Error Response](https://www.rfc-editor.org/rfc/rfc8693#section-2.2.2)
- InvalidTarget errorType = "invalid_target"
)
var (
@@ -92,40 +77,6 @@ var (
ErrorType: RequestNotSupported,
}
}
-
- // Device Access Token errors:
- ErrAuthorizationPending = func() *Error {
- return &Error{
- ErrorType: AuthorizationPending,
- Description: "The client SHOULD repeat the access token request to the token endpoint, after interval from device authorization response.",
- }
- }
- ErrSlowDown = func() *Error {
- return &Error{
- ErrorType: SlowDown,
- Description: "Polling should continue, but the interval MUST be increased by 5 seconds for this and all subsequent requests.",
- }
- }
- ErrAccessDenied = func() *Error {
- return &Error{
- ErrorType: AccessDenied,
- Description: "The authorization request was denied.",
- }
- }
- ErrExpiredDeviceCode = func() *Error {
- return &Error{
- ErrorType: ExpiredToken,
- Description: "The \"device_code\" has expired.",
- }
- }
-
- // Token exchange error
- ErrInvalidTarget = func() *Error {
- return &Error{
- ErrorType: InvalidTarget,
- Description: "The requested audience or target is invalid.",
- }
- }
)
type Error struct {
@@ -133,28 +84,7 @@ type Error struct {
ErrorType errorType `json:"error" schema:"error"`
Description string `json:"error_description,omitempty" schema:"error_description,omitempty"`
State string `json:"state,omitempty" schema:"state,omitempty"`
- SessionState string `json:"session_state,omitempty" schema:"session_state,omitempty"`
redirectDisabled bool `schema:"-"`
- returnParent bool `schema:"-"`
-}
-
-func (e *Error) MarshalJSON() ([]byte, error) {
- m := struct {
- Error errorType `json:"error"`
- ErrorDescription string `json:"error_description,omitempty"`
- State string `json:"state,omitempty"`
- SessionState string `json:"session_state,omitempty"`
- Parent string `json:"parent,omitempty"`
- }{
- Error: e.ErrorType,
- ErrorDescription: e.Description,
- State: e.State,
- SessionState: e.SessionState,
- }
- if e.returnParent {
- m.Parent = e.Parent.Error()
- }
- return json.Marshal(m)
}
func (e *Error) Error() string {
@@ -179,8 +109,7 @@ func (e *Error) Is(target error) bool {
}
return e.ErrorType == t.ErrorType &&
(e.Description == t.Description || t.Description == "") &&
- (e.State == t.State || t.State == "") &&
- (e.SessionState == t.SessionState || t.SessionState == "")
+ (e.State == t.State || t.State == "")
}
func (e *Error) WithParent(err error) *Error {
@@ -188,19 +117,7 @@ func (e *Error) WithParent(err error) *Error {
return e
}
-// WithReturnParentToClient allows returning the set parent error to the HTTP client.
-// Currently it only supports setting the parent inside JSON responses, not redirect URLs.
-// As Go errors don't unmarshal well, only the marshaller is implemented for the moment.
-//
-// Warning: parent errors may contain sensitive data or unwanted details about the server status.
-// Also, the `parent` field is not a standard error field and might confuse certain clients
-// that require fully compliant responses.
-func (e *Error) WithReturnParentToClient(b bool) *Error {
- e.returnParent = b
- return e
-}
-
-func (e *Error) WithDescription(desc string, args ...any) *Error {
+func (e *Error) WithDescription(desc string, args ...interface{}) *Error {
e.Description = fmt.Sprintf(desc, args...)
return e
}
@@ -220,37 +137,3 @@ func DefaultToServerError(err error, description string) *Error {
}
return oauth
}
-
-func (e *Error) LogLevel() slog.Level {
- level := slog.LevelWarn
- if e.ErrorType == ServerError {
- level = slog.LevelError
- }
- if e.ErrorType == AuthorizationPending {
- level = slog.LevelInfo
- }
- return level
-}
-
-func (e *Error) LogValue() slog.Value {
- attrs := make([]slog.Attr, 0, 5)
- if e.Parent != nil {
- attrs = append(attrs, slog.Any("parent", e.Parent))
- }
- if e.Description != "" {
- attrs = append(attrs, slog.String("description", e.Description))
- }
- if e.ErrorType != "" {
- attrs = append(attrs, slog.String("type", string(e.ErrorType)))
- }
- if e.State != "" {
- attrs = append(attrs, slog.String("state", e.State))
- }
- if e.SessionState != "" {
- attrs = append(attrs, slog.String("session_state", e.SessionState))
- }
- if e.redirectDisabled {
- attrs = append(attrs, slog.Bool("redirect_disabled", e.redirectDisabled))
- }
- return slog.GroupValue(attrs...)
-}
diff --git a/pkg/oidc/error_test.go b/pkg/oidc/error_test.go
deleted file mode 100644
index 40d30b1..0000000
--- a/pkg/oidc/error_test.go
+++ /dev/null
@@ -1,192 +0,0 @@
-package oidc
-
-import (
- "encoding/json"
- "errors"
- "io"
- "log/slog"
- "testing"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestDefaultToServerError(t *testing.T) {
- type args struct {
- err error
- description string
- }
- tests := []struct {
- name string
- args args
- want *Error
- }{
- {
- name: "default",
- args: args{
- err: io.ErrClosedPipe,
- description: "oops",
- },
- want: &Error{
- ErrorType: ServerError,
- Description: "oops",
- Parent: io.ErrClosedPipe,
- },
- },
- {
- name: "our Error",
- args: args{
- err: ErrAccessDenied(),
- description: "oops",
- },
- want: &Error{
- ErrorType: AccessDenied,
- Description: "The authorization request was denied.",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := DefaultToServerError(tt.args.err, tt.args.description)
- assert.ErrorIs(t, got, tt.want)
- })
- }
-}
-
-func TestError_LogLevel(t *testing.T) {
- tests := []struct {
- name string
- err *Error
- want slog.Level
- }{
- {
- name: "server error",
- err: ErrServerError(),
- want: slog.LevelError,
- },
- {
- name: "authorization pending",
- err: ErrAuthorizationPending(),
- want: slog.LevelInfo,
- },
- {
- name: "some other error",
- err: ErrAccessDenied(),
- want: slog.LevelWarn,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := tt.err.LogLevel()
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestError_LogValue(t *testing.T) {
- type fields struct {
- Parent error
- ErrorType errorType
- Description string
- State string
- redirectDisabled bool
- }
- tests := []struct {
- name string
- fields fields
- want slog.Value
- }{
- {
- name: "parent",
- fields: fields{
- Parent: io.EOF,
- },
- want: slog.GroupValue(slog.Any("parent", io.EOF)),
- },
- {
- name: "description",
- fields: fields{
- Description: "oops",
- },
- want: slog.GroupValue(slog.String("description", "oops")),
- },
- {
- name: "errorType",
- fields: fields{
- ErrorType: ExpiredToken,
- },
- want: slog.GroupValue(slog.String("type", string(ExpiredToken))),
- },
- {
- name: "state",
- fields: fields{
- State: "123",
- },
- want: slog.GroupValue(slog.String("state", "123")),
- },
- {
- name: "all fields",
- fields: fields{
- Parent: io.EOF,
- Description: "oops",
- ErrorType: ExpiredToken,
- State: "123",
- },
- want: slog.GroupValue(
- slog.Any("parent", io.EOF),
- slog.String("description", "oops"),
- slog.String("type", string(ExpiredToken)),
- slog.String("state", "123"),
- ),
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- e := &Error{
- Parent: tt.fields.Parent,
- ErrorType: tt.fields.ErrorType,
- Description: tt.fields.Description,
- State: tt.fields.State,
- redirectDisabled: tt.fields.redirectDisabled,
- }
- got := e.LogValue()
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestError_MarshalJSON(t *testing.T) {
- tests := []struct {
- name string
- e *Error
- want string
- }{
- {
- name: "simple error",
- e: ErrAccessDenied(),
- want: `{"error":"access_denied","error_description":"The authorization request was denied."}`,
- },
- {
- name: "with description",
- e: ErrAccessDenied().WithDescription("oops"),
- want: `{"error":"access_denied","error_description":"oops"}`,
- },
- {
- name: "with parent",
- e: ErrServerError().WithParent(errors.New("oops")),
- want: `{"error":"server_error"}`,
- },
- {
- name: "with return parent",
- e: ErrServerError().WithParent(errors.New("oops")).WithReturnParentToClient(true),
- want: `{"error":"server_error","parent":"oops"}`,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got, err := json.Marshal(tt.e)
- require.NoError(t, err)
- assert.JSONEq(t, tt.want, string(got))
- })
- }
-}
diff --git a/pkg/oidc/introspection.go b/pkg/oidc/introspection.go
index 1a200eb..b7c220c 100644
--- a/pkg/oidc/introspection.go
+++ b/pkg/oidc/introspection.go
@@ -1,6 +1,12 @@
package oidc
-import "github.com/muhlemmer/gu"
+import (
+ "encoding/json"
+ "fmt"
+ "time"
+
+ "golang.org/x/text/language"
+)
type IntrospectionRequest struct {
Token string `schema:"token"`
@@ -11,69 +17,364 @@ type ClientAssertionParams struct {
ClientAssertionType string `schema:"client_assertion_type"`
}
-// IntrospectionResponse implements RFC 7662, section 2.2 and
-// OpenID Connect Core 1.0, section 5.1 (UserInfo).
-// https://www.rfc-editor.org/rfc/rfc7662.html#section-2.2.
-// https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.
-type IntrospectionResponse struct {
- Active bool `json:"active"`
- Scope SpaceDelimitedArray `json:"scope,omitempty"`
- ClientID string `json:"client_id,omitempty"`
- TokenType string `json:"token_type,omitempty"`
- Expiration Time `json:"exp,omitempty"`
- IssuedAt Time `json:"iat,omitempty"`
- AuthTime Time `json:"auth_time,omitempty"`
- NotBefore Time `json:"nbf,omitempty"`
- Subject string `json:"sub,omitempty"`
- Audience Audience `json:"aud,omitempty"`
- AuthenticationMethodsReferences []string `json:"amr,omitempty"`
- Issuer string `json:"iss,omitempty"`
- JWTID string `json:"jti,omitempty"`
- Username string `json:"username,omitempty"`
- Actor *ActorClaims `json:"act,omitempty"`
- UserInfoProfile
- UserInfoEmail
- UserInfoPhone
-
- Address *UserInfoAddress `json:"address,omitempty"`
- Claims map[string]any `json:"-"`
+type IntrospectionResponse interface {
+ UserInfoSetter
+ IsActive() bool
+ SetActive(bool)
+ SetScopes(scopes []string)
+ SetClientID(id string)
+ SetTokenType(tokenType string)
+ SetExpiration(exp time.Time)
+ SetIssuedAt(iat time.Time)
+ SetNotBefore(nbf time.Time)
+ SetAudience(audience []string)
+ SetIssuer(issuer string)
+ SetJWTID(id string)
+ GetScope() []string
+ GetClientID() string
+ GetTokenType() string
+ GetExpiration() time.Time
+ GetIssuedAt() time.Time
+ GetNotBefore() time.Time
+ GetSubject() string
+ GetAudience() []string
+ GetIssuer() string
+ GetJWTID() string
}
-// SetUserInfo copies all relevant fields from UserInfo
-// into the IntroSpectionResponse.
-func (i *IntrospectionResponse) SetUserInfo(u *UserInfo) {
- i.Subject = u.Subject
- i.Username = u.PreferredUsername
- i.Address = gu.PtrCopy(u.Address)
- i.UserInfoProfile = u.UserInfoProfile
- i.UserInfoEmail = u.UserInfoEmail
- i.UserInfoPhone = u.UserInfoPhone
- if i.Claims == nil {
- i.Claims = gu.MapCopy(u.Claims)
- } else {
- gu.MapMerge(u.Claims, i.Claims)
- }
+func NewIntrospectionResponse() IntrospectionResponse {
+ return &introspectionResponse{}
}
-// GetAddress is a safe getter that takes
-// care of a possible nil value.
-func (i *IntrospectionResponse) GetAddress() *UserInfoAddress {
- if i.Address == nil {
- return new(UserInfoAddress)
- }
+type introspectionResponse struct {
+ Active bool `json:"active"`
+ Scope SpaceDelimitedArray `json:"scope,omitempty"`
+ ClientID string `json:"client_id,omitempty"`
+ TokenType string `json:"token_type,omitempty"`
+ Expiration Time `json:"exp,omitempty"`
+ IssuedAt Time `json:"iat,omitempty"`
+ NotBefore Time `json:"nbf,omitempty"`
+ Subject string `json:"sub,omitempty"`
+ Audience Audience `json:"aud,omitempty"`
+ Issuer string `json:"iss,omitempty"`
+ JWTID string `json:"jti,omitempty"`
+ userInfoProfile
+ userInfoEmail
+ userInfoPhone
+
+ Address UserInfoAddress `json:"address,omitempty"`
+ claims map[string]interface{}
+}
+
+func (i *introspectionResponse) IsActive() bool {
+ return i.Active
+}
+
+func (i *introspectionResponse) GetSubject() string {
+ return i.Subject
+}
+
+func (i *introspectionResponse) GetName() string {
+ return i.Name
+}
+
+func (i *introspectionResponse) GetGivenName() string {
+ return i.GivenName
+}
+
+func (i *introspectionResponse) GetFamilyName() string {
+ return i.FamilyName
+}
+
+func (i *introspectionResponse) GetMiddleName() string {
+ return i.MiddleName
+}
+
+func (i *introspectionResponse) GetNickname() string {
+ return i.Nickname
+}
+
+func (i *introspectionResponse) GetProfile() string {
+ return i.Profile
+}
+
+func (i *introspectionResponse) GetPicture() string {
+ return i.Picture
+}
+
+func (i *introspectionResponse) GetWebsite() string {
+ return i.Website
+}
+
+func (i *introspectionResponse) GetGender() Gender {
+ return i.Gender
+}
+
+func (i *introspectionResponse) GetBirthdate() string {
+ return i.Birthdate
+}
+
+func (i *introspectionResponse) GetZoneinfo() string {
+ return i.Zoneinfo
+}
+
+func (i *introspectionResponse) GetLocale() language.Tag {
+ return i.Locale
+}
+
+func (i *introspectionResponse) GetPreferredUsername() string {
+ return i.PreferredUsername
+}
+
+func (i *introspectionResponse) GetEmail() string {
+ return i.Email
+}
+
+func (i *introspectionResponse) IsEmailVerified() bool {
+ return bool(i.EmailVerified)
+}
+
+func (i *introspectionResponse) GetPhoneNumber() string {
+ return i.PhoneNumber
+}
+
+func (i *introspectionResponse) IsPhoneNumberVerified() bool {
+ return i.PhoneNumberVerified
+}
+
+func (i *introspectionResponse) GetAddress() UserInfoAddress {
return i.Address
}
-// introspectionResponseAlias prevents loops on the JSON methods
-type introspectionResponseAlias IntrospectionResponse
+func (i *introspectionResponse) GetClaim(key string) interface{} {
+ return i.claims[key]
+}
-func (i *IntrospectionResponse) MarshalJSON() ([]byte, error) {
- if i.Username == "" {
- i.Username = i.PreferredUsername
+func (i *introspectionResponse) GetClaims() map[string]interface{} {
+ return i.claims
+}
+
+func (i *introspectionResponse) GetScope() []string {
+ return []string(i.Scope)
+}
+
+func (i *introspectionResponse) GetClientID() string {
+ return i.ClientID
+}
+
+func (i *introspectionResponse) GetTokenType() string {
+ return i.TokenType
+}
+
+func (i *introspectionResponse) GetExpiration() time.Time {
+ return time.Time(i.Expiration)
+}
+
+func (i *introspectionResponse) GetIssuedAt() time.Time {
+ return time.Time(i.IssuedAt)
+}
+
+func (i *introspectionResponse) GetNotBefore() time.Time {
+ return time.Time(i.NotBefore)
+}
+
+func (i *introspectionResponse) GetAudience() []string {
+ return []string(i.Audience)
+}
+
+func (i *introspectionResponse) GetIssuer() string {
+ return i.Issuer
+}
+
+func (i *introspectionResponse) GetJWTID() string {
+ return i.JWTID
+}
+
+func (i *introspectionResponse) SetActive(active bool) {
+ i.Active = active
+}
+
+func (i *introspectionResponse) SetScopes(scope []string) {
+ i.Scope = scope
+}
+
+func (i *introspectionResponse) SetClientID(id string) {
+ i.ClientID = id
+}
+
+func (i *introspectionResponse) SetTokenType(tokenType string) {
+ i.TokenType = tokenType
+}
+
+func (i *introspectionResponse) SetExpiration(exp time.Time) {
+ i.Expiration = Time(exp)
+}
+
+func (i *introspectionResponse) SetIssuedAt(iat time.Time) {
+ i.IssuedAt = Time(iat)
+}
+
+func (i *introspectionResponse) SetNotBefore(nbf time.Time) {
+ i.NotBefore = Time(nbf)
+}
+
+func (i *introspectionResponse) SetAudience(audience []string) {
+ i.Audience = audience
+}
+
+func (i *introspectionResponse) SetIssuer(issuer string) {
+ i.Issuer = issuer
+}
+
+func (i *introspectionResponse) SetJWTID(id string) {
+ i.JWTID = id
+}
+
+func (i *introspectionResponse) SetSubject(sub string) {
+ i.Subject = sub
+}
+
+func (i *introspectionResponse) SetName(name string) {
+ i.Name = name
+}
+
+func (i *introspectionResponse) SetGivenName(name string) {
+ i.GivenName = name
+}
+
+func (i *introspectionResponse) SetFamilyName(name string) {
+ i.FamilyName = name
+}
+
+func (i *introspectionResponse) SetMiddleName(name string) {
+ i.MiddleName = name
+}
+
+func (i *introspectionResponse) SetNickname(name string) {
+ i.Nickname = name
+}
+
+func (i *introspectionResponse) SetUpdatedAt(date time.Time) {
+ i.UpdatedAt = Time(date)
+}
+
+func (i *introspectionResponse) SetProfile(profile string) {
+ i.Profile = profile
+}
+
+func (i *introspectionResponse) SetPicture(picture string) {
+ i.Picture = picture
+}
+
+func (i *introspectionResponse) SetWebsite(website string) {
+ i.Website = website
+}
+
+func (i *introspectionResponse) SetGender(gender Gender) {
+ i.Gender = gender
+}
+
+func (i *introspectionResponse) SetBirthdate(birthdate string) {
+ i.Birthdate = birthdate
+}
+
+func (i *introspectionResponse) SetZoneinfo(zoneInfo string) {
+ i.Zoneinfo = zoneInfo
+}
+
+func (i *introspectionResponse) SetLocale(locale language.Tag) {
+ i.Locale = locale
+}
+
+func (i *introspectionResponse) SetPreferredUsername(name string) {
+ i.PreferredUsername = name
+}
+
+func (i *introspectionResponse) SetEmail(email string, verified bool) {
+ i.Email = email
+ i.EmailVerified = boolString(verified)
+}
+
+func (i *introspectionResponse) SetPhone(phone string, verified bool) {
+ i.PhoneNumber = phone
+ i.PhoneNumberVerified = verified
+}
+
+func (i *introspectionResponse) SetAddress(address UserInfoAddress) {
+ i.Address = address
+}
+
+func (i *introspectionResponse) AppendClaims(key string, value interface{}) {
+ if i.claims == nil {
+ i.claims = make(map[string]interface{})
}
- return mergeAndMarshalClaims((*introspectionResponseAlias)(i), i.Claims)
+ i.claims[key] = value
}
-func (i *IntrospectionResponse) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*introspectionResponseAlias)(i), &i.Claims)
+func (i *introspectionResponse) MarshalJSON() ([]byte, error) {
+ type Alias introspectionResponse
+ a := &struct {
+ *Alias
+ Expiration int64 `json:"exp,omitempty"`
+ IssuedAt int64 `json:"iat,omitempty"`
+ NotBefore int64 `json:"nbf,omitempty"`
+ Locale interface{} `json:"locale,omitempty"`
+ UpdatedAt int64 `json:"updated_at,omitempty"`
+ Username string `json:"username,omitempty"`
+ }{
+ Alias: (*Alias)(i),
+ }
+ if !i.Locale.IsRoot() {
+ a.Locale = i.Locale
+ }
+ if !time.Time(i.UpdatedAt).IsZero() {
+ a.UpdatedAt = time.Time(i.UpdatedAt).Unix()
+ }
+ if !time.Time(i.Expiration).IsZero() {
+ a.Expiration = time.Time(i.Expiration).Unix()
+ }
+ if !time.Time(i.IssuedAt).IsZero() {
+ a.IssuedAt = time.Time(i.IssuedAt).Unix()
+ }
+ if !time.Time(i.NotBefore).IsZero() {
+ a.NotBefore = time.Time(i.NotBefore).Unix()
+ }
+ a.Username = i.PreferredUsername
+
+ b, err := json.Marshal(a)
+ if err != nil {
+ return nil, err
+ }
+
+ if len(i.claims) == 0 {
+ return b, nil
+ }
+
+ err = json.Unmarshal(b, &i.claims)
+ if err != nil {
+ return nil, fmt.Errorf("jws: invalid map of custom claims %v", i.claims)
+ }
+
+ return json.Marshal(i.claims)
+}
+
+func (i *introspectionResponse) UnmarshalJSON(data []byte) error {
+ type Alias introspectionResponse
+ a := &struct {
+ *Alias
+ UpdatedAt int64 `json:"update_at,omitempty"`
+ }{
+ Alias: (*Alias)(i),
+ }
+ if err := json.Unmarshal(data, &a); err != nil {
+ return err
+ }
+
+ i.UpdatedAt = Time(time.Unix(a.UpdatedAt, 0).UTC())
+
+ if err := json.Unmarshal(data, &i.claims); err != nil {
+ return err
+ }
+
+ return nil
}
diff --git a/pkg/oidc/introspection_test.go b/pkg/oidc/introspection_test.go
deleted file mode 100644
index 60cf8a4..0000000
--- a/pkg/oidc/introspection_test.go
+++ /dev/null
@@ -1,79 +0,0 @@
-package oidc
-
-import (
- "encoding/json"
- "testing"
-
- "github.com/muhlemmer/gu"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestIntrospectionResponse_SetUserInfo(t *testing.T) {
- tests := []struct {
- name string
- start *IntrospectionResponse
- want *IntrospectionResponse
- }{
- {
-
- name: "nil claims",
- start: &IntrospectionResponse{},
- want: &IntrospectionResponse{
- Subject: userInfoData.Subject,
- Username: userInfoData.PreferredUsername,
- Address: userInfoData.Address,
- UserInfoProfile: userInfoData.UserInfoProfile,
- UserInfoEmail: userInfoData.UserInfoEmail,
- UserInfoPhone: userInfoData.UserInfoPhone,
- Claims: gu.MapCopy(userInfoData.Claims),
- },
- },
- {
-
- name: "merge claims",
- start: &IntrospectionResponse{
- Claims: map[string]any{
- "hello": "world",
- },
- },
- want: &IntrospectionResponse{
- Subject: userInfoData.Subject,
- Username: userInfoData.PreferredUsername,
- Address: userInfoData.Address,
- UserInfoProfile: userInfoData.UserInfoProfile,
- UserInfoEmail: userInfoData.UserInfoEmail,
- UserInfoPhone: userInfoData.UserInfoPhone,
- Claims: map[string]any{
- "foo": "bar",
- "hello": "world",
- },
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- tt.start.SetUserInfo(userInfoData)
- assert.Equal(t, tt.want, tt.start)
- })
- }
-}
-
-func TestIntrospectionResponse_GetAddress(t *testing.T) {
- // nil address
- i := new(IntrospectionResponse)
- assert.Equal(t, &UserInfoAddress{}, i.GetAddress())
-
- i.Address = &UserInfoAddress{PostalCode: "1234"}
- assert.Equal(t, i.Address, i.GetAddress())
-}
-
-func TestIntrospectionResponse_MarshalJSON(t *testing.T) {
- got, err := json.Marshal(&IntrospectionResponse{
- UserInfoProfile: UserInfoProfile{
- PreferredUsername: "muhlemmer",
- },
- })
- require.NoError(t, err)
- assert.Equal(t, string(got), `{"active":false,"username":"muhlemmer","preferred_username":"muhlemmer"}`)
-}
diff --git a/pkg/oidc/keyset.go b/pkg/oidc/keyset.go
index a8b89b0..c6e865b 100644
--- a/pkg/oidc/keyset.go
+++ b/pkg/oidc/keyset.go
@@ -6,9 +6,8 @@ import (
"crypto/ed25519"
"crypto/rsa"
"errors"
- "strings"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
)
const (
@@ -47,8 +46,8 @@ func GetKeyIDAndAlg(jws *jose.JSONWebSignature) (string, string) {
//
// will return false none or multiple match
//
-// deprecated: use FindMatchingKey which will return an error (more specific) instead of just a bool
-// moved implementation already to FindMatchingKey
+//deprecated: use FindMatchingKey which will return an error (more specific) instead of just a bool
+//moved implementation already to FindMatchingKey
func FindKey(keyID, use, expectedAlg string, keys ...jose.JSONWebKey) (jose.JSONWebKey, bool) {
key, err := FindMatchingKey(keyID, use, expectedAlg, keys...)
return key, err == nil
@@ -92,18 +91,18 @@ func FindMatchingKey(keyID, use, expectedAlg string, keys ...jose.JSONWebKey) (k
return key, ErrKeyNone
}
-func algToKeyType(key any, alg string) bool {
- if strings.HasPrefix(alg, "RS") || strings.HasPrefix(alg, "PS") {
+func algToKeyType(key interface{}, alg string) bool {
+ switch alg[0] {
+ case 'R', 'P':
_, ok := key.(*rsa.PublicKey)
return ok
- }
- if strings.HasPrefix(alg, "ES") {
+ case 'E':
_, ok := key.(*ecdsa.PublicKey)
return ok
- }
- if alg == string(jose.EdDSA) {
- _, ok := key.(ed25519.PublicKey)
+ case 'O':
+ _, ok := key.(*ed25519.PublicKey)
return ok
+ default:
+ return false
}
- return false
}
diff --git a/pkg/oidc/keyset_test.go b/pkg/oidc/keyset_test.go
index e01074e..82b3ee8 100644
--- a/pkg/oidc/keyset_test.go
+++ b/pkg/oidc/keyset_test.go
@@ -7,7 +7,7 @@ import (
"reflect"
"testing"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
)
func TestFindKey(t *testing.T) {
diff --git a/pkg/oidc/regression_assert_test.go b/pkg/oidc/regression_assert_test.go
deleted file mode 100644
index dd9f5ad..0000000
--- a/pkg/oidc/regression_assert_test.go
+++ /dev/null
@@ -1,53 +0,0 @@
-//go:build !create_regression_data
-
-package oidc
-
-import (
- "encoding/json"
- "io"
- "os"
- "reflect"
- "strings"
- "testing"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-// Test_assert_regression verifies current output from
-// json.Marshal to stored regression data.
-// These tests are only ran when the create_regression_data
-// tag is NOT set.
-func Test_assert_regression(t *testing.T) {
- buf := new(strings.Builder)
-
- for _, obj := range regressionData {
- name := jsonFilename(obj)
- t.Run(name, func(t *testing.T) {
- file, err := os.Open(name)
- require.NoError(t, err)
- defer file.Close()
-
- _, err = io.Copy(buf, file)
- require.NoError(t, err)
- want := buf.String()
- buf.Reset()
-
- encodeJSON(t, buf, obj)
- first := buf.String()
- buf.Reset()
-
- assert.JSONEq(t, want, first)
-
- target := reflect.New(reflect.TypeOf(obj).Elem()).Interface()
-
- require.NoError(t,
- json.Unmarshal([]byte(first), target),
- )
- second, err := json.Marshal(target)
- require.NoError(t, err)
-
- assert.JSONEq(t, want, string(second))
- })
- }
-}
diff --git a/pkg/oidc/regression_create_test.go b/pkg/oidc/regression_create_test.go
deleted file mode 100644
index 809fe60..0000000
--- a/pkg/oidc/regression_create_test.go
+++ /dev/null
@@ -1,24 +0,0 @@
-//go:build create_regression_data
-
-package oidc
-
-import (
- "os"
- "testing"
-
- "github.com/stretchr/testify/require"
-)
-
-// Test_create_regression generates the regression data.
-// It is excluded from regular testing, unless
-// called with the create_regression_data tag:
-// go test -tags="create_regression_data" ./pkg/oidc
-func Test_create_regression(t *testing.T) {
- for _, obj := range regressionData {
- file, err := os.Create(jsonFilename(obj))
- require.NoError(t, err)
- defer file.Close()
-
- encodeJSON(t, file, obj)
- }
-}
diff --git a/pkg/oidc/regression_data/oidc.AccessTokenClaims.json b/pkg/oidc/regression_data/oidc.AccessTokenClaims.json
deleted file mode 100644
index b63bf30..0000000
--- a/pkg/oidc/regression_data/oidc.AccessTokenClaims.json
+++ /dev/null
@@ -1,23 +0,0 @@
-{
- "iss": "zitadel",
- "sub": "hello@me.com",
- "aud": [
- "foo",
- "bar"
- ],
- "jti": "900",
- "azp": "just@me.com",
- "nonce": "6969",
- "acr": "something",
- "amr": [
- "some",
- "methods"
- ],
- "scope": "email phone",
- "client_id": "777",
- "exp": 12345,
- "iat": 12000,
- "nbf": 12000,
- "auth_time": 12000,
- "foo": "bar"
-}
diff --git a/pkg/oidc/regression_data/oidc.IDTokenClaims.json b/pkg/oidc/regression_data/oidc.IDTokenClaims.json
deleted file mode 100644
index af503fb..0000000
--- a/pkg/oidc/regression_data/oidc.IDTokenClaims.json
+++ /dev/null
@@ -1,51 +0,0 @@
-{
- "iss": "zitadel",
- "aud": [
- "foo",
- "bar"
- ],
- "jti": "900",
- "azp": "just@me.com",
- "nonce": "6969",
- "at_hash": "acthashhash",
- "c_hash": "hashhash",
- "acr": "something",
- "amr": [
- "some",
- "methods"
- ],
- "sid": "666",
- "client_id": "777",
- "exp": 12345,
- "iat": 12000,
- "nbf": 12000,
- "auth_time": 12000,
- "address": {
- "country": "Moon",
- "formatted": "Sesame street 666\n666-666, Smallvile\nMoon",
- "locality": "Smallvile",
- "postal_code": "666-666",
- "region": "Outer space",
- "street_address": "Sesame street 666"
- },
- "birthdate": "1st of April",
- "email": "tim@zitadel.com",
- "email_verified": true,
- "family_name": "MÃļhlmann",
- "foo": "bar",
- "gender": "male",
- "given_name": "Tim",
- "locale": "nl",
- "middle_name": "Danger",
- "name": "Tim MÃļhlmann",
- "nickname": "muhlemmer",
- "phone_number": "+1234567890",
- "phone_number_verified": true,
- "picture": "https://avatars.githubusercontent.com/u/5411563?v=4",
- "preferred_username": "muhlemmer",
- "profile": "https://github.com/muhlemmer",
- "sub": "hello@me.com",
- "updated_at": 1,
- "website": "https://zitadel.com",
- "zoneinfo": "Europe/Amsterdam"
-}
diff --git a/pkg/oidc/regression_data/oidc.IntrospectionResponse.json b/pkg/oidc/regression_data/oidc.IntrospectionResponse.json
deleted file mode 100644
index e0c21a2..0000000
--- a/pkg/oidc/regression_data/oidc.IntrospectionResponse.json
+++ /dev/null
@@ -1,44 +0,0 @@
-{
- "active": true,
- "address": {
- "country": "Moon",
- "formatted": "Sesame street 666\n666-666, Smallvile\nMoon",
- "locality": "Smallvile",
- "postal_code": "666-666",
- "region": "Outer space",
- "street_address": "Sesame street 666"
- },
- "aud": [
- "foo",
- "bar"
- ],
- "birthdate": "1st of April",
- "client_id": "777",
- "email": "tim@zitadel.com",
- "email_verified": true,
- "exp": 12345,
- "family_name": "MÃļhlmann",
- "foo": "bar",
- "gender": "male",
- "given_name": "Tim",
- "iat": 12000,
- "iss": "zitadel",
- "jti": "900",
- "locale": "nl",
- "middle_name": "Danger",
- "name": "Tim MÃļhlmann",
- "nbf": 12000,
- "nickname": "muhlemmer",
- "phone_number": "+1234567890",
- "phone_number_verified": true,
- "picture": "https://avatars.githubusercontent.com/u/5411563?v=4",
- "preferred_username": "muhlemmer",
- "profile": "https://github.com/muhlemmer",
- "scope": "email phone",
- "sub": "hello@me.com",
- "token_type": "idtoken",
- "updated_at": 1,
- "username": "muhlemmer",
- "website": "https://zitadel.com",
- "zoneinfo": "Europe/Amsterdam"
-}
diff --git a/pkg/oidc/regression_data/oidc.JWTProfileAssertionClaims.json b/pkg/oidc/regression_data/oidc.JWTProfileAssertionClaims.json
deleted file mode 100644
index 4ece780..0000000
--- a/pkg/oidc/regression_data/oidc.JWTProfileAssertionClaims.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "aud": [
- "foo",
- "bar"
- ],
- "exp": 12345,
- "foo": "bar",
- "iat": 12000,
- "iss": "zitadel",
- "sub": "hello@me.com"
-}
diff --git a/pkg/oidc/regression_data/oidc.UserInfo.json b/pkg/oidc/regression_data/oidc.UserInfo.json
deleted file mode 100644
index d7795e7..0000000
--- a/pkg/oidc/regression_data/oidc.UserInfo.json
+++ /dev/null
@@ -1,30 +0,0 @@
-{
- "address": {
- "country": "Moon",
- "formatted": "Sesame street 666\n666-666, Smallvile\nMoon",
- "locality": "Smallvile",
- "postal_code": "666-666",
- "region": "Outer space",
- "street_address": "Sesame street 666"
- },
- "birthdate": "1st of April",
- "email": "tim@zitadel.com",
- "email_verified": true,
- "family_name": "MÃļhlmann",
- "foo": "bar",
- "gender": "male",
- "given_name": "Tim",
- "locale": "nl",
- "middle_name": "Danger",
- "name": "Tim MÃļhlmann",
- "nickname": "muhlemmer",
- "phone_number": "+1234567890",
- "phone_number_verified": true,
- "picture": "https://avatars.githubusercontent.com/u/5411563?v=4",
- "preferred_username": "muhlemmer",
- "profile": "https://github.com/muhlemmer",
- "sub": "hello@me.com",
- "updated_at": 1,
- "website": "https://zitadel.com",
- "zoneinfo": "Europe/Amsterdam"
-}
diff --git a/pkg/oidc/regression_test.go b/pkg/oidc/regression_test.go
deleted file mode 100644
index 9cb3ff9..0000000
--- a/pkg/oidc/regression_test.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package oidc
-
-// This file contains common functions and data for regression testing
-
-import (
- "encoding/json"
- "fmt"
- "io"
- "path"
- "strings"
- "testing"
-
- "github.com/stretchr/testify/require"
-)
-
-const dataDir = "regression_data"
-
-// jsonFilename builds a filename for the regression testdata.
-// dataDir/.json
-func jsonFilename(obj any) string {
- name := fmt.Sprintf("%T.json", obj)
- return path.Join(
- dataDir,
- strings.TrimPrefix(name, "*"),
- )
-}
-
-func encodeJSON(t *testing.T, w io.Writer, obj any) {
- enc := json.NewEncoder(w)
- enc.SetIndent("", "\t")
- require.NoError(t, enc.Encode(obj))
-}
-
-var regressionData = []any{
- accessTokenData,
- idTokenData,
- introspectionResponseData,
- userInfoData,
- jwtProfileAssertionData,
-}
diff --git a/pkg/oidc/session.go b/pkg/oidc/session.go
index 39f9f08..b470d1e 100644
--- a/pkg/oidc/session.go
+++ b/pkg/oidc/session.go
@@ -1,12 +1,10 @@
package oidc
// EndSessionRequest for the RP-Initiated Logout according to:
-// https://openid.net/specs/openid-connect-rpinitiated-1_0.html#RPLogout
+//https://openid.net/specs/openid-connect-rpinitiated-1_0.html#RPLogout
type EndSessionRequest struct {
- IdTokenHint string `schema:"id_token_hint"`
- LogoutHint string `schema:"logout_hint"`
- ClientID string `schema:"client_id"`
- PostLogoutRedirectURI string `schema:"post_logout_redirect_uri"`
- State string `schema:"state"`
- UILocales Locales `schema:"ui_locales"`
+ IdTokenHint string `schema:"id_token_hint"`
+ ClientID string `schema:"client_id"`
+ PostLogoutRedirectURI string `schema:"post_logout_redirect_uri"`
+ State string `schema:"state"`
}
diff --git a/pkg/oidc/token.go b/pkg/oidc/token.go
index 4b43dcb..fb87e13 100644
--- a/pkg/oidc/token.go
+++ b/pkg/oidc/token.go
@@ -2,15 +2,15 @@ package oidc
import (
"encoding/json"
- "os"
+ "fmt"
+ "io/ioutil"
"time"
- jose "github.com/go-jose/go-jose/v4"
"golang.org/x/oauth2"
+ "gopkg.in/square/go-jose.v2"
- "github.com/muhlemmer/gu"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/crypto"
+ "github.com/zitadel/oidc/pkg/crypto"
+ "github.com/zitadel/oidc/pkg/http"
)
const (
@@ -20,226 +20,398 @@ const (
PrefixBearer = BearerToken + " "
)
-type Tokens[C IDClaims] struct {
+type Tokens struct {
*oauth2.Token
- IDTokenClaims C
+ IDTokenClaims IDTokenClaims
IDToken string
}
-// TokenClaims contains the base Claims used all tokens.
-// It implements OpenID Connect Core 1.0, section 2.
-// https://openid.net/specs/openid-connect-core-1_0.html#IDToken
-// And RFC 9068: JSON Web Token (JWT) Profile for OAuth 2.0 Access Tokens,
-// section 2.2. https://datatracker.ietf.org/doc/html/rfc9068#name-data-structure
-//
-// TokenClaims implements the Claims interface,
-// and can be used to extend larger claim types by embedding.
-type TokenClaims struct {
- Issuer string `json:"iss,omitempty"`
- Subject string `json:"sub,omitempty"`
- Audience Audience `json:"aud,omitempty"`
- Expiration Time `json:"exp,omitempty"`
- IssuedAt Time `json:"iat,omitempty"`
- AuthTime Time `json:"auth_time,omitempty"`
- NotBefore Time `json:"nbf,omitempty"`
- Nonce string `json:"nonce,omitempty"`
- AuthenticationContextClassReference string `json:"acr,omitempty"`
- AuthenticationMethodsReferences []string `json:"amr,omitempty"`
- AuthorizedParty string `json:"azp,omitempty"`
- ClientID string `json:"client_id,omitempty"`
- JWTID string `json:"jti,omitempty"`
- Actor *ActorClaims `json:"act,omitempty"`
-
- // Additional information set by this framework
- SignatureAlg jose.SignatureAlgorithm `json:"-"`
+type AccessTokenClaims interface {
+ Claims
+ GetSubject() string
+ GetTokenID() string
+ SetPrivateClaims(map[string]interface{})
}
-func (c *TokenClaims) GetIssuer() string {
- return c.Issuer
+type IDTokenClaims interface {
+ Claims
+ GetNotBefore() time.Time
+ GetJWTID() string
+ GetAccessTokenHash() string
+ GetCodeHash() string
+ GetAuthenticationMethodsReferences() []string
+ GetClientID() string
+ GetSignatureAlgorithm() jose.SignatureAlgorithm
+ SetAccessTokenHash(hash string)
+ SetUserinfo(userinfo UserInfo)
+ SetCodeHash(hash string)
+ UserInfo
}
-func (c *TokenClaims) GetSubject() string {
- return c.Subject
+func EmptyAccessTokenClaims() AccessTokenClaims {
+ return new(accessTokenClaims)
}
-func (c *TokenClaims) GetAudience() []string {
- return c.Audience
-}
-
-func (c *TokenClaims) GetExpiration() time.Time {
- return c.Expiration.AsTime()
-}
-
-func (c *TokenClaims) GetIssuedAt() time.Time {
- return c.IssuedAt.AsTime()
-}
-
-func (c *TokenClaims) GetNonce() string {
- return c.Nonce
-}
-
-func (c *TokenClaims) GetAuthTime() time.Time {
- return c.AuthTime.AsTime()
-}
-
-func (c *TokenClaims) GetAuthorizedParty() string {
- return c.AuthorizedParty
-}
-
-func (c *TokenClaims) GetSignatureAlgorithm() jose.SignatureAlgorithm {
- return c.SignatureAlg
-}
-
-func (c *TokenClaims) GetAuthenticationContextClassReference() string {
- return c.AuthenticationContextClassReference
-}
-
-func (c *TokenClaims) SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm) {
- c.SignatureAlg = algorithm
-}
-
-type AccessTokenClaims struct {
- TokenClaims
- Scopes SpaceDelimitedArray `json:"scope,omitempty"`
- Claims map[string]any `json:"-"`
-}
-
-func NewAccessTokenClaims(issuer, subject string, audience []string, expiration time.Time, jwtid, clientID string, skew time.Duration) *AccessTokenClaims {
+func NewAccessTokenClaims(issuer, subject string, audience []string, expiration time.Time, id, clientID string, skew time.Duration) AccessTokenClaims {
now := time.Now().UTC().Add(-skew)
if len(audience) == 0 {
audience = append(audience, clientID)
}
- return &AccessTokenClaims{
- TokenClaims: TokenClaims{
- Issuer: issuer,
- Subject: subject,
- Audience: audience,
- Expiration: FromTime(expiration),
- IssuedAt: FromTime(now),
- NotBefore: FromTime(now),
- ClientID: clientID,
- JWTID: jwtid,
- },
+ return &accessTokenClaims{
+ Issuer: issuer,
+ Subject: subject,
+ Audience: audience,
+ Expiration: Time(expiration),
+ IssuedAt: Time(now),
+ NotBefore: Time(now),
+ JWTID: id,
}
}
-type atcAlias AccessTokenClaims
+type accessTokenClaims struct {
+ Issuer string `json:"iss,omitempty"`
+ Subject string `json:"sub,omitempty"`
+ Audience Audience `json:"aud,omitempty"`
+ Expiration Time `json:"exp,omitempty"`
+ IssuedAt Time `json:"iat,omitempty"`
+ NotBefore Time `json:"nbf,omitempty"`
+ JWTID string `json:"jti,omitempty"`
+ AuthorizedParty string `json:"azp,omitempty"`
+ Nonce string `json:"nonce,omitempty"`
+ AuthTime Time `json:"auth_time,omitempty"`
+ CodeHash string `json:"c_hash,omitempty"`
+ AuthenticationContextClassReference string `json:"acr,omitempty"`
+ AuthenticationMethodsReferences []string `json:"amr,omitempty"`
+ SessionID string `json:"sid,omitempty"`
+ Scopes SpaceDelimitedArray `json:"scope,omitempty"`
+ ClientID string `json:"client_id,omitempty"`
+ AccessTokenUseNumber int `json:"at_use_nbr,omitempty"`
-func (a *AccessTokenClaims) MarshalJSON() ([]byte, error) {
- return mergeAndMarshalClaims((*atcAlias)(a), a.Claims)
+ claims map[string]interface{} `json:"-"`
+ signatureAlg jose.SignatureAlgorithm `json:"-"`
}
-func (a *AccessTokenClaims) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*atcAlias)(a), &a.Claims)
+// GetIssuer implements the Claims interface
+func (a *accessTokenClaims) GetIssuer() string {
+ return a.Issuer
}
-// IDTokenClaims extends TokenClaims by further implementing
-// OpenID Connect Core 1.0, sections 3.1.3.6 (Code flow),
-// 3.2.2.10 (implicit), 3.3.2.11 (Hybrid) and 5.1 (UserInfo).
-// https://openid.net/specs/openid-connect-core-1_0.html#toc
-type IDTokenClaims struct {
- TokenClaims
- NotBefore Time `json:"nbf,omitempty"`
- AccessTokenHash string `json:"at_hash,omitempty"`
- CodeHash string `json:"c_hash,omitempty"`
- SessionID string `json:"sid,omitempty"`
- UserInfoProfile
- UserInfoEmail
- UserInfoPhone
- Address *UserInfoAddress `json:"address,omitempty"`
- Claims map[string]any `json:"-"`
+// GetAudience implements the Claims interface
+func (a *accessTokenClaims) GetAudience() []string {
+ return a.Audience
+}
+
+// GetExpiration implements the Claims interface
+func (a *accessTokenClaims) GetExpiration() time.Time {
+ return time.Time(a.Expiration)
+}
+
+// GetIssuedAt implements the Claims interface
+func (a *accessTokenClaims) GetIssuedAt() time.Time {
+ return time.Time(a.IssuedAt)
+}
+
+// GetNonce implements the Claims interface
+func (a *accessTokenClaims) GetNonce() string {
+ return a.Nonce
+}
+
+// GetAuthenticationContextClassReference implements the Claims interface
+func (a *accessTokenClaims) GetAuthenticationContextClassReference() string {
+ return a.AuthenticationContextClassReference
+}
+
+// GetAuthTime implements the Claims interface
+func (a *accessTokenClaims) GetAuthTime() time.Time {
+ return time.Time(a.AuthTime)
+}
+
+// GetAuthorizedParty implements the Claims interface
+func (a *accessTokenClaims) GetAuthorizedParty() string {
+ return a.AuthorizedParty
+}
+
+// SetSignatureAlgorithm implements the Claims interface
+func (a *accessTokenClaims) SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm) {
+ a.signatureAlg = algorithm
+}
+
+// GetSubject implements the AccessTokenClaims interface
+func (a *accessTokenClaims) GetSubject() string {
+ return a.Subject
+}
+
+// GetTokenID implements the AccessTokenClaims interface
+func (a *accessTokenClaims) GetTokenID() string {
+ return a.JWTID
+}
+
+// SetPrivateClaims implements the AccessTokenClaims interface
+func (a *accessTokenClaims) SetPrivateClaims(claims map[string]interface{}) {
+ a.claims = claims
+}
+
+func (a *accessTokenClaims) MarshalJSON() ([]byte, error) {
+ type Alias accessTokenClaims
+ s := &struct {
+ *Alias
+ Expiration int64 `json:"exp,omitempty"`
+ IssuedAt int64 `json:"iat,omitempty"`
+ NotBefore int64 `json:"nbf,omitempty"`
+ AuthTime int64 `json:"auth_time,omitempty"`
+ }{
+ Alias: (*Alias)(a),
+ }
+ if !time.Time(a.Expiration).IsZero() {
+ s.Expiration = time.Time(a.Expiration).Unix()
+ }
+ if !time.Time(a.IssuedAt).IsZero() {
+ s.IssuedAt = time.Time(a.IssuedAt).Unix()
+ }
+ if !time.Time(a.NotBefore).IsZero() {
+ s.NotBefore = time.Time(a.NotBefore).Unix()
+ }
+ if !time.Time(a.AuthTime).IsZero() {
+ s.AuthTime = time.Time(a.AuthTime).Unix()
+ }
+ b, err := json.Marshal(s)
+ if err != nil {
+ return nil, err
+ }
+
+ if a.claims == nil {
+ return b, nil
+ }
+ info, err := json.Marshal(a.claims)
+ if err != nil {
+ return nil, err
+ }
+ return http.ConcatenateJSON(b, info)
+}
+
+func (a *accessTokenClaims) UnmarshalJSON(data []byte) error {
+ type Alias accessTokenClaims
+ if err := json.Unmarshal(data, (*Alias)(a)); err != nil {
+ return err
+ }
+ claims := make(map[string]interface{})
+ if err := json.Unmarshal(data, &claims); err != nil {
+ return err
+ }
+ a.claims = claims
+
+ return nil
+}
+
+func EmptyIDTokenClaims() IDTokenClaims {
+ return new(idTokenClaims)
+}
+
+func NewIDTokenClaims(issuer, subject string, audience []string, expiration, authTime time.Time, nonce string, acr string, amr []string, clientID string, skew time.Duration) IDTokenClaims {
+ audience = AppendClientIDToAudience(clientID, audience)
+ return &idTokenClaims{
+ Issuer: issuer,
+ Audience: audience,
+ Expiration: Time(expiration),
+ IssuedAt: Time(time.Now().UTC().Add(-skew)),
+ AuthTime: Time(authTime.Add(-skew)),
+ Nonce: nonce,
+ AuthenticationContextClassReference: acr,
+ AuthenticationMethodsReferences: amr,
+ AuthorizedParty: clientID,
+ UserInfo: &userinfo{Subject: subject},
+ }
+}
+
+type idTokenClaims struct {
+ Issuer string `json:"iss,omitempty"`
+ Audience Audience `json:"aud,omitempty"`
+ Expiration Time `json:"exp,omitempty"`
+ NotBefore Time `json:"nbf,omitempty"`
+ IssuedAt Time `json:"iat,omitempty"`
+ JWTID string `json:"jti,omitempty"`
+ AuthorizedParty string `json:"azp,omitempty"`
+ Nonce string `json:"nonce,omitempty"`
+ AuthTime Time `json:"auth_time,omitempty"`
+ AccessTokenHash string `json:"at_hash,omitempty"`
+ CodeHash string `json:"c_hash,omitempty"`
+ AuthenticationContextClassReference string `json:"acr,omitempty"`
+ AuthenticationMethodsReferences []string `json:"amr,omitempty"`
+ ClientID string `json:"client_id,omitempty"`
+ UserInfo `json:"-"`
+
+ signatureAlg jose.SignatureAlgorithm
+}
+
+// GetIssuer implements the Claims interface
+func (t *idTokenClaims) GetIssuer() string {
+ return t.Issuer
+}
+
+// GetAudience implements the Claims interface
+func (t *idTokenClaims) GetAudience() []string {
+ return t.Audience
+}
+
+// GetExpiration implements the Claims interface
+func (t *idTokenClaims) GetExpiration() time.Time {
+ return time.Time(t.Expiration)
+}
+
+// GetIssuedAt implements the Claims interface
+func (t *idTokenClaims) GetIssuedAt() time.Time {
+ return time.Time(t.IssuedAt)
+}
+
+// GetNonce implements the Claims interface
+func (t *idTokenClaims) GetNonce() string {
+ return t.Nonce
+}
+
+// GetAuthenticationContextClassReference implements the Claims interface
+func (t *idTokenClaims) GetAuthenticationContextClassReference() string {
+ return t.AuthenticationContextClassReference
+}
+
+// GetAuthTime implements the Claims interface
+func (t *idTokenClaims) GetAuthTime() time.Time {
+ return time.Time(t.AuthTime)
+}
+
+// GetAuthorizedParty implements the Claims interface
+func (t *idTokenClaims) GetAuthorizedParty() string {
+ return t.AuthorizedParty
+}
+
+// SetSignatureAlgorithm implements the Claims interface
+func (t *idTokenClaims) SetSignatureAlgorithm(alg jose.SignatureAlgorithm) {
+ t.signatureAlg = alg
+}
+
+// GetNotBefore implements the IDTokenClaims interface
+func (t *idTokenClaims) GetNotBefore() time.Time {
+ return time.Time(t.NotBefore)
+}
+
+// GetJWTID implements the IDTokenClaims interface
+func (t *idTokenClaims) GetJWTID() string {
+ return t.JWTID
}
// GetAccessTokenHash implements the IDTokenClaims interface
-func (t *IDTokenClaims) GetAccessTokenHash() string {
+func (t *idTokenClaims) GetAccessTokenHash() string {
return t.AccessTokenHash
}
-func (t *IDTokenClaims) SetUserInfo(i *UserInfo) {
- t.Subject = i.Subject
- t.UserInfoProfile = i.UserInfoProfile
- t.UserInfoEmail = i.UserInfoEmail
- t.UserInfoPhone = i.UserInfoPhone
- t.Address = i.Address
- if t.Claims == nil {
- t.Claims = make(map[string]any, len(t.Claims))
+// GetCodeHash implements the IDTokenClaims interface
+func (t *idTokenClaims) GetCodeHash() string {
+ return t.CodeHash
+}
+
+// GetAuthenticationMethodsReferences implements the IDTokenClaims interface
+func (t *idTokenClaims) GetAuthenticationMethodsReferences() []string {
+ return t.AuthenticationMethodsReferences
+}
+
+// GetClientID implements the IDTokenClaims interface
+func (t *idTokenClaims) GetClientID() string {
+ return t.ClientID
+}
+
+// GetSignatureAlgorithm implements the IDTokenClaims interface
+func (t *idTokenClaims) GetSignatureAlgorithm() jose.SignatureAlgorithm {
+ return t.signatureAlg
+}
+
+// SetAccessTokenHash implements the IDTokenClaims interface
+func (t *idTokenClaims) SetAccessTokenHash(hash string) {
+ t.AccessTokenHash = hash
+}
+
+// SetUserinfo implements the IDTokenClaims interface
+func (t *idTokenClaims) SetUserinfo(info UserInfo) {
+ t.UserInfo = info
+}
+
+// SetCodeHash implements the IDTokenClaims interface
+func (t *idTokenClaims) SetCodeHash(hash string) {
+ t.CodeHash = hash
+}
+
+func (t *idTokenClaims) MarshalJSON() ([]byte, error) {
+ type Alias idTokenClaims
+ a := &struct {
+ *Alias
+ Expiration int64 `json:"exp,omitempty"`
+ IssuedAt int64 `json:"iat,omitempty"`
+ NotBefore int64 `json:"nbf,omitempty"`
+ AuthTime int64 `json:"auth_time,omitempty"`
+ }{
+ Alias: (*Alias)(t),
}
- gu.MapMerge(i.Claims, t.Claims)
-}
-
-func (t *IDTokenClaims) GetUserInfo() *UserInfo {
- return &UserInfo{
- Subject: t.Subject,
- UserInfoProfile: t.UserInfoProfile,
- UserInfoEmail: t.UserInfoEmail,
- UserInfoPhone: t.UserInfoPhone,
- Address: t.Address,
- Claims: gu.MapCopy(t.Claims),
+ if !time.Time(t.Expiration).IsZero() {
+ a.Expiration = time.Time(t.Expiration).Unix()
}
-}
-
-func NewIDTokenClaims(issuer, subject string, audience []string, expiration, authTime time.Time, nonce string, acr string, amr []string, clientID string, skew time.Duration) *IDTokenClaims {
- audience = AppendClientIDToAudience(clientID, audience)
- return &IDTokenClaims{
- TokenClaims: TokenClaims{
- Issuer: issuer,
- Subject: subject,
- Audience: audience,
- Expiration: FromTime(expiration),
- IssuedAt: FromTime(time.Now().Add(-skew)),
- AuthTime: FromTime(authTime.Add(-skew)),
- Nonce: nonce,
- AuthenticationContextClassReference: acr,
- AuthenticationMethodsReferences: amr,
- AuthorizedParty: clientID,
- ClientID: clientID,
- },
+ if !time.Time(t.IssuedAt).IsZero() {
+ a.IssuedAt = time.Time(t.IssuedAt).Unix()
}
+ if !time.Time(t.NotBefore).IsZero() {
+ a.NotBefore = time.Time(t.NotBefore).Unix()
+ }
+ if !time.Time(t.AuthTime).IsZero() {
+ a.AuthTime = time.Time(t.AuthTime).Unix()
+ }
+ b, err := json.Marshal(a)
+ if err != nil {
+ return nil, err
+ }
+
+ if t.UserInfo == nil {
+ return b, nil
+ }
+ info, err := json.Marshal(t.UserInfo)
+ if err != nil {
+ return nil, err
+ }
+ return http.ConcatenateJSON(b, info)
}
-type itcAlias IDTokenClaims
+func (t *idTokenClaims) UnmarshalJSON(data []byte) error {
+ type Alias idTokenClaims
+ if err := json.Unmarshal(data, (*Alias)(t)); err != nil {
+ return err
+ }
+ userinfo := new(userinfo)
+ if err := json.Unmarshal(data, userinfo); err != nil {
+ return err
+ }
+ t.UserInfo = userinfo
-func (i *IDTokenClaims) MarshalJSON() ([]byte, error) {
- return mergeAndMarshalClaims((*itcAlias)(i), i.Claims)
-}
-
-func (i *IDTokenClaims) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*itcAlias)(i), &i.Claims)
-}
-
-// ActorClaims provides the `act` claims used for impersonation or delegation Token Exchange.
-//
-// An actor can be nested in case an obtained token is used as actor token to obtain impersonation or delegation.
-// This allows creating a chain of actors.
-// See [RFC 8693, section 4.1](https://www.rfc-editor.org/rfc/rfc8693#name-act-actor-claim).
-type ActorClaims struct {
- Actor *ActorClaims `json:"act,omitempty"`
- Issuer string `json:"iss,omitempty"`
- Subject string `json:"sub,omitempty"`
- Claims map[string]any `json:"-"`
-}
-
-type acAlias ActorClaims
-
-func (c *ActorClaims) MarshalJSON() ([]byte, error) {
- return mergeAndMarshalClaims((*acAlias)(c), c.Claims)
-}
-
-func (c *ActorClaims) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*acAlias)(c), &c.Claims)
+ return nil
}
type AccessTokenResponse struct {
- AccessToken string `json:"access_token,omitempty" schema:"access_token,omitempty"`
- TokenType string `json:"token_type,omitempty" schema:"token_type,omitempty"`
- RefreshToken string `json:"refresh_token,omitempty" schema:"refresh_token,omitempty"`
- ExpiresIn uint64 `json:"expires_in,omitempty" schema:"expires_in,omitempty"`
- IDToken string `json:"id_token,omitempty" schema:"id_token,omitempty"`
- State string `json:"state,omitempty" schema:"state,omitempty"`
- Scope SpaceDelimitedArray `json:"scope,omitempty" schema:"scope,omitempty"`
+ AccessToken string `json:"access_token,omitempty" schema:"access_token,omitempty"`
+ TokenType string `json:"token_type,omitempty" schema:"token_type,omitempty"`
+ RefreshToken string `json:"refresh_token,omitempty" schema:"refresh_token,omitempty"`
+ ExpiresIn uint64 `json:"expires_in,omitempty" schema:"expires_in,omitempty"`
+ IDToken string `json:"id_token,omitempty" schema:"id_token,omitempty"`
+ State string `json:"state,omitempty" schema:"state,omitempty"`
}
-type JWTProfileAssertionClaims struct {
+type JWTProfileAssertionClaims interface {
+ GetKeyID() string
+ GetPrivateKey() []byte
+ GetIssuer() string
+ GetSubject() string
+ GetAudience() []string
+ GetExpiration() time.Time
+ GetIssuedAt() time.Time
+ SetCustomClaim(key string, value interface{})
+ GetCustomClaim(key string) interface{}
+}
+
+type jwtProfileAssertion struct {
PrivateKeyID string `json:"-"`
PrivateKey []byte `json:"-"`
Issuer string `json:"iss"`
@@ -248,21 +420,91 @@ type JWTProfileAssertionClaims struct {
Expiration Time `json:"exp"`
IssuedAt Time `json:"iat"`
- Claims map[string]any `json:"-"`
+ customClaims map[string]interface{}
}
-type jpaAlias JWTProfileAssertionClaims
+func (j *jwtProfileAssertion) MarshalJSON() ([]byte, error) {
+ type Alias jwtProfileAssertion
+ a := (*Alias)(j)
-func (j *JWTProfileAssertionClaims) MarshalJSON() ([]byte, error) {
- return mergeAndMarshalClaims((*jpaAlias)(j), j.Claims)
+ b, err := json.Marshal(a)
+ if err != nil {
+ return nil, err
+ }
+
+ if len(j.customClaims) == 0 {
+ return b, nil
+ }
+
+ err = json.Unmarshal(b, &j.customClaims)
+ if err != nil {
+ return nil, fmt.Errorf("jws: invalid map of custom claims %v", j.customClaims)
+ }
+
+ return json.Marshal(j.customClaims)
}
-func (j *JWTProfileAssertionClaims) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*jpaAlias)(j), &j.Claims)
+func (j *jwtProfileAssertion) UnmarshalJSON(data []byte) error {
+ type Alias jwtProfileAssertion
+ a := (*Alias)(j)
+
+ err := json.Unmarshal(data, a)
+ if err != nil {
+ return err
+ }
+
+ err = json.Unmarshal(data, &j.customClaims)
+ if err != nil {
+ return err
+ }
+
+ return nil
}
-func NewJWTProfileAssertionFromKeyJSON(filename string, audience []string, opts ...AssertionOption) (*JWTProfileAssertionClaims, error) {
- data, err := os.ReadFile(filename)
+func (j *jwtProfileAssertion) GetKeyID() string {
+ return j.PrivateKeyID
+}
+
+func (j *jwtProfileAssertion) GetPrivateKey() []byte {
+ return j.PrivateKey
+}
+
+func (j *jwtProfileAssertion) SetCustomClaim(key string, value interface{}) {
+ if j.customClaims == nil {
+ j.customClaims = make(map[string]interface{})
+ }
+ j.customClaims[key] = value
+}
+
+func (j *jwtProfileAssertion) GetCustomClaim(key string) interface{} {
+ if j.customClaims == nil {
+ return nil
+ }
+ return j.customClaims[key]
+}
+
+func (j *jwtProfileAssertion) GetIssuer() string {
+ return j.Issuer
+}
+
+func (j *jwtProfileAssertion) GetSubject() string {
+ return j.Subject
+}
+
+func (j *jwtProfileAssertion) GetAudience() []string {
+ return j.Audience
+}
+
+func (j *jwtProfileAssertion) GetExpiration() time.Time {
+ return time.Time(j.Expiration)
+}
+
+func (j *jwtProfileAssertion) GetIssuedAt() time.Time {
+ return time.Time(j.IssuedAt)
+}
+
+func NewJWTProfileAssertionFromKeyJSON(filename string, audience []string, opts ...AssertionOption) (JWTProfileAssertionClaims, error) {
+ data, err := ioutil.ReadFile(filename)
if err != nil {
return nil, err
}
@@ -282,19 +524,19 @@ func NewJWTProfileAssertionStringFromFileData(data []byte, audience []string, op
return GenerateJWTProfileToken(NewJWTProfileAssertion(keyData.UserID, keyData.KeyID, audience, []byte(keyData.Key), opts...))
}
-func JWTProfileDelegatedSubject(sub string) func(*JWTProfileAssertionClaims) {
- return func(j *JWTProfileAssertionClaims) {
+func JWTProfileDelegatedSubject(sub string) func(*jwtProfileAssertion) {
+ return func(j *jwtProfileAssertion) {
j.Subject = sub
}
}
-func JWTProfileCustomClaim(key string, value any) func(*JWTProfileAssertionClaims) {
- return func(j *JWTProfileAssertionClaims) {
- j.Claims[key] = value
+func JWTProfileCustomClaim(key string, value interface{}) func(*jwtProfileAssertion) {
+ return func(j *jwtProfileAssertion) {
+ j.customClaims[key] = value
}
}
-func NewJWTProfileAssertionFromFileData(data []byte, audience []string, opts ...AssertionOption) (*JWTProfileAssertionClaims, error) {
+func NewJWTProfileAssertionFromFileData(data []byte, audience []string, opts ...AssertionOption) (JWTProfileAssertionClaims, error) {
keyData := new(struct {
KeyID string `json:"keyId"`
Key string `json:"key"`
@@ -307,18 +549,18 @@ func NewJWTProfileAssertionFromFileData(data []byte, audience []string, opts ...
return NewJWTProfileAssertion(keyData.UserID, keyData.KeyID, audience, []byte(keyData.Key), opts...), nil
}
-type AssertionOption func(*JWTProfileAssertionClaims)
+type AssertionOption func(*jwtProfileAssertion)
-func NewJWTProfileAssertion(userID, keyID string, audience []string, key []byte, opts ...AssertionOption) *JWTProfileAssertionClaims {
- j := &JWTProfileAssertionClaims{
+func NewJWTProfileAssertion(userID, keyID string, audience []string, key []byte, opts ...AssertionOption) JWTProfileAssertionClaims {
+ j := &jwtProfileAssertion{
PrivateKey: key,
PrivateKeyID: keyID,
Issuer: userID,
Subject: userID,
- IssuedAt: FromTime(time.Now().UTC()),
- Expiration: FromTime(time.Now().Add(1 * time.Hour).UTC()),
+ IssuedAt: Time(time.Now().UTC()),
+ Expiration: Time(time.Now().Add(1 * time.Hour).UTC()),
Audience: audience,
- Claims: make(map[string]any),
+ customClaims: make(map[string]interface{}),
}
for _, opt := range opts {
@@ -346,14 +588,14 @@ func AppendClientIDToAudience(clientID string, audience []string) []string {
return append(audience, clientID)
}
-func GenerateJWTProfileToken(assertion *JWTProfileAssertionClaims) (string, error) {
- privateKey, algorithm, err := crypto.BytesToPrivateKey(assertion.PrivateKey)
+func GenerateJWTProfileToken(assertion JWTProfileAssertionClaims) (string, error) {
+ privateKey, err := crypto.BytesToPrivateKey(assertion.GetPrivateKey())
if err != nil {
return "", err
}
key := jose.SigningKey{
- Algorithm: algorithm,
- Key: &jose.JSONWebKey{Key: privateKey, KeyID: assertion.PrivateKeyID},
+ Algorithm: jose.RS256,
+ Key: &jose.JSONWebKey{Key: privateKey, KeyID: assertion.GetKeyID()},
}
signer, err := jose.NewSigner(key, &jose.SignerOptions{})
if err != nil {
@@ -370,53 +612,3 @@ func GenerateJWTProfileToken(assertion *JWTProfileAssertionClaims) (string, erro
}
return signedAssertion.CompactSerialize()
}
-
-type TokenExchangeResponse struct {
- AccessToken string `json:"access_token"` // Can be access token or ID token
- IssuedTokenType TokenType `json:"issued_token_type"`
- TokenType string `json:"token_type"`
- ExpiresIn uint64 `json:"expires_in,omitempty"`
- Scopes SpaceDelimitedArray `json:"scope,omitempty"`
- RefreshToken string `json:"refresh_token,omitempty"`
-
- // IDToken field allows returning an additional ID token
- // if the requested_token_type was Access Token and scope contained openid.
- IDToken string `json:"id_token,omitempty"`
-}
-
-type LogoutTokenClaims struct {
- Issuer string `json:"iss,omitempty"`
- Subject string `json:"sub,omitempty"`
- Audience Audience `json:"aud,omitempty"`
- IssuedAt Time `json:"iat,omitempty"`
- Expiration Time `json:"exp,omitempty"`
- JWTID string `json:"jti,omitempty"`
- Events map[string]any `json:"events,omitempty"`
- SessionID string `json:"sid,omitempty"`
- Claims map[string]any `json:"-"`
-}
-
-type ltcAlias LogoutTokenClaims
-
-func (i *LogoutTokenClaims) MarshalJSON() ([]byte, error) {
- return mergeAndMarshalClaims((*ltcAlias)(i), i.Claims)
-}
-
-func (i *LogoutTokenClaims) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*ltcAlias)(i), &i.Claims)
-}
-
-func NewLogoutTokenClaims(issuer, subject string, audience Audience, expiration time.Time, jwtID, sessionID string, skew time.Duration) *LogoutTokenClaims {
- return &LogoutTokenClaims{
- Issuer: issuer,
- Subject: subject,
- Audience: audience,
- IssuedAt: FromTime(time.Now().Add(-skew)),
- Expiration: FromTime(expiration),
- JWTID: jwtID,
- Events: map[string]any{
- "http://schemas.openid.net/event/backchannel-logout": struct{}{},
- },
- SessionID: sessionID,
- }
-}
diff --git a/pkg/oidc/token_request.go b/pkg/oidc/token_request.go
index dadb205..ec11057 100644
--- a/pkg/oidc/token_request.go
+++ b/pkg/oidc/token_request.go
@@ -3,10 +3,9 @@ package oidc
import (
"encoding/json"
"fmt"
- "slices"
"time"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
)
const (
@@ -28,9 +27,6 @@ const (
// GrantTypeImplicit defines the grant type `implicit` used for implicit flows that skip the generation and exchange of an Authorization Code
GrantTypeImplicit GrantType = "implicit"
- // GrantTypeDeviceCode
- GrantTypeDeviceCode GrantType = "urn:ietf:params:oauth:grant-type:device_code"
-
// ClientAssertionTypeJWTAssertion defines the client_assertion_type `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`
// used for the OAuth JWT Profile Client Authentication
ClientAssertionTypeJWTAssertion = "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"
@@ -39,28 +35,11 @@ const (
var AllGrantTypes = []GrantType{
GrantTypeCode, GrantTypeRefreshToken, GrantTypeClientCredentials,
GrantTypeBearer, GrantTypeTokenExchange, GrantTypeImplicit,
- GrantTypeDeviceCode, ClientAssertionTypeJWTAssertion,
+ ClientAssertionTypeJWTAssertion,
}
type GrantType string
-const (
- AccessTokenType TokenType = "urn:ietf:params:oauth:token-type:access_token"
- RefreshTokenType TokenType = "urn:ietf:params:oauth:token-type:refresh_token"
- IDTokenType TokenType = "urn:ietf:params:oauth:token-type:id_token"
- JWTTokenType TokenType = "urn:ietf:params:oauth:token-type:jwt"
-)
-
-var AllTokenTypes = []TokenType{
- AccessTokenType, RefreshTokenType, IDTokenType, JWTTokenType,
-}
-
-type TokenType string
-
-func (t TokenType) IsSupported() bool {
- return slices.Contains(AllTokenTypes, t)
-}
-
type TokenRequest interface {
// GrantType GrantType `schema:"grant_type"`
GrantType() GrantType
@@ -72,10 +51,10 @@ type AccessTokenRequest struct {
Code string `schema:"code"`
RedirectURI string `schema:"redirect_uri"`
ClientID string `schema:"client_id"`
- ClientSecret string `schema:"client_secret,omitempty"`
- CodeVerifier string `schema:"code_verifier,omitempty"`
- ClientAssertion string `schema:"client_assertion,omitempty"`
- ClientAssertionType string `schema:"client_assertion_type,omitempty"`
+ ClientSecret string `schema:"client_secret"`
+ CodeVerifier string `schema:"code_verifier"`
+ ClientAssertion string `schema:"client_assertion"`
+ ClientAssertionType string `schema:"client_assertion_type"`
}
func (a *AccessTokenRequest) GrantType() GrantType {
@@ -125,7 +104,7 @@ type JWTTokenRequest struct {
IssuedAt Time `json:"iat"`
ExpiresAt Time `json:"exp"`
- private map[string]any
+ private map[string]interface{}
}
func (j *JWTTokenRequest) MarshalJSON() ([]byte, error) {
@@ -166,7 +145,7 @@ func (j *JWTTokenRequest) UnmarshalJSON(data []byte) error {
return nil
}
-func (j *JWTTokenRequest) GetCustomClaim(key string) any {
+func (j *JWTTokenRequest) GetCustomClaim(key string) interface{} {
return j.private[key]
}
@@ -182,12 +161,12 @@ func (j *JWTTokenRequest) GetAudience() []string {
// GetExpiration implements the Claims interface
func (j *JWTTokenRequest) GetExpiration() time.Time {
- return j.ExpiresAt.AsTime()
+ return time.Time(j.ExpiresAt)
}
// GetIssuedAt implements the Claims interface
func (j *JWTTokenRequest) GetIssuedAt() time.Time {
- return j.IssuedAt.AsTime()
+ return time.Time(j.IssuedAt)
}
// GetNonce implements the Claims interface
@@ -224,22 +203,19 @@ func (j *JWTTokenRequest) GetScopes() []string {
}
type TokenExchangeRequest struct {
- GrantType GrantType `schema:"grant_type"`
- SubjectToken string `schema:"subject_token"`
- SubjectTokenType TokenType `schema:"subject_token_type"`
- ActorToken string `schema:"actor_token"`
- ActorTokenType TokenType `schema:"actor_token_type"`
- Resource []string `schema:"resource"`
- Audience Audience `schema:"audience"`
- Scopes SpaceDelimitedArray `schema:"scope"`
- RequestedTokenType TokenType `schema:"requested_token_type"`
+ subjectToken string `schema:"subject_token"`
+ subjectTokenType string `schema:"subject_token_type"`
+ actorToken string `schema:"actor_token"`
+ actorTokenType string `schema:"actor_token_type"`
+ resource []string `schema:"resource"`
+ audience Audience `schema:"audience"`
+ Scope SpaceDelimitedArray `schema:"scope"`
+ requestedTokenType string `schema:"requested_token_type"`
}
type ClientCredentialsRequest struct {
- GrantType GrantType `schema:"grant_type,omitempty"`
- Scope SpaceDelimitedArray `schema:"scope"`
- ClientID string `schema:"client_id"`
- ClientSecret string `schema:"client_secret"`
- ClientAssertion string `schema:"client_assertion"`
- ClientAssertionType string `schema:"client_assertion_type"`
+ GrantType GrantType `schema:"grant_type"`
+ Scope SpaceDelimitedArray `schema:"scope"`
+ ClientID string `schema:"client_id"`
+ ClientSecret string `schema:"client_secret"`
}
diff --git a/pkg/oidc/token_test.go b/pkg/oidc/token_test.go
deleted file mode 100644
index 621cdbc..0000000
--- a/pkg/oidc/token_test.go
+++ /dev/null
@@ -1,280 +0,0 @@
-package oidc
-
-import (
- "testing"
- "time"
-
- jose "github.com/go-jose/go-jose/v4"
- "github.com/stretchr/testify/assert"
- "golang.org/x/text/language"
-)
-
-var (
- tokenClaimsData = TokenClaims{
- Issuer: "zitadel",
- Subject: "hello@me.com",
- Audience: Audience{"foo", "bar"},
- Expiration: 12345,
- IssuedAt: 12000,
- JWTID: "900",
- AuthorizedParty: "just@me.com",
- Nonce: "6969",
- AuthTime: 12000,
- NotBefore: 12000,
- AuthenticationContextClassReference: "something",
- AuthenticationMethodsReferences: []string{"some", "methods"},
- ClientID: "777",
- SignatureAlg: jose.ES256,
- }
- accessTokenData = &AccessTokenClaims{
- TokenClaims: tokenClaimsData,
- Scopes: []string{"email", "phone"},
- Claims: map[string]any{
- "foo": "bar",
- },
- }
- idTokenData = &IDTokenClaims{
- TokenClaims: tokenClaimsData,
- NotBefore: 12000,
- AccessTokenHash: "acthashhash",
- CodeHash: "hashhash",
- SessionID: "666",
- UserInfoProfile: userInfoData.UserInfoProfile,
- UserInfoEmail: userInfoData.UserInfoEmail,
- UserInfoPhone: userInfoData.UserInfoPhone,
- Address: userInfoData.Address,
- Claims: map[string]any{
- "foo": "bar",
- },
- }
- introspectionResponseData = &IntrospectionResponse{
- Active: true,
- Scope: SpaceDelimitedArray{"email", "phone"},
- ClientID: "777",
- TokenType: "idtoken",
- Expiration: 12345,
- IssuedAt: 12000,
- NotBefore: 12000,
- Subject: "hello@me.com",
- Audience: Audience{"foo", "bar"},
- Issuer: "zitadel",
- JWTID: "900",
- Username: "muhlemmer",
- UserInfoProfile: userInfoData.UserInfoProfile,
- UserInfoEmail: userInfoData.UserInfoEmail,
- UserInfoPhone: userInfoData.UserInfoPhone,
- Address: userInfoData.Address,
- Claims: map[string]any{
- "foo": "bar",
- },
- }
- userInfoData = &UserInfo{
- Subject: "hello@me.com",
- UserInfoProfile: UserInfoProfile{
- Name: "Tim MÃļhlmann",
- GivenName: "Tim",
- FamilyName: "MÃļhlmann",
- MiddleName: "Danger",
- Nickname: "muhlemmer",
- Profile: "https://github.com/muhlemmer",
- Picture: "https://avatars.githubusercontent.com/u/5411563?v=4",
- Website: "https://zitadel.com",
- Gender: "male",
- Birthdate: "1st of April",
- Zoneinfo: "Europe/Amsterdam",
- Locale: NewLocale(language.Dutch),
- UpdatedAt: 1,
- PreferredUsername: "muhlemmer",
- },
- UserInfoEmail: UserInfoEmail{
- Email: "tim@zitadel.com",
- EmailVerified: true,
- },
- UserInfoPhone: UserInfoPhone{
- PhoneNumber: "+1234567890",
- PhoneNumberVerified: true,
- },
- Address: &UserInfoAddress{
- Formatted: "Sesame street 666\n666-666, Smallvile\nMoon",
- StreetAddress: "Sesame street 666",
- Locality: "Smallvile",
- Region: "Outer space",
- PostalCode: "666-666",
- Country: "Moon",
- },
- Claims: map[string]any{
- "foo": "bar",
- },
- }
- jwtProfileAssertionData = &JWTProfileAssertionClaims{
- PrivateKeyID: "8888",
- PrivateKey: []byte("qwerty"),
- Issuer: "zitadel",
- Subject: "hello@me.com",
- Audience: Audience{"foo", "bar"},
- Expiration: 12345,
- IssuedAt: 12000,
- Claims: map[string]any{
- "foo": "bar",
- },
- }
-)
-
-func TestTokenClaims(t *testing.T) {
- claims := tokenClaimsData
-
- assert.Equal(t, claims.Issuer, tokenClaimsData.GetIssuer())
- assert.Equal(t, claims.Subject, tokenClaimsData.GetSubject())
- assert.Equal(t, []string(claims.Audience), tokenClaimsData.GetAudience())
- assert.Equal(t, claims.Expiration.AsTime(), tokenClaimsData.GetExpiration())
- assert.Equal(t, claims.IssuedAt.AsTime(), tokenClaimsData.GetIssuedAt())
- assert.Equal(t, claims.Nonce, tokenClaimsData.GetNonce())
- assert.Equal(t, claims.AuthTime.AsTime(), tokenClaimsData.GetAuthTime())
- assert.Equal(t, claims.AuthorizedParty, tokenClaimsData.GetAuthorizedParty())
- assert.Equal(t, claims.SignatureAlg, tokenClaimsData.GetSignatureAlgorithm())
- assert.Equal(t, claims.AuthenticationContextClassReference, tokenClaimsData.GetAuthenticationContextClassReference())
-
- claims.SetSignatureAlgorithm(jose.ES384)
- assert.Equal(t, jose.ES384, claims.SignatureAlg)
-}
-
-func TestNewAccessTokenClaims(t *testing.T) {
- want := &AccessTokenClaims{
- TokenClaims: TokenClaims{
- Issuer: "zitadel",
- Subject: "hello@me.com",
- Audience: Audience{"foo"},
- Expiration: 12345,
- ClientID: "foo",
- JWTID: "900",
- },
- }
-
- got := NewAccessTokenClaims(
- want.Issuer, want.Subject, nil,
- want.Expiration.AsTime(), want.JWTID, "foo", time.Second,
- )
-
- // test if the dynamic timestamps are around now,
- // allowing for a delta of 1, just in case we flip on
- // either side of a second boundry.
- nowMinusSkew := NowTime() - 1
- assert.InDelta(t, int64(nowMinusSkew), int64(got.IssuedAt), 1)
- assert.InDelta(t, int64(nowMinusSkew), int64(got.NotBefore), 1)
-
- // Make equal not fail on dynamic timestamp
- got.IssuedAt = 0
- got.NotBefore = 0
-
- assert.Equal(t, want, got)
-}
-
-func TestIDTokenClaims_GetAccessTokenHash(t *testing.T) {
- assert.Equal(t, idTokenData.AccessTokenHash, idTokenData.GetAccessTokenHash())
-}
-
-func TestIDTokenClaims_SetUserInfo(t *testing.T) {
- want := IDTokenClaims{
- TokenClaims: TokenClaims{
- Subject: userInfoData.Subject,
- },
- UserInfoProfile: userInfoData.UserInfoProfile,
- UserInfoEmail: userInfoData.UserInfoEmail,
- UserInfoPhone: userInfoData.UserInfoPhone,
- Address: userInfoData.Address,
- Claims: map[string]any{
- "foo": "bar",
- },
- }
-
- var got IDTokenClaims
- got.SetUserInfo(userInfoData)
-
- assert.Equal(t, want, got)
-}
-
-func TestNewIDTokenClaims(t *testing.T) {
- want := &IDTokenClaims{
- TokenClaims: TokenClaims{
- Issuer: "zitadel",
- Subject: "hello@me.com",
- Audience: Audience{"foo", "just@me.com"},
- Expiration: 12345,
- AuthTime: 12000,
- Nonce: "6969",
- AuthenticationContextClassReference: "something",
- AuthenticationMethodsReferences: []string{"some", "methods"},
- AuthorizedParty: "just@me.com",
- ClientID: "just@me.com",
- },
- }
-
- got := NewIDTokenClaims(
- want.Issuer, want.Subject, want.Audience,
- want.Expiration.AsTime(),
- want.AuthTime.AsTime().Add(time.Second),
- want.Nonce, want.AuthenticationContextClassReference,
- want.AuthenticationMethodsReferences, want.AuthorizedParty,
- time.Second,
- )
-
- // test if the dynamic timestamp is around now,
- // allowing for a delta of 1, just in case we flip on
- // either side of a second boundry.
- nowMinusSkew := NowTime() - 1
- assert.InDelta(t, int64(nowMinusSkew), int64(got.IssuedAt), 1)
-
- // Make equal not fail on dynamic timestamp
- got.IssuedAt = 0
-
- assert.Equal(t, want, got)
-}
-
-func TestIDTokenClaims_GetUserInfo(t *testing.T) {
- want := &UserInfo{
- Subject: idTokenData.Subject,
- UserInfoProfile: idTokenData.UserInfoProfile,
- UserInfoEmail: idTokenData.UserInfoEmail,
- UserInfoPhone: idTokenData.UserInfoPhone,
- Address: idTokenData.Address,
- Claims: idTokenData.Claims,
- }
- got := idTokenData.GetUserInfo()
- assert.Equal(t, want, got)
-}
-
-func TestNewLogoutTokenClaims(t *testing.T) {
- want := &LogoutTokenClaims{
- Issuer: "zitadel",
- Subject: "hello@me.com",
- Audience: Audience{"foo", "just@me.com"},
- Expiration: 12345,
- JWTID: "jwtID",
- Events: map[string]any{
- "http://schemas.openid.net/event/backchannel-logout": struct{}{},
- },
- SessionID: "sessionID",
- Claims: nil,
- }
-
- got := NewLogoutTokenClaims(
- want.Issuer,
- want.Subject,
- want.Audience,
- want.Expiration.AsTime(),
- want.JWTID,
- want.SessionID,
- 1*time.Second,
- )
-
- // test if the dynamic timestamp is around now,
- // allowing for a delta of 1, just in case we flip on
- // either side of a second boundry.
- nowMinusSkew := NowTime() - 1
- assert.InDelta(t, int64(nowMinusSkew), int64(got.IssuedAt), 1)
-
- // Make equal not fail on dynamic timestamp
- got.IssuedAt = 0
-
- assert.Equal(t, want, got)
-}
diff --git a/pkg/oidc/types.go b/pkg/oidc/types.go
index 5d063b1..4ceef6f 100644
--- a/pkg/oidc/types.go
+++ b/pkg/oidc/types.go
@@ -3,28 +3,24 @@ package oidc
import (
"database/sql/driver"
"encoding/json"
- "errors"
"fmt"
- "reflect"
"strings"
"time"
- jose "github.com/go-jose/go-jose/v4"
- "github.com/muhlemmer/gu"
- "github.com/zitadel/schema"
"golang.org/x/text/language"
+ "gopkg.in/square/go-jose.v2"
)
type Audience []string
func (a *Audience) UnmarshalJSON(text []byte) error {
- var i any
+ var i interface{}
err := json.Unmarshal(text, &i)
if err != nil {
return err
}
switch aud := i.(type) {
- case []any:
+ case []interface{}:
*a = make([]string, len(aud))
for i, audience := range aud {
(*a)[i] = audience.(string)
@@ -35,17 +31,6 @@ func (a *Audience) UnmarshalJSON(text []byte) error {
return nil
}
-func (a *Audience) MarshalJSON() ([]byte, error) {
- len := len(*a)
- if len > 1 {
- return json.Marshal(*a)
- } else if len == 1 {
- return json.Marshal((*a)[0])
- }
-
- return nil, errors.New("aud is empty")
-}
-
type Display string
func (d *Display) UnmarshalText(text []byte) error {
@@ -59,119 +44,16 @@ func (d *Display) UnmarshalText(text []byte) error {
type Gender string
-type Locale struct {
- tag language.Tag
-}
-
-func NewLocale(tag language.Tag) *Locale {
- return &Locale{tag: tag}
-}
-
-func (l *Locale) Tag() language.Tag {
- if l == nil {
- return language.Und
- }
-
- return l.tag
-}
-
-func (l *Locale) String() string {
- return l.Tag().String()
-}
-
-func (l *Locale) MarshalJSON() ([]byte, error) {
- tag := l.Tag()
- if tag.IsRoot() {
- return []byte("null"), nil
- }
-
- return json.Marshal(tag)
-}
-
-// UnmarshalJSON implements json.Unmarshaler.
-// When [language.ValueError] is encountered, the containing tag will be set
-// to an empty value (language "und") and no error will be returned.
-// This state can be checked with the `l.Tag().IsRoot()` method.
-func (l *Locale) UnmarshalJSON(data []byte) error {
- if len(data) == 0 || string(data) == "\"\"" {
- return nil
- }
- err := json.Unmarshal(data, &l.tag)
- if err == nil {
- return nil
- }
-
- // catch "well-formed but unknown" errors
- var target language.ValueError
- if errors.As(err, &target) {
- l.tag = language.Tag{}
- return nil
- }
- return err
-}
-
type Locales []language.Tag
-// ParseLocales parses a slice of strings into Locales.
-// If an entry causes a parse error or is undefined,
-// it is ignored and not set to Locales.
-func ParseLocales(locales []string) Locales {
- out := make(Locales, 0, len(locales))
+func (l *Locales) UnmarshalText(text []byte) error {
+ locales := strings.Split(string(text), " ")
for _, locale := range locales {
tag, err := language.Parse(locale)
if err == nil && !tag.IsRoot() {
- out = append(out, tag)
+ *l = append(*l, tag)
}
}
- return out
-}
-
-func (l Locales) String() string {
- tags := make([]string, len(l))
- for i, tag := range l {
- tags[i] = tag.String()
- }
- return strings.Join(tags, " ")
-}
-
-// UnmarshalText implements the [encoding.TextUnmarshaler] interface.
-// It decodes an unquoted space seperated string into Locales.
-// Undefined language tags in the input are ignored and ommited from
-// the resulting Locales.
-func (l *Locales) UnmarshalText(text []byte) error {
- *l = ParseLocales(
- strings.Split(string(text), " "),
- )
- return nil
-}
-
-// UnmarshalJSON implements the [json.Unmarshaler] interface.
-// It decodes a json array or a space seperated string into Locales.
-// Undefined language tags in the input are ignored and ommited from
-// the resulting Locales.
-func (l *Locales) UnmarshalJSON(data []byte) error {
- var dst any
- if err := json.Unmarshal(data, &dst); err != nil {
- return fmt.Errorf("oidc locales: %w", err)
- }
-
- // We catch the posibility of a space seperated string here,
- // because UnmarshalText might have been implicetely called
- // by the json library before we added UnmarshalJSON.
- switch v := dst.(type) {
- case nil:
- *l = nil
- case string:
- *l = ParseLocales(strings.Split(v, " "))
- case []any:
- locales, err := gu.AssertInterfaces[string](v)
- if err != nil {
- return fmt.Errorf("oidc locales: %w", err)
- }
- *l = ParseLocales(locales)
- default:
- return fmt.Errorf("oidc locales: unsupported type: %T", v)
- }
return nil
}
@@ -189,7 +71,7 @@ type ResponseType string
type ResponseMode string
-func (s SpaceDelimitedArray) String() string {
+func (s SpaceDelimitedArray) Encode() string {
return strings.Join(s, " ")
}
@@ -199,11 +81,11 @@ func (s *SpaceDelimitedArray) UnmarshalText(text []byte) error {
}
func (s SpaceDelimitedArray) MarshalText() ([]byte, error) {
- return []byte(s.String()), nil
+ return []byte(s.Encode()), nil
}
func (s SpaceDelimitedArray) MarshalJSON() ([]byte, error) {
- return json.Marshal((s).String())
+ return json.Marshal((s).Encode())
}
func (s *SpaceDelimitedArray) UnmarshalJSON(data []byte) error {
@@ -215,7 +97,7 @@ func (s *SpaceDelimitedArray) UnmarshalJSON(data []byte) error {
return nil
}
-func (s *SpaceDelimitedArray) Scan(src any) error {
+func (s *SpaceDelimitedArray) Scan(src interface{}) error {
if src == nil {
*s = nil
return nil
@@ -243,38 +125,7 @@ func (s SpaceDelimitedArray) Value() (driver.Value, error) {
return strings.Join(s, " "), nil
}
-// NewEncoder returns a schema Encoder with
-// a registered encoder for SpaceDelimitedArray.
-func NewEncoder() *schema.Encoder {
- e := schema.NewEncoder()
- e.RegisterEncoder(SpaceDelimitedArray{}, func(value reflect.Value) string {
- return value.Interface().(SpaceDelimitedArray).String()
- })
- e.RegisterEncoder(Locales{}, func(value reflect.Value) string {
- return value.Interface().(Locales).String()
- })
- return e
-}
-
-type Time int64
-
-func (ts Time) AsTime() time.Time {
- if ts == 0 {
- return time.Time{}
- }
- return time.Unix(int64(ts), 0)
-}
-
-func FromTime(tt time.Time) Time {
- if tt.IsZero() {
- return 0
- }
- return Time(tt.Unix())
-}
-
-func NowTime() Time {
- return FromTime(time.Now())
-}
+type Time time.Time
func (ts *Time) UnmarshalJSON(data []byte) error {
var v any
@@ -283,7 +134,7 @@ func (ts *Time) UnmarshalJSON(data []byte) error {
}
switch x := v.(type) {
case float64:
- *ts = Time(x)
+ *ts = Time(time.Unix(int64(x), 0))
case string:
// Compatibility with Auth0:
// https://github.com/zitadel/oidc/issues/292
@@ -291,15 +142,19 @@ func (ts *Time) UnmarshalJSON(data []byte) error {
if err != nil {
return fmt.Errorf("oidc.Time: %w", err)
}
- *ts = FromTime(tt)
+ *ts = Time(tt.Round(time.Second))
case nil:
- *ts = 0
+ *ts = Time{}
default:
return fmt.Errorf("oidc.Time: unable to parse type %T with value %v", x, x)
}
return nil
}
+func (t *Time) MarshalJSON() ([]byte, error) {
+ return json.Marshal(time.Time(*t).UTC().Unix())
+}
+
type RequestObject struct {
Issuer string `json:"iss"`
Audience Audience `json:"aud"`
@@ -310,4 +165,5 @@ func (r *RequestObject) GetIssuer() string {
return r.Issuer
}
-func (*RequestObject) SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm) {}
+func (r *RequestObject) SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm) {
+}
diff --git a/pkg/oidc/types_test.go b/pkg/oidc/types_test.go
index 53a9779..653840c 100644
--- a/pkg/oidc/types_test.go
+++ b/pkg/oidc/types_test.go
@@ -3,7 +3,6 @@ package oidc
import (
"bytes"
"encoding/json"
- "net/url"
"strconv"
"strings"
"testing"
@@ -11,7 +10,6 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
- "github.com/zitadel/schema"
"golang.org/x/text/language"
)
@@ -113,175 +111,6 @@ func TestDisplay_UnmarshalText(t *testing.T) {
}
}
-func TestLocale_Tag(t *testing.T) {
- tests := []struct {
- name string
- l *Locale
- want language.Tag
- }{
- {
- name: "nil",
- l: nil,
- want: language.Und,
- },
- {
- name: "Und",
- l: NewLocale(language.Und),
- want: language.Und,
- },
- {
- name: "language",
- l: NewLocale(language.Afrikaans),
- want: language.Afrikaans,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assert.Equal(t, tt.want, tt.l.Tag())
- })
- }
-}
-
-func TestLocale_String(t *testing.T) {
- tests := []struct {
- name string
- l *Locale
- want language.Tag
- }{
- {
- name: "nil",
- l: nil,
- want: language.Und,
- },
- {
- name: "Und",
- l: NewLocale(language.Und),
- want: language.Und,
- },
- {
- name: "language",
- l: NewLocale(language.Afrikaans),
- want: language.Afrikaans,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assert.Equal(t, tt.want.String(), tt.l.String())
- })
- }
-}
-
-func TestLocale_MarshalJSON(t *testing.T) {
- tests := []struct {
- name string
- l *Locale
- want string
- wantErr bool
- }{
- {
- name: "nil",
- l: nil,
- want: "null",
- },
- {
- name: "und",
- l: NewLocale(language.Und),
- want: "null",
- },
- {
- name: "language",
- l: NewLocale(language.Afrikaans),
- want: `"af"`,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got, err := json.Marshal(tt.l)
- if tt.wantErr {
- require.Error(t, err)
- } else {
- require.NoError(t, err)
- }
- assert.Equal(t, tt.want, string(got))
- })
- }
-}
-
-func TestLocale_UnmarshalJSON(t *testing.T) {
- type dst struct {
- Locale *Locale `json:"locale,omitempty"`
- }
- tests := []struct {
- name string
- input string
- want dst
- wantErr bool
- }{
- {
- name: "value not present",
- input: `{}`,
- wantErr: false,
- want: dst{
- Locale: nil,
- },
- },
- {
- name: "null",
- input: `{"locale": null}`,
- wantErr: false,
- want: dst{
- Locale: nil,
- },
- },
- {
- name: "empty, ignored",
- input: `{"locale": ""}`,
- wantErr: false,
- want: dst{
- Locale: &Locale{},
- },
- },
- {
- name: "afrikaans, ok",
- input: `{"locale": "af"}`,
- want: dst{
- Locale: NewLocale(language.Afrikaans),
- },
- },
- {
- name: "gb, ignored",
- input: `{"locale": "gb"}`,
- want: dst{
- Locale: &Locale{},
- },
- },
- {
- name: "bad form, error",
- input: `{"locale": "g!!!!!"}`,
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- var got dst
- err := json.Unmarshal([]byte(tt.input), &got)
- if tt.wantErr {
- require.Error(t, err)
- return
- }
- require.NoError(t, err)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestParseLocales(t *testing.T) {
- in := []string{language.Afrikaans.String(), language.Danish.String(), "foobar", language.Und.String()}
- want := Locales{language.Afrikaans, language.Danish}
- got := ParseLocales(in)
- assert.ElementsMatch(t, want, got)
-}
-
func TestLocales_UnmarshalText(t *testing.T) {
type args struct {
text []byte
@@ -339,80 +168,6 @@ func TestLocales_UnmarshalText(t *testing.T) {
}
}
-func TestLocales_UnmarshalJSON(t *testing.T) {
- in := []string{language.Afrikaans.String(), language.Danish.String(), "foobar", language.Und.String()}
- spaceSepStr := strconv.Quote(strings.Join(in, " "))
- jsonArray, err := json.Marshal(in)
- require.NoError(t, err)
-
- out := Locales{language.Afrikaans, language.Danish}
-
- type args struct {
- data []byte
- }
- tests := []struct {
- name string
- args args
- want Locales
- wantErr bool
- }{
- {
- name: "invalid JSON",
- args: args{
- data: []byte("~~~"),
- },
- wantErr: true,
- },
- {
- name: "null",
- args: args{
- data: []byte("null"),
- },
- want: nil,
- },
- {
- name: "space seperated string",
- args: args{
- data: []byte(spaceSepStr),
- },
- want: out,
- },
- {
- name: "json string array",
- args: args{
- data: jsonArray,
- },
- want: out,
- },
- {
- name: "json invalid array",
- args: args{
- data: []byte(`[1,2,3]`),
- },
- wantErr: true,
- },
- {
- name: "invalid type (float64)",
- args: args{
- data: []byte("22"),
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- var got Locales
- err := got.UnmarshalJSON([]byte(tt.args.data))
- if tt.wantErr {
- assert.Error(t, err)
- return
- }
- require.NoError(t, err)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
func TestScopes_UnmarshalText(t *testing.T) {
type args struct {
text []byte
@@ -583,73 +338,6 @@ func TestSpaceDelimitatedArray_ValuerNil(t *testing.T) {
}
}
-func TestNewEncoder(t *testing.T) {
- type request struct {
- Scopes SpaceDelimitedArray `schema:"scope"`
- }
- a := request{
- Scopes: SpaceDelimitedArray{"foo", "bar"},
- }
-
- values := make(url.Values)
- NewEncoder().Encode(a, values)
- assert.Equal(t, url.Values{"scope": []string{"foo bar"}}, values)
-
- var b request
- schema.NewDecoder().Decode(&b, values)
- assert.Equal(t, a, b)
-}
-
-func TestTime_AsTime(t *testing.T) {
- tests := []struct {
- name string
- ts Time
- want time.Time
- }{
- {
- name: "unset",
- ts: 0,
- want: time.Time{},
- },
- {
- name: "set",
- ts: 1,
- want: time.Unix(1, 0),
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := tt.ts.AsTime()
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestTime_FromTime(t *testing.T) {
- tests := []struct {
- name string
- tt time.Time
- want Time
- }{
- {
- name: "zero",
- tt: time.Time{},
- want: 0,
- },
- {
- name: "set",
- tt: time.Unix(1, 0),
- want: 1,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := FromTime(tt.tt)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
func TestTime_UnmarshalJSON(t *testing.T) {
type dst struct {
UpdatedAt Time `json:"updated_at"`
@@ -663,12 +351,12 @@ func TestTime_UnmarshalJSON(t *testing.T) {
{
name: "RFC3339", // https://github.com/zitadel/oidc/issues/292
json: `{"updated_at": "2021-05-11T21:13:25.566Z"}`,
- want: dst{UpdatedAt: 1620767605},
+ want: dst{UpdatedAt: Time(time.Unix(1620767606, 0))},
},
{
name: "int",
- json: `{"updated_at":1620767605}`,
- want: dst{UpdatedAt: 1620767605},
+ json: `{"updated_at":1620767606}`,
+ want: dst{UpdatedAt: Time(time.Unix(1620767606, 0))},
},
{
name: "time parse error",
@@ -694,7 +382,7 @@ func TestTime_UnmarshalJSON(t *testing.T) {
} else {
require.NoError(t, err)
}
- assert.Equal(t, tt.want, got)
+ assert.WithinDuration(t, time.Time(tt.want.UpdatedAt), time.Time(got.UpdatedAt), 0)
})
}
t.Run("syntax error", func(t *testing.T) {
diff --git a/pkg/oidc/userinfo.go b/pkg/oidc/userinfo.go
index ef8ebe4..c8e34d6 100644
--- a/pkg/oidc/userinfo.go
+++ b/pkg/oidc/userinfo.go
@@ -1,78 +1,320 @@
package oidc
-// UserInfo implements OpenID Connect Core 1.0, section 5.1.
-// https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.
-type UserInfo struct {
- Subject string `json:"sub,omitempty"`
+import (
+ "encoding/json"
+ "fmt"
+ "time"
+
+ "golang.org/x/text/language"
+)
+
+type UserInfo interface {
+ GetSubject() string
UserInfoProfile
UserInfoEmail
UserInfoPhone
- Address *UserInfoAddress `json:"address,omitempty"`
-
- Claims map[string]any `json:"-"`
+ GetAddress() UserInfoAddress
+ GetClaim(key string) interface{}
+ GetClaims() map[string]interface{}
}
-func (u *UserInfo) AppendClaims(k string, v any) {
- if u.Claims == nil {
- u.Claims = make(map[string]any)
- }
-
- u.Claims[k] = v
+type UserInfoProfile interface {
+ GetName() string
+ GetGivenName() string
+ GetFamilyName() string
+ GetMiddleName() string
+ GetNickname() string
+ GetProfile() string
+ GetPicture() string
+ GetWebsite() string
+ GetGender() Gender
+ GetBirthdate() string
+ GetZoneinfo() string
+ GetLocale() language.Tag
+ GetPreferredUsername() string
}
-// GetAddress is a safe getter that takes
-// care of a possible nil value.
-func (u *UserInfo) GetAddress() *UserInfoAddress {
+type UserInfoEmail interface {
+ GetEmail() string
+ IsEmailVerified() bool
+}
+
+type UserInfoPhone interface {
+ GetPhoneNumber() string
+ IsPhoneNumberVerified() bool
+}
+
+type UserInfoAddress interface {
+ GetFormatted() string
+ GetStreetAddress() string
+ GetLocality() string
+ GetRegion() string
+ GetPostalCode() string
+ GetCountry() string
+}
+
+type UserInfoSetter interface {
+ UserInfo
+ SetSubject(sub string)
+ UserInfoProfileSetter
+ SetEmail(email string, verified bool)
+ SetPhone(phone string, verified bool)
+ SetAddress(address UserInfoAddress)
+ AppendClaims(key string, values interface{})
+}
+
+type UserInfoProfileSetter interface {
+ SetName(name string)
+ SetGivenName(name string)
+ SetFamilyName(name string)
+ SetMiddleName(name string)
+ SetNickname(name string)
+ SetUpdatedAt(date time.Time)
+ SetProfile(profile string)
+ SetPicture(profile string)
+ SetWebsite(website string)
+ SetGender(gender Gender)
+ SetBirthdate(birthdate string)
+ SetZoneinfo(zoneInfo string)
+ SetLocale(locale language.Tag)
+ SetPreferredUsername(name string)
+}
+
+func NewUserInfo() UserInfoSetter {
+ return &userinfo{}
+}
+
+type userinfo struct {
+ Subject string `json:"sub,omitempty"`
+ userInfoProfile
+ userInfoEmail
+ userInfoPhone
+ Address UserInfoAddress `json:"address,omitempty"`
+
+ claims map[string]interface{}
+}
+
+func (u *userinfo) GetSubject() string {
+ return u.Subject
+}
+
+func (u *userinfo) GetName() string {
+ return u.Name
+}
+
+func (u *userinfo) GetGivenName() string {
+ return u.GivenName
+}
+
+func (u *userinfo) GetFamilyName() string {
+ return u.FamilyName
+}
+
+func (u *userinfo) GetMiddleName() string {
+ return u.MiddleName
+}
+
+func (u *userinfo) GetNickname() string {
+ return u.Nickname
+}
+
+func (u *userinfo) GetProfile() string {
+ return u.Profile
+}
+
+func (u *userinfo) GetPicture() string {
+ return u.Picture
+}
+
+func (u *userinfo) GetWebsite() string {
+ return u.Website
+}
+
+func (u *userinfo) GetGender() Gender {
+ return u.Gender
+}
+
+func (u *userinfo) GetBirthdate() string {
+ return u.Birthdate
+}
+
+func (u *userinfo) GetZoneinfo() string {
+ return u.Zoneinfo
+}
+
+func (u *userinfo) GetLocale() language.Tag {
+ return u.Locale
+}
+
+func (u *userinfo) GetPreferredUsername() string {
+ return u.PreferredUsername
+}
+
+func (u *userinfo) GetEmail() string {
+ return u.Email
+}
+
+func (u *userinfo) IsEmailVerified() bool {
+ return bool(u.EmailVerified)
+}
+
+func (u *userinfo) GetPhoneNumber() string {
+ return u.PhoneNumber
+}
+
+func (u *userinfo) IsPhoneNumberVerified() bool {
+ return u.PhoneNumberVerified
+}
+
+func (u *userinfo) GetAddress() UserInfoAddress {
if u.Address == nil {
- return new(UserInfoAddress)
+ return &userInfoAddress{}
}
return u.Address
}
-// GetSubject implements [rp.SubjectGetter]
-func (u *UserInfo) GetSubject() string {
- return u.Subject
+func (u *userinfo) GetClaim(key string) interface{} {
+ return u.claims[key]
}
-type uiAlias UserInfo
-
-func (u *UserInfo) MarshalJSON() ([]byte, error) {
- return mergeAndMarshalClaims((*uiAlias)(u), u.Claims)
+func (u *userinfo) GetClaims() map[string]interface{} {
+ return u.claims
}
-func (u *UserInfo) UnmarshalJSON(data []byte) error {
- return unmarshalJSONMulti(data, (*uiAlias)(u), &u.Claims)
+func (u *userinfo) SetSubject(sub string) {
+ u.Subject = sub
}
-type UserInfoProfile struct {
- Name string `json:"name,omitempty"`
- GivenName string `json:"given_name,omitempty"`
- FamilyName string `json:"family_name,omitempty"`
- MiddleName string `json:"middle_name,omitempty"`
- Nickname string `json:"nickname,omitempty"`
- Profile string `json:"profile,omitempty"`
- Picture string `json:"picture,omitempty"`
- Website string `json:"website,omitempty"`
- Gender Gender `json:"gender,omitempty"`
- Birthdate string `json:"birthdate,omitempty"`
- Zoneinfo string `json:"zoneinfo,omitempty"`
- Locale *Locale `json:"locale,omitempty"`
- UpdatedAt Time `json:"updated_at,omitempty"`
- PreferredUsername string `json:"preferred_username,omitempty"`
+func (u *userinfo) SetName(name string) {
+ u.Name = name
}
-type UserInfoEmail struct {
+func (u *userinfo) SetGivenName(name string) {
+ u.GivenName = name
+}
+
+func (u *userinfo) SetFamilyName(name string) {
+ u.FamilyName = name
+}
+
+func (u *userinfo) SetMiddleName(name string) {
+ u.MiddleName = name
+}
+
+func (u *userinfo) SetNickname(name string) {
+ u.Nickname = name
+}
+
+func (u *userinfo) SetUpdatedAt(date time.Time) {
+ u.UpdatedAt = Time(date)
+}
+
+func (u *userinfo) SetProfile(profile string) {
+ u.Profile = profile
+}
+
+func (u *userinfo) SetPicture(picture string) {
+ u.Picture = picture
+}
+
+func (u *userinfo) SetWebsite(website string) {
+ u.Website = website
+}
+
+func (u *userinfo) SetGender(gender Gender) {
+ u.Gender = gender
+}
+
+func (u *userinfo) SetBirthdate(birthdate string) {
+ u.Birthdate = birthdate
+}
+
+func (u *userinfo) SetZoneinfo(zoneInfo string) {
+ u.Zoneinfo = zoneInfo
+}
+
+func (u *userinfo) SetLocale(locale language.Tag) {
+ u.Locale = locale
+}
+
+func (u *userinfo) SetPreferredUsername(name string) {
+ u.PreferredUsername = name
+}
+
+func (u *userinfo) SetEmail(email string, verified bool) {
+ u.Email = email
+ u.EmailVerified = boolString(verified)
+}
+
+func (u *userinfo) SetPhone(phone string, verified bool) {
+ u.PhoneNumber = phone
+ u.PhoneNumberVerified = verified
+}
+
+func (u *userinfo) SetAddress(address UserInfoAddress) {
+ u.Address = address
+}
+
+func (u *userinfo) AppendClaims(key string, value interface{}) {
+ if u.claims == nil {
+ u.claims = make(map[string]interface{})
+ }
+ u.claims[key] = value
+}
+
+func (u *userInfoAddress) GetFormatted() string {
+ return u.Formatted
+}
+
+func (u *userInfoAddress) GetStreetAddress() string {
+ return u.StreetAddress
+}
+
+func (u *userInfoAddress) GetLocality() string {
+ return u.Locality
+}
+
+func (u *userInfoAddress) GetRegion() string {
+ return u.Region
+}
+
+func (u *userInfoAddress) GetPostalCode() string {
+ return u.PostalCode
+}
+
+func (u *userInfoAddress) GetCountry() string {
+ return u.Country
+}
+
+type userInfoProfile struct {
+ Name string `json:"name,omitempty"`
+ GivenName string `json:"given_name,omitempty"`
+ FamilyName string `json:"family_name,omitempty"`
+ MiddleName string `json:"middle_name,omitempty"`
+ Nickname string `json:"nickname,omitempty"`
+ Profile string `json:"profile,omitempty"`
+ Picture string `json:"picture,omitempty"`
+ Website string `json:"website,omitempty"`
+ Gender Gender `json:"gender,omitempty"`
+ Birthdate string `json:"birthdate,omitempty"`
+ Zoneinfo string `json:"zoneinfo,omitempty"`
+ Locale language.Tag `json:"locale,omitempty"`
+ UpdatedAt Time `json:"updated_at,omitempty"`
+ PreferredUsername string `json:"preferred_username,omitempty"`
+}
+
+type userInfoEmail struct {
Email string `json:"email,omitempty"`
// Handle providers that return email_verified as a string
// https://forums.aws.amazon.com/thread.jspa?messageID=949441
// https://discuss.elastic.co/t/openid-error-after-authenticating-against-aws-cognito/206018/11
- EmailVerified Bool `json:"email_verified,omitempty"`
+ EmailVerified boolString `json:"email_verified,omitempty"`
}
-type Bool bool
+type boolString bool
-func (bs *Bool) UnmarshalJSON(data []byte) error {
+func (bs *boolString) UnmarshalJSON(data []byte) error {
if string(data) == "true" || string(data) == `"true"` {
*bs = true
}
@@ -80,12 +322,12 @@ func (bs *Bool) UnmarshalJSON(data []byte) error {
return nil
}
-type UserInfoPhone struct {
+type userInfoPhone struct {
PhoneNumber string `json:"phone_number,omitempty"`
PhoneNumberVerified bool `json:"phone_number_verified,omitempty"`
}
-type UserInfoAddress struct {
+type userInfoAddress struct {
Formatted string `json:"formatted,omitempty"`
StreetAddress string `json:"street_address,omitempty"`
Locality string `json:"locality,omitempty"`
@@ -94,6 +336,76 @@ type UserInfoAddress struct {
Country string `json:"country,omitempty"`
}
+func NewUserInfoAddress(streetAddress, locality, region, postalCode, country, formatted string) UserInfoAddress {
+ return &userInfoAddress{
+ StreetAddress: streetAddress,
+ Locality: locality,
+ Region: region,
+ PostalCode: postalCode,
+ Country: country,
+ Formatted: formatted,
+ }
+}
+
+func (u *userinfo) MarshalJSON() ([]byte, error) {
+ type Alias userinfo
+ a := &struct {
+ *Alias
+ Locale interface{} `json:"locale,omitempty"`
+ UpdatedAt int64 `json:"updated_at,omitempty"`
+ }{
+ Alias: (*Alias)(u),
+ }
+ if !u.Locale.IsRoot() {
+ a.Locale = u.Locale
+ }
+ if !time.Time(u.UpdatedAt).IsZero() {
+ a.UpdatedAt = time.Time(u.UpdatedAt).Unix()
+ }
+
+ b, err := json.Marshal(a)
+ if err != nil {
+ return nil, err
+ }
+
+ if len(u.claims) == 0 {
+ return b, nil
+ }
+
+ err = json.Unmarshal(b, &u.claims)
+ if err != nil {
+ return nil, fmt.Errorf("jws: invalid map of custom claims %v", u.claims)
+ }
+
+ return json.Marshal(u.claims)
+}
+
+func (u *userinfo) UnmarshalJSON(data []byte) error {
+ type Alias userinfo
+ a := &struct {
+ Address *userInfoAddress `json:"address,omitempty"`
+ *Alias
+ UpdatedAt int64 `json:"update_at,omitempty"`
+ }{
+ Alias: (*Alias)(u),
+ }
+ if err := json.Unmarshal(data, &a); err != nil {
+ return err
+ }
+
+ if a.Address != nil {
+ u.Address = a.Address
+ }
+
+ u.UpdatedAt = Time(time.Unix(a.UpdatedAt, 0).UTC())
+
+ if err := json.Unmarshal(data, &u.claims); err != nil {
+ return err
+ }
+
+ return nil
+}
+
type UserInfoRequest struct {
AccessToken string `schema:"access_token"`
}
diff --git a/pkg/oidc/userinfo_test.go b/pkg/oidc/userinfo_test.go
index a574366..319a2fd 100644
--- a/pkg/oidc/userinfo_test.go
+++ b/pkg/oidc/userinfo_test.go
@@ -7,113 +7,113 @@ import (
"github.com/stretchr/testify/assert"
)
-func TestUserInfo_AppendClaims(t *testing.T) {
- u := new(UserInfo)
- u.AppendClaims("a", "b")
- want := map[string]any{"a": "b"}
- assert.Equal(t, want, u.Claims)
-
- u.AppendClaims("d", "e")
- want["d"] = "e"
- assert.Equal(t, want, u.Claims)
-}
-
-func TestUserInfo_GetAddress(t *testing.T) {
- // nil address
- u := new(UserInfo)
- assert.Equal(t, &UserInfoAddress{}, u.GetAddress())
-
- u.Address = &UserInfoAddress{PostalCode: "1234"}
- assert.Equal(t, u.Address, u.GetAddress())
-}
-
func TestUserInfoMarshal(t *testing.T) {
- userinfo := &UserInfo{
- Subject: "test",
- Address: &UserInfoAddress{
- StreetAddress: "Test 789\nPostfach 2",
- },
- UserInfoEmail: UserInfoEmail{
- Email: "test",
- EmailVerified: true,
- },
- UserInfoPhone: UserInfoPhone{
- PhoneNumber: "0791234567",
- PhoneNumberVerified: true,
- },
- UserInfoProfile: UserInfoProfile{
- Name: "Test",
- },
- Claims: map[string]any{"private_claim": "test"},
- }
+ userinfo := NewUserInfo()
+ userinfo.SetSubject("test")
+ userinfo.SetAddress(NewUserInfoAddress("Test 789\nPostfach 2", "", "", "", "", ""))
+ userinfo.SetEmail("test", true)
+ userinfo.SetPhone("0791234567", true)
+ userinfo.SetName("Test")
+ userinfo.AppendClaims("private_claim", "test")
marshal, err := json.Marshal(userinfo)
+ out := NewUserInfo()
assert.NoError(t, err)
-
- out := new(UserInfo)
assert.NoError(t, json.Unmarshal(marshal, out))
+ assert.Equal(t, userinfo.GetAddress(), out.GetAddress())
expected, err := json.Marshal(out)
-
assert.NoError(t, err)
assert.Equal(t, expected, marshal)
-
- out2 := new(UserInfo)
- assert.NoError(t, json.Unmarshal(expected, out2))
- assert.Equal(t, out, out2)
}
func TestUserInfoEmailVerifiedUnmarshal(t *testing.T) {
t.Parallel()
- t.Run("unmarshal email_verified from json bool true", func(t *testing.T) {
+ t.Run("unmarsha email_verified from json bool true", func(t *testing.T) {
jsonBool := []byte(`{"email": "my@email.com", "email_verified": true}`)
- var uie UserInfoEmail
+ var uie userInfoEmail
err := json.Unmarshal(jsonBool, &uie)
assert.NoError(t, err)
- assert.Equal(t, UserInfoEmail{
+ assert.Equal(t, userInfoEmail{
Email: "my@email.com",
EmailVerified: true,
}, uie)
})
- t.Run("unmarshal email_verified from json string true", func(t *testing.T) {
+ t.Run("unmarsha email_verified from json string true", func(t *testing.T) {
jsonBool := []byte(`{"email": "my@email.com", "email_verified": "true"}`)
- var uie UserInfoEmail
+ var uie userInfoEmail
err := json.Unmarshal(jsonBool, &uie)
assert.NoError(t, err)
- assert.Equal(t, UserInfoEmail{
+ assert.Equal(t, userInfoEmail{
Email: "my@email.com",
EmailVerified: true,
}, uie)
})
- t.Run("unmarshal email_verified from json bool false", func(t *testing.T) {
+ t.Run("unmarsha email_verified from json bool false", func(t *testing.T) {
jsonBool := []byte(`{"email": "my@email.com", "email_verified": false}`)
- var uie UserInfoEmail
+ var uie userInfoEmail
err := json.Unmarshal(jsonBool, &uie)
assert.NoError(t, err)
- assert.Equal(t, UserInfoEmail{
+ assert.Equal(t, userInfoEmail{
Email: "my@email.com",
EmailVerified: false,
}, uie)
})
- t.Run("unmarshal email_verified from json string false", func(t *testing.T) {
+ t.Run("unmarsha email_verified from json string false", func(t *testing.T) {
jsonBool := []byte(`{"email": "my@email.com", "email_verified": "false"}`)
- var uie UserInfoEmail
+ var uie userInfoEmail
err := json.Unmarshal(jsonBool, &uie)
assert.NoError(t, err)
- assert.Equal(t, UserInfoEmail{
+ assert.Equal(t, userInfoEmail{
Email: "my@email.com",
EmailVerified: false,
}, uie)
})
}
+
+// issue 203 test case.
+func Test_userinfo_GetAddress_issue_203(t *testing.T) {
+ tests := []struct {
+ name string
+ data string
+ }{
+ {
+ name: "with address",
+ data: `{"address":{"street_address":"Test 789\nPostfach 2"},"email":"test","email_verified":true,"name":"Test","phone_number":"0791234567","phone_number_verified":true,"private_claim":"test","sub":"test"}`,
+ },
+ {
+ name: "without address",
+ data: `{"email":"test","email_verified":true,"name":"Test","phone_number":"0791234567","phone_number_verified":true,"private_claim":"test","sub":"test"}`,
+ },
+ {
+ name: "null address",
+ data: `{"address":null,"email":"test","email_verified":true,"name":"Test","phone_number":"0791234567","phone_number_verified":true,"private_claim":"test","sub":"test"}`,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ info := &userinfo{}
+ err := json.Unmarshal([]byte(tt.data), info)
+ assert.NoError(t, err)
+
+ info.GetAddress().GetCountry() //<- used to panic
+
+ // now shortly assure that a marshalling still produces the same as was parsed into the struct
+ marshal, err := json.Marshal(info)
+ assert.NoError(t, err)
+ assert.Equal(t, tt.data, string(marshal))
+ })
+ }
+}
diff --git a/pkg/oidc/util.go b/pkg/oidc/util.go
deleted file mode 100644
index 462ea44..0000000
--- a/pkg/oidc/util.go
+++ /dev/null
@@ -1,54 +0,0 @@
-package oidc
-
-import (
- "bytes"
- "encoding/json"
- "fmt"
-)
-
-// mergeAndMarshalClaims merges registered and the custom
-// claims map into a single JSON object.
-// Registered fields overwrite custom claims.
-func mergeAndMarshalClaims(registered any, extraClaims map[string]any) ([]byte, error) {
- // Use a buffer for memory re-use, instead off letting
- // json allocate a new []byte for every step.
- buf := new(bytes.Buffer)
-
- // Marshal the registered claims into JSON
- if err := json.NewEncoder(buf).Encode(registered); err != nil {
- return nil, fmt.Errorf("oidc registered claims: %w", err)
- }
-
- if len(extraClaims) > 0 {
- merged := make(map[string]any)
- for k, v := range extraClaims {
- merged[k] = v
- }
-
- // Merge JSON data into custom claims.
- // The full-read action by the decoder resets the buffer
- // to zero len, while retaining underlaying cap.
- if err := json.NewDecoder(buf).Decode(&merged); err != nil {
- return nil, fmt.Errorf("oidc registered claims: %w", err)
- }
-
- // Marshal the final result.
- if err := json.NewEncoder(buf).Encode(merged); err != nil {
- return nil, fmt.Errorf("oidc custom claims: %w", err)
- }
- }
-
- return buf.Bytes(), nil
-}
-
-// unmarshalJSONMulti unmarshals the same JSON data into multiple destinations.
-// Each destination must be a pointer, as per json.Unmarshal rules.
-// Returns on the first error and destinations may be partly filled with data.
-func unmarshalJSONMulti(data []byte, destinations ...any) error {
- for _, dst := range destinations {
- if err := json.Unmarshal(data, dst); err != nil {
- return fmt.Errorf("oidc: %w into %T", err, dst)
- }
- }
- return nil
-}
diff --git a/pkg/oidc/util_test.go b/pkg/oidc/util_test.go
deleted file mode 100644
index 6363d83..0000000
--- a/pkg/oidc/util_test.go
+++ /dev/null
@@ -1,147 +0,0 @@
-package oidc
-
-import (
- "errors"
- "testing"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-type jsonErrorTest struct{}
-
-func (jsonErrorTest) MarshalJSON() ([]byte, error) {
- return nil, errors.New("test")
-}
-
-func Test_mergeAndMarshalClaims(t *testing.T) {
- type args struct {
- registered any
- claims map[string]any
- }
- tests := []struct {
- name string
- args args
- want string
- wantErr bool
- }{
- {
- name: "encoder error",
- args: args{
- registered: jsonErrorTest{},
- },
- wantErr: true,
- },
- {
- name: "no claims",
- args: args{
- registered: struct {
- Foo string `json:"foo,omitempty"`
- }{
- Foo: "bar",
- },
- },
- want: "{\"foo\":\"bar\"}\n",
- },
- {
- name: "with claims",
- args: args{
- registered: struct {
- Foo string `json:"foo,omitempty"`
- }{
- Foo: "bar",
- },
- claims: map[string]any{
- "bar": "foo",
- },
- },
- want: "{\"bar\":\"foo\",\"foo\":\"bar\"}\n",
- },
- {
- name: "registered overwrites custom",
- args: args{
- registered: struct {
- Foo string `json:"foo,omitempty"`
- }{
- Foo: "bar",
- },
- claims: map[string]any{
- "foo": "Hello, World!",
- },
- },
- want: "{\"foo\":\"bar\"}\n",
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got, err := mergeAndMarshalClaims(tt.args.registered, tt.args.claims)
- if tt.wantErr {
- require.Error(t, err)
- } else {
- require.NoError(t, err)
- }
- assert.Equal(t, tt.want, string(got))
- })
- }
-}
-
-func Test_unmarshalJSONMulti(t *testing.T) {
- type dst struct {
- Foo string `json:"foo,omitempty"`
- }
-
- type args struct {
- data string
- destinations []any
- }
- tests := []struct {
- name string
- args args
- want []any
- wantErr bool
- }{
- {
- name: "error",
- args: args{
- data: "~!~~",
- destinations: []any{
- &dst{},
- &map[string]any{},
- },
- },
- want: []any{
- &dst{},
- &map[string]any{},
- },
- wantErr: true,
- },
- {
- name: "success",
- args: args{
- data: "{\"bar\":\"foo\",\"foo\":\"bar\"}\n",
- destinations: []any{
- &dst{},
- &map[string]any{},
- },
- },
- want: []any{
- &dst{Foo: "bar"},
- &map[string]any{
- "foo": "bar",
- "bar": "foo",
- },
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := unmarshalJSONMulti([]byte(tt.args.data), tt.args.destinations...)
- if tt.wantErr {
- require.Error(t, err)
- } else {
- require.NoError(t, err)
- }
- assert.Equal(t, tt.want, tt.args.destinations)
- })
- }
-}
diff --git a/pkg/oidc/verifier.go b/pkg/oidc/verifier.go
index d5e0213..cc18c80 100644
--- a/pkg/oidc/verifier.go
+++ b/pkg/oidc/verifier.go
@@ -7,11 +7,12 @@ import (
"encoding/json"
"errors"
"fmt"
- "slices"
"strings"
"time"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
+
+ str "github.com/zitadel/oidc/pkg/strings"
)
type Claims interface {
@@ -31,16 +32,9 @@ type ClaimsSignature interface {
SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm)
}
-type IDClaims interface {
- Claims
- GetSignatureAlgorithm() jose.SignatureAlgorithm
- GetAccessTokenHash() string
-}
-
var (
ErrParse = errors.New("parsing of request failed")
ErrIssuerInvalid = errors.New("issuer does not match")
- ErrDiscoveryFailed = errors.New("OpenID Provider Configuration Discovery has failed")
ErrSubjectMissing = errors.New("subject missing")
ErrAudience = errors.New("audience is not valid")
ErrAzpMissing = errors.New("authorized party is not set. If Token is valid for multiple audiences, azp must not be empty")
@@ -57,23 +51,14 @@ var (
ErrNonceInvalid = errors.New("nonce does not match")
ErrAcrInvalid = errors.New("acr is invalid")
ErrAuthTimeNotPresent = errors.New("claim `auth_time` of token is missing")
- ErrAuthTimeToOld = errors.New("auth time of token is too old")
+ ErrAuthTimeToOld = errors.New("auth time of token is to old")
ErrAtHash = errors.New("at_hash does not correspond to access token")
)
-// Verifier caries configuration for the various token verification
-// functions. Use package specific constructor functions to know
-// which values need to be set.
-type Verifier struct {
- Issuer string
- MaxAgeIAT time.Duration
- Offset time.Duration
- ClientID string
- SupportedSignAlgs []string
- MaxAge time.Duration
- ACR ACRVerifier
- KeySet KeySet
- Nonce func(ctx context.Context) string
+type Verifier interface {
+ Issuer() string
+ MaxAgeIAT() time.Duration
+ Offset() time.Duration
}
// ACRVerifier specifies the function to be used by the `DefaultVerifier` for validating the acr claim
@@ -83,7 +68,7 @@ type ACRVerifier func(string) error
// if none of the provided values matches the acr claim
func DefaultACRVerifier(possibleValues []string) ACRVerifier {
return func(acr string) error {
- if !slices.Contains(possibleValues, acr) {
+ if !str.Contains(possibleValues, acr) {
return fmt.Errorf("expected one of: %v, got: %q", possibleValues, acr)
}
return nil
@@ -94,7 +79,7 @@ func DecryptToken(tokenString string) (string, error) {
return tokenString, nil // TODO: impl
}
-func ParseToken(tokenString string, claims any) ([]byte, error) {
+func ParseToken(tokenString string, claims interface{}) ([]byte, error) {
parts := strings.Split(tokenString, ".")
if len(parts) != 3 {
return nil, fmt.Errorf("%w: token contains an invalid number of segments", ErrParse)
@@ -122,7 +107,7 @@ func CheckIssuer(claims Claims, issuer string) error {
}
func CheckAudience(claims Claims, clientID string) error {
- if !slices.Contains(claims.GetAudience(), clientID) {
+ if !str.Contains(claims.GetAudience(), clientID) {
return fmt.Errorf("%w: Audience must contain client_id %q", ErrAudience, clientID)
}
@@ -130,11 +115,6 @@ func CheckAudience(claims Claims, clientID string) error {
return nil
}
-// CheckAuthorizedParty checks azp (authorized party) claim requirements.
-//
-// If the ID Token contains multiple audiences, the Client SHOULD verify that an azp Claim is present.
-// If an azp Claim is present, the Client SHOULD verify that its client_id is the Claim Value.
-// https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
func CheckAuthorizedParty(claims Claims, clientID string) error {
if len(claims.GetAudience()) > 1 {
if claims.GetAuthorizedParty() == "" {
@@ -148,13 +128,8 @@ func CheckAuthorizedParty(claims Claims, clientID string) error {
}
func CheckSignature(ctx context.Context, token string, payload []byte, claims ClaimsSignature, supportedSigAlgs []string, set KeySet) error {
- jws, err := jose.ParseSigned(token, toJoseSignatureAlgorithms(supportedSigAlgs))
+ jws, err := jose.ParseSigned(token)
if err != nil {
- if strings.HasPrefix(err.Error(), "go-jose/go-jose: unexpected signature algorithm") {
- // TODO(v4): we should wrap errors instead of returning static ones.
- // This is a workaround so we keep returning the same error for now.
- return ErrSignatureUnsupportedAlg
- }
return ErrParse
}
if len(jws.Signatures) == 0 {
@@ -164,6 +139,12 @@ func CheckSignature(ctx context.Context, token string, payload []byte, claims Cl
return ErrSignatureMultiple
}
sig := jws.Signatures[0]
+ if len(supportedSigAlgs) == 0 {
+ supportedSigAlgs = []string{"RS256"}
+ }
+ if !str.Contains(supportedSigAlgs, sig.Header.Algorithm) {
+ return fmt.Errorf("%w: id token signed with unsupported algorithm, expected %q got %q", ErrSignatureUnsupportedAlg, supportedSigAlgs, sig.Header.Algorithm)
+ }
signedPayload, err := set.VerifySignature(ctx, jws)
if err != nil {
@@ -179,39 +160,27 @@ func CheckSignature(ctx context.Context, token string, payload []byte, claims Cl
return nil
}
-// TODO(v4): Use the new jose.SignatureAlgorithm type directly, instead of string.
-func toJoseSignatureAlgorithms(algorithms []string) []jose.SignatureAlgorithm {
- out := make([]jose.SignatureAlgorithm, len(algorithms))
- for i := range algorithms {
- out[i] = jose.SignatureAlgorithm(algorithms[i])
- }
- if len(out) == 0 {
- out = append(out, jose.RS256, jose.ES256, jose.PS256)
- }
- return out
-}
-
func CheckExpiration(claims Claims, offset time.Duration) error {
- expiration := claims.GetExpiration()
- if !time.Now().Add(offset).Before(expiration) {
+ expiration := claims.GetExpiration().Round(time.Second)
+ if !time.Now().UTC().Add(offset).Before(expiration) {
return ErrExpired
}
return nil
}
func CheckIssuedAt(claims Claims, maxAgeIAT, offset time.Duration) error {
- issuedAt := claims.GetIssuedAt()
+ issuedAt := claims.GetIssuedAt().Round(time.Second)
if issuedAt.IsZero() {
return ErrIatMissing
}
- nowWithOffset := time.Now().Add(offset).Round(time.Second)
+ nowWithOffset := time.Now().UTC().Add(offset).Round(time.Second)
if issuedAt.After(nowWithOffset) {
return fmt.Errorf("%w: (iat: %v, now with offset: %v)", ErrIatInFuture, issuedAt, nowWithOffset)
}
if maxAgeIAT == 0 {
return nil
}
- maxAge := time.Now().Add(-maxAgeIAT).Round(time.Second)
+ maxAge := time.Now().UTC().Add(-maxAgeIAT).Round(time.Second)
if issuedAt.Before(maxAge) {
return fmt.Errorf("%w: must not be older than %v, but was %v (%v to old)", ErrIatToOld, maxAge, issuedAt, maxAge.Sub(issuedAt))
}
@@ -241,8 +210,8 @@ func CheckAuthTime(claims Claims, maxAge time.Duration) error {
if claims.GetAuthTime().IsZero() {
return ErrAuthTimeNotPresent
}
- authTime := claims.GetAuthTime()
- maxAuthTime := time.Now().Add(-maxAge).Round(time.Second)
+ authTime := claims.GetAuthTime().Round(time.Second)
+ maxAuthTime := time.Now().UTC().Add(-maxAge).Round(time.Second)
if authTime.Before(maxAuthTime) {
return fmt.Errorf("%w: must not be older than %v, but was %v (%v to old)", ErrAuthTimeToOld, maxAge, authTime, maxAuthTime.Sub(authTime))
}
diff --git a/pkg/oidc/verifier_parse_test.go b/pkg/oidc/verifier_parse_test.go
deleted file mode 100644
index 9cf5c1e..0000000
--- a/pkg/oidc/verifier_parse_test.go
+++ /dev/null
@@ -1,128 +0,0 @@
-package oidc_test
-
-import (
- "context"
- "encoding/json"
- "testing"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestParseToken(t *testing.T) {
- token, wantClaims := tu.ValidIDToken()
- wantClaims.SignatureAlg = "" // unset, because is not part of the JSON payload
-
- wantPayload, err := json.Marshal(wantClaims)
- require.NoError(t, err)
-
- tests := []struct {
- name string
- tokenString string
- wantErr bool
- }{
- {
- name: "split error",
- tokenString: "nope",
- wantErr: true,
- },
- {
- name: "base64 error",
- tokenString: "foo.~.bar",
- wantErr: true,
- },
- {
- name: "success",
- tokenString: token,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- gotClaims := new(oidc.IDTokenClaims)
- gotPayload, err := oidc.ParseToken(tt.tokenString, gotClaims)
- if tt.wantErr {
- assert.Error(t, err)
- return
- }
- require.NoError(t, err)
- assert.Equal(t, wantClaims, gotClaims)
- assert.JSONEq(t, string(wantPayload), string(gotPayload))
- })
- }
-}
-
-func TestCheckSignature(t *testing.T) {
- errCtx, cancel := context.WithCancel(context.Background())
- cancel()
-
- token, _ := tu.ValidIDToken()
- payload, err := oidc.ParseToken(token, &oidc.IDTokenClaims{})
- require.NoError(t, err)
-
- type args struct {
- ctx context.Context
- token string
- payload []byte
- supportedSigAlgs []string
- }
- tests := []struct {
- name string
- args args
- wantErr error
- }{
- {
- name: "parse error",
- args: args{
- ctx: context.Background(),
- token: "~",
- payload: payload,
- },
- wantErr: oidc.ErrParse,
- },
- {
- name: "default sigAlg",
- args: args{
- ctx: context.Background(),
- token: token,
- payload: payload,
- },
- },
- {
- name: "unsupported sigAlg",
- args: args{
- ctx: context.Background(),
- token: token,
- payload: payload,
- supportedSigAlgs: []string{"foo", "bar"},
- },
- wantErr: oidc.ErrSignatureUnsupportedAlg,
- },
- {
- name: "verify error",
- args: args{
- ctx: errCtx,
- token: token,
- payload: payload,
- },
- wantErr: oidc.ErrSignatureInvalid,
- },
- {
- name: "inequal payloads",
- args: args{
- ctx: context.Background(),
- token: token,
- payload: []byte{0, 1, 2},
- },
- wantErr: oidc.ErrSignatureInvalidPayload,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- claims := new(oidc.TokenClaims)
- err := oidc.CheckSignature(tt.args.ctx, tt.args.token, tt.args.payload, claims, tt.args.supportedSigAlgs, tu.KeySet{})
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
diff --git a/pkg/oidc/verifier_test.go b/pkg/oidc/verifier_test.go
deleted file mode 100644
index 93e7157..0000000
--- a/pkg/oidc/verifier_test.go
+++ /dev/null
@@ -1,374 +0,0 @@
-package oidc
-
-import (
- "errors"
- "testing"
- "time"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestDecryptToken(t *testing.T) {
- const tokenString = "ABC"
- got, err := DecryptToken(tokenString)
- require.NoError(t, err)
- assert.Equal(t, tokenString, got)
-}
-
-func TestDefaultACRVerifier(t *testing.T) {
- acrVerfier := DefaultACRVerifier([]string{"foo", "bar"})
-
- tests := []struct {
- name string
- acr string
- wantErr string
- }{
- {
- name: "ok",
- acr: "bar",
- },
- {
- name: "error",
- acr: "hello",
- wantErr: "expected one of: [foo bar], got: \"hello\"",
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := acrVerfier(tt.acr)
- if tt.wantErr != "" {
- assert.EqualError(t, err, tt.wantErr)
- return
- }
- require.NoError(t, err)
- })
- }
-}
-
-func TestCheckSubject(t *testing.T) {
- tests := []struct {
- name string
- claims Claims
- wantErr error
- }{
- {
- name: "missing",
- claims: &TokenClaims{},
- wantErr: ErrSubjectMissing,
- },
- {
- name: "ok",
- claims: &TokenClaims{
- Subject: "foo",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckSubject(tt.claims)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckIssuer(t *testing.T) {
- const issuer = "foo.bar"
- tests := []struct {
- name string
- claims Claims
- wantErr error
- }{
- {
- name: "missing",
- claims: &TokenClaims{},
- wantErr: ErrIssuerInvalid,
- },
- {
- name: "wrong",
- claims: &TokenClaims{
- Issuer: "wrong",
- },
- wantErr: ErrIssuerInvalid,
- },
- {
- name: "ok",
- claims: &TokenClaims{
- Issuer: issuer,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckIssuer(tt.claims, issuer)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckAudience(t *testing.T) {
- const clientID = "foo.bar"
- tests := []struct {
- name string
- claims Claims
- wantErr error
- }{
- {
- name: "missing",
- claims: &TokenClaims{},
- wantErr: ErrAudience,
- },
- {
- name: "wrong",
- claims: &TokenClaims{
- Audience: []string{"wrong"},
- },
- wantErr: ErrAudience,
- },
- {
- name: "ok",
- claims: &TokenClaims{
- Audience: []string{clientID},
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckAudience(tt.claims, clientID)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckAuthorizedParty(t *testing.T) {
- const clientID = "foo.bar"
- tests := []struct {
- name string
- claims Claims
- wantErr error
- }{
- {
- name: "single audience, no azp",
- claims: &TokenClaims{
- Audience: []string{clientID},
- },
- },
- {
- name: "multiple audience, no azp",
- claims: &TokenClaims{
- Audience: []string{clientID, "other"},
- },
- wantErr: ErrAzpMissing,
- },
- {
- name: "single audience, with azp",
- claims: &TokenClaims{
- Audience: []string{clientID},
- AuthorizedParty: clientID,
- },
- },
- {
- name: "multiple audience, with azp",
- claims: &TokenClaims{
- Audience: []string{clientID, "other"},
- AuthorizedParty: clientID,
- },
- },
- {
- name: "wrong azp",
- claims: &TokenClaims{
- AuthorizedParty: "wrong",
- },
- wantErr: ErrAzpInvalid,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckAuthorizedParty(tt.claims, clientID)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckExpiration(t *testing.T) {
- const offset = time.Minute
- tests := []struct {
- name string
- claims Claims
- wantErr error
- }{
- {
- name: "missing",
- claims: &TokenClaims{},
- wantErr: ErrExpired,
- },
- {
- name: "expired",
- claims: &TokenClaims{
- Expiration: FromTime(time.Now().Add(-2 * offset)),
- },
- wantErr: ErrExpired,
- },
- {
- name: "valid",
- claims: &TokenClaims{
- Expiration: FromTime(time.Now().Add(2 * offset)),
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckExpiration(tt.claims, offset)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckIssuedAt(t *testing.T) {
- const offset = time.Minute
- tests := []struct {
- name string
- maxAgeIAT time.Duration
- claims Claims
- wantErr error
- }{
- {
- name: "missing",
- claims: &TokenClaims{},
- wantErr: ErrIatMissing,
- },
- {
- name: "future",
- claims: &TokenClaims{
- IssuedAt: FromTime(time.Now().Add(time.Hour)),
- },
- wantErr: ErrIatInFuture,
- },
- {
- name: "no max",
- claims: &TokenClaims{
- IssuedAt: FromTime(time.Now()),
- },
- },
- {
- name: "past max",
- maxAgeIAT: time.Minute,
- claims: &TokenClaims{
- IssuedAt: FromTime(time.Now().Add(-time.Hour)),
- },
- wantErr: ErrIatToOld,
- },
- {
- name: "within max",
- maxAgeIAT: time.Hour,
- claims: &TokenClaims{
- IssuedAt: FromTime(time.Now()),
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckIssuedAt(tt.claims, tt.maxAgeIAT, offset)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckNonce(t *testing.T) {
- const nonce = "123"
- tests := []struct {
- name string
- claims Claims
- wantErr error
- }{
- {
- name: "missing",
- claims: &TokenClaims{},
- wantErr: ErrNonceInvalid,
- },
- {
- name: "wrong",
- claims: &TokenClaims{
- Nonce: "wrong",
- },
- wantErr: ErrNonceInvalid,
- },
- {
- name: "ok",
- claims: &TokenClaims{
- Nonce: nonce,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckNonce(tt.claims, nonce)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckAuthorizationContextClassReference(t *testing.T) {
- tests := []struct {
- name string
- acr ACRVerifier
- wantErr error
- }{
- {
- name: "error",
- acr: func(s string) error { return errors.New("oops") },
- wantErr: ErrAcrInvalid,
- },
- {
- name: "ok",
- acr: func(s string) error { return nil },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckAuthorizationContextClassReference(&IDTokenClaims{}, tt.acr)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
-
-func TestCheckAuthTime(t *testing.T) {
- tests := []struct {
- name string
- claims Claims
- maxAge time.Duration
- wantErr error
- }{
- {
- name: "no max age",
- claims: &TokenClaims{},
- },
- {
- name: "missing",
- claims: &TokenClaims{},
- maxAge: time.Minute,
- wantErr: ErrAuthTimeNotPresent,
- },
- {
- name: "expired",
- maxAge: time.Minute,
- claims: &TokenClaims{
- AuthTime: FromTime(time.Now().Add(-time.Hour)),
- },
- wantErr: ErrAuthTimeToOld,
- },
- {
- name: "ok",
- maxAge: time.Minute,
- claims: &TokenClaims{
- AuthTime: NowTime(),
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := CheckAuthTime(tt.claims, tt.maxAge)
- assert.ErrorIs(t, err, tt.wantErr)
- })
- }
-}
diff --git a/pkg/op/auth_request.go b/pkg/op/auth_request.go
index b1434cc..ecfde28 100644
--- a/pkg/op/auth_request.go
+++ b/pkg/op/auth_request.go
@@ -1,23 +1,20 @@
package op
import (
- "bytes"
"context"
- _ "embed"
- "errors"
"fmt"
- "html/template"
- "log/slog"
"net"
"net/http"
"net/url"
- "slices"
+ "path"
"strings"
"time"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/bmatcuk/doublestar/v4"
+ "github.com/gorilla/mux"
+
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
+ str "github.com/zitadel/oidc/pkg/strings"
)
type AuthRequest interface {
@@ -38,34 +35,22 @@ type AuthRequest interface {
Done() bool
}
-// AuthRequestSessionState should be implemented if [OpenID Connect Session Management](https://openid.net/specs/openid-connect-session-1_0.html) is supported
-type AuthRequestSessionState interface {
- // GetSessionState returns session_state.
- // session_state is related to OpenID Connect Session Management.
- GetSessionState() string
-}
-
type Authorizer interface {
Storage() Storage
Decoder() httphelper.Decoder
Encoder() httphelper.Encoder
- IDTokenHintVerifier(context.Context) *IDTokenHintVerifier
+ Signer() Signer
+ IDTokenHintVerifier() IDTokenHintVerifier
Crypto() Crypto
+ Issuer() string
RequestObjectSupported() bool
- Logger() *slog.Logger
}
// AuthorizeValidator is an extension of Authorizer interface
// implementing its own validation mechanism for the auth request
type AuthorizeValidator interface {
Authorizer
- ValidateAuthRequest(context.Context, *oidc.AuthRequest, Storage, *IDTokenHintVerifier) (string, error)
-}
-
-type CodeResponseType struct {
- Code string `schema:"code"`
- State string `schema:"state,omitempty"`
- SessionState string `schema:"session_state,omitempty"`
+ ValidateAuthRequest(context.Context, *oidc.AuthRequest, Storage, IDTokenHintVerifier) (string, error)
}
func authorizeHandler(authorizer Authorizer) func(http.ResponseWriter, *http.Request) {
@@ -74,7 +59,7 @@ func authorizeHandler(authorizer Authorizer) func(http.ResponseWriter, *http.Req
}
}
-func AuthorizeCallbackHandler(authorizer Authorizer) func(http.ResponseWriter, *http.Request) {
+func authorizeCallbackHandler(authorizer Authorizer) func(http.ResponseWriter, *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
AuthorizeCallback(w, r, authorizer)
}
@@ -83,54 +68,47 @@ func AuthorizeCallbackHandler(authorizer Authorizer) func(http.ResponseWriter, *
// Authorize handles the authorization request, including
// parsing, validating, storing and finally redirecting to the login handler
func Authorize(w http.ResponseWriter, r *http.Request, authorizer Authorizer) {
- ctx, span := tracer.Start(r.Context(), "Authorize")
- r = r.WithContext(ctx)
- defer span.End()
-
authReq, err := ParseAuthorizeRequest(r, authorizer.Decoder())
if err != nil {
- AuthRequestError(w, r, nil, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
return
}
if authReq.RequestParam != "" && authorizer.RequestObjectSupported() {
- err = ParseRequestObject(ctx, authReq, authorizer.Storage(), IssuerFromContext(ctx))
+ authReq, err = ParseRequestObject(r.Context(), authReq, authorizer.Storage(), authorizer.Issuer())
if err != nil {
- AuthRequestError(w, r, nil, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
return
}
}
if authReq.ClientID == "" {
- AuthRequestError(w, r, nil, fmt.Errorf("auth request is missing client_id"), authorizer)
+ AuthRequestError(w, r, authReq, fmt.Errorf("auth request is missing client_id"), authorizer.Encoder())
return
}
if authReq.RedirectURI == "" {
- AuthRequestError(w, r, nil, fmt.Errorf("auth request is missing redirect_uri"), authorizer)
+ AuthRequestError(w, r, authReq, fmt.Errorf("auth request is missing redirect_uri"), authorizer.Encoder())
return
}
-
- var client Client
- validation := func(ctx context.Context, authReq *oidc.AuthRequest, storage Storage, verifier *IDTokenHintVerifier) (sub string, err error) {
- client, err = authorizer.Storage().GetClientByClientID(ctx, authReq.ClientID)
- if err != nil {
- return "", oidc.ErrInvalidRequestRedirectURI().WithDescription("unable to retrieve client by id").WithParent(err)
- }
- return ValidateAuthRequestClient(ctx, authReq, client, verifier)
+ validation := ValidateAuthRequest
+ if validater, ok := authorizer.(AuthorizeValidator); ok {
+ validation = validater.ValidateAuthRequest
}
- if validator, ok := authorizer.(AuthorizeValidator); ok {
- validation = validator.ValidateAuthRequest
- }
- userID, err := validation(ctx, authReq, authorizer.Storage(), authorizer.IDTokenHintVerifier(ctx))
+ userID, err := validation(r.Context(), authReq, authorizer.Storage(), authorizer.IDTokenHintVerifier())
if err != nil {
- AuthRequestError(w, r, authReq, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
return
}
if authReq.RequestParam != "" {
- AuthRequestError(w, r, authReq, oidc.ErrRequestNotSupported(), authorizer)
+ AuthRequestError(w, r, authReq, oidc.ErrRequestNotSupported(), authorizer.Encoder())
return
}
- req, err := authorizer.Storage().CreateAuthRequest(ctx, authReq, userID)
+ req, err := authorizer.Storage().CreateAuthRequest(r.Context(), authReq, userID)
if err != nil {
- AuthRequestError(w, r, authReq, oidc.DefaultToServerError(err, "unable to save auth request"), authorizer)
+ AuthRequestError(w, r, authReq, oidc.DefaultToServerError(err, "unable to save auth request"), authorizer.Encoder())
+ return
+ }
+ client, err := authorizer.Storage().GetClientByClientID(r.Context(), req.GetClientID())
+ if err != nil {
+ AuthRequestError(w, r, req, oidc.DefaultToServerError(err, "unable to retrieve client by id"), authorizer.Encoder())
return
}
RedirectToLogin(req.GetID(), client, w, r)
@@ -152,37 +130,37 @@ func ParseAuthorizeRequest(r *http.Request, decoder httphelper.Decoder) (*oidc.A
// ParseRequestObject parse the `request` parameter, validates the token including the signature
// and copies the token claims into the auth request
-func ParseRequestObject(ctx context.Context, authReq *oidc.AuthRequest, storage Storage, issuer string) error {
+func ParseRequestObject(ctx context.Context, authReq *oidc.AuthRequest, storage Storage, issuer string) (*oidc.AuthRequest, error) {
requestObject := new(oidc.RequestObject)
payload, err := oidc.ParseToken(authReq.RequestParam, requestObject)
if err != nil {
- return err
+ return nil, err
}
if requestObject.ClientID != "" && requestObject.ClientID != authReq.ClientID {
- return oidc.ErrInvalidRequest().WithDescription("missing or wrong client id in request")
+ return authReq, oidc.ErrInvalidRequest()
}
if requestObject.ResponseType != "" && requestObject.ResponseType != authReq.ResponseType {
- return oidc.ErrInvalidRequest().WithDescription("missing or wrong response type in request")
+ return authReq, oidc.ErrInvalidRequest()
}
if requestObject.Issuer != requestObject.ClientID {
- return oidc.ErrInvalidRequest().WithDescription("missing or wrong issuer in request")
+ return authReq, oidc.ErrInvalidRequest()
}
- if !slices.Contains(requestObject.Audience, issuer) {
- return oidc.ErrInvalidRequest().WithDescription("issuer missing in audience")
+ if !str.Contains(requestObject.Audience, issuer) {
+ return authReq, oidc.ErrInvalidRequest()
}
keySet := &jwtProfileKeySet{storage: storage, clientID: requestObject.Issuer}
if err = oidc.CheckSignature(ctx, authReq.RequestParam, payload, requestObject, nil, keySet); err != nil {
- return oidc.ErrInvalidRequest().WithParent(err).WithDescription(err.Error())
+ return authReq, err
}
CopyRequestObjectToAuthRequest(authReq, requestObject)
- return nil
+ return authReq, nil
}
// CopyRequestObjectToAuthRequest overwrites present values from the Request Object into the auth request
// and clears the `RequestParam` of the auth request
func CopyRequestObjectToAuthRequest(authReq *oidc.AuthRequest, requestObject *oidc.RequestObject) {
- if slices.Contains(authReq.Scopes, oidc.ScopeOpenID) && len(requestObject.Scopes) > 0 {
+ if str.Contains(authReq.Scopes, oidc.ScopeOpenID) && len(requestObject.Scopes) > 0 {
authReq.Scopes = requestObject.Scopes
}
if requestObject.RedirectURI != "" {
@@ -227,37 +205,23 @@ func CopyRequestObjectToAuthRequest(authReq *oidc.AuthRequest, requestObject *oi
authReq.RequestParam = ""
}
-// ValidateAuthRequest validates the authorize parameters and returns the userID of the id_token_hint if passed.
-//
-// Deprecated: Use [ValidateAuthRequestClient] to prevent querying for the Client twice.
-func ValidateAuthRequest(ctx context.Context, authReq *oidc.AuthRequest, storage Storage, verifier *IDTokenHintVerifier) (sub string, err error) {
- ctx, span := tracer.Start(ctx, "ValidateAuthRequest")
- defer span.End()
-
- client, err := storage.GetClientByClientID(ctx, authReq.ClientID)
- if err != nil {
- return "", oidc.ErrInvalidRequestRedirectURI().WithDescription("unable to retrieve client by id").WithParent(err)
- }
- return ValidateAuthRequestClient(ctx, authReq, client, verifier)
-}
-
-// ValidateAuthRequestClient validates the Auth request against the passed client.
-// If id_token_hint is part of the request, the subject of the token is returned.
-func ValidateAuthRequestClient(ctx context.Context, authReq *oidc.AuthRequest, client Client, verifier *IDTokenHintVerifier) (sub string, err error) {
- ctx, span := tracer.Start(ctx, "ValidateAuthRequestClient")
- defer span.End()
-
- if err := ValidateAuthReqRedirectURI(client, authReq.RedirectURI, authReq.ResponseType); err != nil {
- return "", err
- }
+// ValidateAuthRequest validates the authorize parameters and returns the userID of the id_token_hint if passed
+func ValidateAuthRequest(ctx context.Context, authReq *oidc.AuthRequest, storage Storage, verifier IDTokenHintVerifier) (sub string, err error) {
authReq.MaxAge, err = ValidateAuthReqPrompt(authReq.Prompt, authReq.MaxAge)
if err != nil {
return "", err
}
+ client, err := storage.GetClientByClientID(ctx, authReq.ClientID)
+ if err != nil {
+ return "", oidc.DefaultToServerError(err, "unable to retrieve client by id")
+ }
authReq.Scopes, err = ValidateAuthReqScopes(client, authReq.Scopes)
if err != nil {
return "", err
}
+ if err := ValidateAuthReqRedirectURI(client, authReq.RedirectURI, authReq.ResponseType); err != nil {
+ return "", err
+ }
if err := ValidateAuthReqResponseType(client, authReq.ResponseType); err != nil {
return "", err
}
@@ -277,35 +241,49 @@ func ValidateAuthReqPrompt(prompts []string, maxAge *uint) (_ *uint, err error)
return maxAge, nil
}
-// ValidateAuthReqScopes validates the passed scopes and deletes any unsupported scopes.
-// An error is returned if scopes is empty.
+// ValidateAuthReqScopes validates the passed scopes
func ValidateAuthReqScopes(client Client, scopes []string) ([]string, error) {
if len(scopes) == 0 {
return nil, oidc.ErrInvalidRequest().
WithDescription("The scope of your request is missing. Please ensure some scopes are requested. " +
"If you have any questions, you may contact the administrator of the application.")
}
- scopes = slices.DeleteFunc(scopes, func(scope string) bool {
- return !(scope == oidc.ScopeOpenID ||
- scope == oidc.ScopeProfile ||
+ openID := false
+ for i := len(scopes) - 1; i >= 0; i-- {
+ scope := scopes[i]
+ if scope == oidc.ScopeOpenID {
+ openID = true
+ continue
+ }
+ if !(scope == oidc.ScopeProfile ||
scope == oidc.ScopeEmail ||
scope == oidc.ScopePhone ||
scope == oidc.ScopeAddress ||
scope == oidc.ScopeOfflineAccess) &&
- !client.IsScopeAllowed(scope)
- })
+ !client.IsScopeAllowed(scope) {
+ scopes[i] = scopes[len(scopes)-1]
+ scopes[len(scopes)-1] = ""
+ scopes = scopes[:len(scopes)-1]
+ }
+ }
+ if !openID {
+ return nil, oidc.ErrInvalidScope().WithDescription("The scope openid is missing in your request. " +
+ "Please ensure the scope openid is added to the request. " +
+ "If you have any questions, you may contact the administrator of the application.")
+ }
+
return scopes, nil
}
-// checkURIAgainstRedirects just checks aginst the valid redirect URIs and ignores
+// checkURIAginstRedirects just checks aginst the valid redirect URIs and ignores
// other factors.
-func checkURIAgainstRedirects(client Client, uri string) error {
- if slices.Contains(client.RedirectURIs(), uri) {
+func checkURIAginstRedirects(client Client, uri string) error {
+ if str.Contains(client.RedirectURIs(), uri) {
return nil
}
if globClient, ok := client.(HasRedirectGlobs); ok {
for _, uriGlob := range globClient.RedirectURIGlobs() {
- isMatch, err := doublestar.Match(uriGlob, uri)
+ isMatch, err := path.Match(uriGlob, uri)
if err != nil {
return oidc.ErrServerError().WithParent(err)
}
@@ -325,13 +303,13 @@ func ValidateAuthReqRedirectURI(client Client, uri string, responseType oidc.Res
return oidc.ErrInvalidRequestRedirectURI().WithDescription("The redirect_uri is missing in the request. " +
"Please ensure it is added to the request. If you have any questions, you may contact the administrator of the application.")
}
- if client.ApplicationType() == ApplicationTypeNative {
- return validateAuthReqRedirectURINative(client, uri)
- }
if strings.HasPrefix(uri, "https://") {
- return checkURIAgainstRedirects(client, uri)
+ return checkURIAginstRedirects(client, uri)
}
- if err := checkURIAgainstRedirects(client, uri); err != nil {
+ if client.ApplicationType() == ApplicationTypeNative {
+ return validateAuthReqRedirectURINative(client, uri, responseType)
+ }
+ if err := checkURIAginstRedirects(client, uri); err != nil {
return err
}
if strings.HasPrefix(uri, "http://") {
@@ -349,17 +327,14 @@ func ValidateAuthReqRedirectURI(client Client, uri string, responseType oidc.Res
}
// ValidateAuthReqRedirectURINative validates the passed redirect_uri and response_type to the registered uris and client type
-func validateAuthReqRedirectURINative(client Client, uri string) error {
+func validateAuthReqRedirectURINative(client Client, uri string, responseType oidc.ResponseType) error {
parsedURL, isLoopback := HTTPLoopbackOrLocalhost(uri)
- isCustomSchema := !(strings.HasPrefix(uri, "http://") || strings.HasPrefix(uri, "https://"))
- if err := checkURIAgainstRedirects(client, uri); err == nil {
+ isCustomSchema := !strings.HasPrefix(uri, "http://")
+ if err := checkURIAginstRedirects(client, uri); err == nil {
if client.DevMode() {
return nil
}
- if !isLoopback && strings.HasPrefix(uri, "https://") {
- return nil
- }
- // The RedirectURIs are only valid for native clients when localhost or non-"http://" and "https://"
+ // The RedirectURIs are only valid for native clients when localhost or non-"http://"
if isLoopback || isCustomSchema {
return nil
}
@@ -384,16 +359,16 @@ func equalURI(url1, url2 *url.URL) bool {
return url1.Path == url2.Path && url1.RawQuery == url2.RawQuery
}
-func HTTPLoopbackOrLocalhost(rawURL string) (*url.URL, bool) {
- parsedURL, err := url.Parse(rawURL)
+func HTTPLoopbackOrLocalhost(rawurl string) (*url.URL, bool) {
+ parsedURL, err := url.Parse(rawurl)
if err != nil {
return nil, false
}
- if parsedURL.Scheme == "http" || parsedURL.Scheme == "https" {
- hostName := parsedURL.Hostname()
- return parsedURL, hostName == "localhost" || net.ParseIP(hostName).IsLoopback()
+ if parsedURL.Scheme != "http" {
+ return nil, false
}
- return nil, false
+ hostName := parsedURL.Hostname()
+ return parsedURL, hostName == "localhost" || net.ParseIP(hostName).IsLoopback()
}
// ValidateAuthReqResponseType validates the passed response_type to the registered response types
@@ -411,14 +386,14 @@ func ValidateAuthReqResponseType(client Client, responseType oidc.ResponseType)
// ValidateAuthReqIDTokenHint validates the id_token_hint (if passed as parameter in the request)
// and returns the `sub` claim
-func ValidateAuthReqIDTokenHint(ctx context.Context, idTokenHint string, verifier *IDTokenHintVerifier) (string, error) {
+func ValidateAuthReqIDTokenHint(ctx context.Context, idTokenHint string, verifier IDTokenHintVerifier) (string, error) {
if idTokenHint == "" {
return "", nil
}
- claims, err := VerifyIDTokenHint[*oidc.TokenClaims](ctx, idTokenHint, verifier)
- if err != nil && !errors.As(err, &IDTokenHintExpiredError{}) {
+ claims, err := VerifyIDTokenHint(ctx, idTokenHint, verifier)
+ if err != nil {
return "", oidc.ErrLoginRequired().WithDescription("The id_token_hint is invalid. " +
- "If you have any questions, you may contact the administrator of the application.").WithParent(err)
+ "If you have any questions, you may contact the administrator of the application.")
}
return claims.GetSubject(), nil
}
@@ -431,49 +406,32 @@ func RedirectToLogin(authReqID string, client Client, w http.ResponseWriter, r *
// AuthorizeCallback handles the callback after authentication in the Login UI
func AuthorizeCallback(w http.ResponseWriter, r *http.Request, authorizer Authorizer) {
- ctx, span := tracer.Start(r.Context(), "AuthorizeCallback")
- r = r.WithContext(ctx)
- defer span.End()
-
- id, err := ParseAuthorizeCallbackRequest(r)
- if err != nil {
- AuthRequestError(w, r, nil, err, authorizer)
+ params := mux.Vars(r)
+ id := params["id"]
+ if id == "" {
+ AuthRequestError(w, r, nil, fmt.Errorf("auth request callback is missing id"), authorizer.Encoder())
return
}
+
authReq, err := authorizer.Storage().AuthRequestByID(r.Context(), id)
if err != nil {
- AuthRequestError(w, r, nil, err, authorizer)
+ AuthRequestError(w, r, nil, err, authorizer.Encoder())
return
}
if !authReq.Done() {
AuthRequestError(w, r, authReq,
oidc.ErrInteractionRequired().WithDescription("Unfortunately, the user may be not logged in and/or additional interaction is required."),
- authorizer)
+ authorizer.Encoder())
return
}
AuthResponse(authReq, authorizer, w, r)
}
-func ParseAuthorizeCallbackRequest(r *http.Request) (id string, err error) {
- if err = r.ParseForm(); err != nil {
- return "", fmt.Errorf("cannot parse form: %w", err)
- }
- id = r.Form.Get("id")
- if id == "" {
- return "", errors.New("auth request callback is missing id")
- }
- return id, nil
-}
-
// AuthResponse creates the successful authentication response (either code or tokens)
func AuthResponse(authReq AuthRequest, authorizer Authorizer, w http.ResponseWriter, r *http.Request) {
- ctx, span := tracer.Start(r.Context(), "AuthResponse")
- r = r.WithContext(ctx)
- defer span.End()
-
client, err := authorizer.Storage().GetClientByClientID(r.Context(), authReq.GetClientID())
if err != nil {
- AuthRequestError(w, r, authReq, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
return
}
if authReq.GetResponseType() == oidc.ResponseTypeCode {
@@ -483,98 +441,39 @@ func AuthResponse(authReq AuthRequest, authorizer Authorizer, w http.ResponseWri
AuthResponseToken(w, r, authReq, authorizer, client)
}
-// AuthResponseCode handles the creation of a successful authentication response using an authorization code
+// AuthResponseCode creates the successful code authentication response
func AuthResponseCode(w http.ResponseWriter, r *http.Request, authReq AuthRequest, authorizer Authorizer) {
- ctx, span := tracer.Start(r.Context(), "AuthResponseCode")
- defer span.End()
- r = r.WithContext(ctx)
-
- var err error
- if authReq.GetResponseMode() == oidc.ResponseModeFormPost {
- err = handleFormPostResponse(w, r, authReq, authorizer)
- } else {
- err = handleRedirectResponse(w, r, authReq, authorizer)
- }
-
+ code, err := CreateAuthRequestCode(r.Context(), authReq, authorizer.Storage(), authorizer.Crypto())
if err != nil {
- AuthRequestError(w, r, authReq, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
+ return
}
-}
-
-// handleFormPostResponse processes the authentication response using form post method
-func handleFormPostResponse(w http.ResponseWriter, r *http.Request, authReq AuthRequest, authorizer Authorizer) error {
- codeResponse, err := BuildAuthResponseCodeResponsePayload(r.Context(), authReq, authorizer)
+ codeResponse := struct {
+ code string
+ state string
+ }{
+ code: code,
+ state: authReq.GetState(),
+ }
+ callback, err := AuthResponseURL(authReq.GetRedirectURI(), authReq.GetResponseType(), authReq.GetResponseMode(), &codeResponse, authorizer.Encoder())
if err != nil {
- return err
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
+ return
}
- return AuthResponseFormPost(w, authReq.GetRedirectURI(), codeResponse, authorizer.Encoder())
-}
-
-// handleRedirectResponse processes the authentication response using the redirect method
-func handleRedirectResponse(w http.ResponseWriter, r *http.Request, authReq AuthRequest, authorizer Authorizer) error {
- callbackURL, err := BuildAuthResponseCallbackURL(r.Context(), authReq, authorizer)
- if err != nil {
- return err
- }
- http.Redirect(w, r, callbackURL, http.StatusFound)
- return nil
-}
-
-// BuildAuthResponseCodeResponsePayload generates the authorization code response payload for the authentication request
-func BuildAuthResponseCodeResponsePayload(ctx context.Context, authReq AuthRequest, authorizer Authorizer) (*CodeResponseType, error) {
- code, err := CreateAuthRequestCode(ctx, authReq, authorizer.Storage(), authorizer.Crypto())
- if err != nil {
- return nil, err
- }
-
- sessionState := ""
- if authRequestSessionState, ok := authReq.(AuthRequestSessionState); ok {
- sessionState = authRequestSessionState.GetSessionState()
- }
-
- return &CodeResponseType{
- Code: code,
- State: authReq.GetState(),
- SessionState: sessionState,
- }, nil
-}
-
-// BuildAuthResponseCallbackURL generates the callback URL for a successful authorization code response
-func BuildAuthResponseCallbackURL(ctx context.Context, authReq AuthRequest, authorizer Authorizer) (string, error) {
- codeResponse, err := BuildAuthResponseCodeResponsePayload(ctx, authReq, authorizer)
- if err != nil {
- return "", err
- }
-
- return AuthResponseURL(authReq.GetRedirectURI(), authReq.GetResponseType(), authReq.GetResponseMode(), codeResponse, authorizer.Encoder())
+ http.Redirect(w, r, callback, http.StatusFound)
}
// AuthResponseToken creates the successful token(s) authentication response
func AuthResponseToken(w http.ResponseWriter, r *http.Request, authReq AuthRequest, authorizer Authorizer, client Client) {
- ctx, span := tracer.Start(r.Context(), "AuthResponseToken")
- defer span.End()
- r = r.WithContext(ctx)
-
createAccessToken := authReq.GetResponseType() != oidc.ResponseTypeIDTokenOnly
resp, err := CreateTokenResponse(r.Context(), authReq, client, authorizer, createAccessToken, "", "")
if err != nil {
- AuthRequestError(w, r, authReq, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
return
}
-
- if authReq.GetResponseMode() == oidc.ResponseModeFormPost {
- err := AuthResponseFormPost(w, authReq.GetRedirectURI(), resp, authorizer.Encoder())
- if err != nil {
- AuthRequestError(w, r, authReq, err, authorizer)
- return
- }
-
- return
- }
-
callback, err := AuthResponseURL(authReq.GetRedirectURI(), authReq.GetResponseType(), authReq.GetResponseMode(), resp, authorizer.Encoder())
if err != nil {
- AuthRequestError(w, r, authReq, err, authorizer)
+ AuthRequestError(w, r, authReq, err, authorizer.Encoder())
return
}
http.Redirect(w, r, callback, http.StatusFound)
@@ -582,9 +481,6 @@ func AuthResponseToken(w http.ResponseWriter, r *http.Request, authReq AuthReque
// CreateAuthRequestCode creates and stores a code for the auth code response
func CreateAuthRequestCode(ctx context.Context, authReq AuthRequest, storage Storage, crypto Crypto) (string, error) {
- ctx, span := tracer.Start(ctx, "CreateAuthRequestCode")
- defer span.End()
-
code, err := BuildAuthRequestCode(authReq, crypto)
if err != nil {
return "", err
@@ -602,7 +498,7 @@ func BuildAuthRequestCode(authReq AuthRequest, crypto Crypto) (string, error) {
// AuthResponseURL encodes the authorization response (successful and error) and sets it as query or fragment values
// depending on the response_mode and response_type
-func AuthResponseURL(redirectURI string, responseType oidc.ResponseType, responseMode oidc.ResponseMode, response any, encoder httphelper.Encoder) (string, error) {
+func AuthResponseURL(redirectURI string, responseType oidc.ResponseType, responseMode oidc.ResponseMode, response interface{}, encoder httphelper.Encoder) (string, error) {
uri, err := url.Parse(redirectURI)
if err != nil {
return "", oidc.ErrServerError().WithParent(err)
@@ -626,43 +522,6 @@ func AuthResponseURL(redirectURI string, responseType oidc.ResponseType, respons
return mergeQueryParams(uri, params), nil
}
-//go:embed form_post.html.tmpl
-var formPostHtmlTemplate string
-
-var formPostTmpl = template.Must(template.New("form_post").Parse(formPostHtmlTemplate))
-
-// AuthResponseFormPost responds a html page that automatically submits the form which contains the auth response parameters
-func AuthResponseFormPost(res http.ResponseWriter, redirectURI string, response any, encoder httphelper.Encoder) error {
- values := make(map[string][]string)
- err := encoder.Encode(response, values)
- if err != nil {
- return oidc.ErrServerError().WithParent(err)
- }
-
- params := &struct {
- RedirectURI string
- Params any
- }{
- RedirectURI: redirectURI,
- Params: values,
- }
-
- var buf bytes.Buffer
- err = formPostTmpl.Execute(&buf, params)
- if err != nil {
- return oidc.ErrServerError().WithParent(err)
- }
-
- res.Header().Set("Cache-Control", "no-store")
- res.WriteHeader(http.StatusOK)
- _, err = buf.WriteTo(res)
- if err != nil {
- return oidc.ErrServerError().WithParent(err)
- }
-
- return nil
-}
-
func setFragment(uri *url.URL, params url.Values) string {
uri.Fragment = params.Encode()
return uri.String()
diff --git a/pkg/op/auth_request_test.go b/pkg/op/auth_request_test.go
index d1ea965..dc6f655 100644
--- a/pkg/op/auth_request_test.go
+++ b/pkg/op/auth_request_test.go
@@ -3,54 +3,76 @@ package op_test
import (
"context"
"errors"
- "io"
- "log/slog"
"net/http"
"net/http/httptest"
"net/url"
"reflect"
"testing"
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/storage"
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op/mock"
- "github.com/golang/mock/gomock"
+ "github.com/gorilla/schema"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
- "github.com/zitadel/schema"
+
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/op"
+ "github.com/zitadel/oidc/pkg/op/mock"
)
-func TestAuthorize(t *testing.T) {
- tests := []struct {
- name string
- req *http.Request
- expect func(a *mock.MockAuthorizerMockRecorder)
- }{
- {
- name: "parse error", // used to panic, see issue #315
- req: httptest.NewRequest(http.MethodPost, "/?;", nil),
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- w := httptest.NewRecorder()
- authorizer := mock.NewMockAuthorizer(gomock.NewController(t))
-
- expect := authorizer.EXPECT()
- expect.Decoder().Return(schema.NewDecoder())
- expect.Logger().Return(slog.Default())
-
- if tt.expect != nil {
- tt.expect(expect)
- }
-
- op.Authorize(w, tt.req, authorizer)
- })
- }
-}
+//
+// TOOD: tests will be implemented in branch for service accounts
+// func TestAuthorize(t *testing.T) {
+// // testCallback := func(t *testing.T, clienID string) callbackHandler {
+// // return func(authReq *oidc.AuthRequest, client oidc.Client, w http.ResponseWriter, r *http.Request) {
+// // // require.Equal(t, clientID, client.)
+// // }
+// // }
+// // testErr := func(t *testing.T, expected error) errorHandler {
+// // return func(w http.ResponseWriter, r *http.Request, authReq *oidc.AuthRequest, err error) {
+// // require.Equal(t, expected, err)
+// // }
+// // }
+// type args struct {
+// w http.ResponseWriter
+// r *http.Request
+// authorizer op.Authorizer
+// }
+// tests := []struct {
+// name string
+// args args
+// }{
+// {
+// "parsing fails",
+// args{
+// httptest.NewRecorder(),
+// &http.Request{Method: "POST", Body: nil},
+// mock.NewAuthorizerExpectValid(t, true),
+// // testCallback(t, ""),
+// // testErr(t, ErrInvalidRequest("cannot parse form")),
+// },
+// },
+// {
+// "decoding fails",
+// args{
+// httptest.NewRecorder(),
+// func() *http.Request {
+// r := httptest.NewRequest("POST", "/authorize", strings.NewReader("client_id=foo"))
+// r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
+// return r
+// }(),
+// mock.NewAuthorizerExpectValid(t, true),
+// // testCallback(t, ""),
+// // testErr(t, ErrInvalidRequest("cannot parse auth request")),
+// },
+// },
+// // {"decoding fails", args{httptest.NewRecorder(), &http.Request{}, mock.NewAuthorizerExpectValid(t), nil, testErr(t, nil)}},
+// }
+// for _, tt := range tests {
+// t.Run(tt.name, func(t *testing.T) {
+// op.Authorize(tt.args.w, tt.args.r, tt.args.authorizer)
+// })
+// }
+//}
func TestParseAuthorizeRequest(t *testing.T) {
type args struct {
@@ -125,7 +147,7 @@ func TestValidateAuthRequest(t *testing.T) {
type args struct {
authRequest *oidc.AuthRequest
storage op.Storage
- verifier *op.IDTokenHintVerifier
+ verifier op.IDTokenHintVerifier
}
tests := []struct {
name string
@@ -137,6 +159,11 @@ func TestValidateAuthRequest(t *testing.T) {
args{&oidc.AuthRequest{}, mock.NewMockStorageExpectValidClientID(t), nil},
oidc.ErrInvalidRequest(),
},
+ {
+ "scope openid missing fails",
+ args{&oidc.AuthRequest{Scopes: []string{"profile"}}, mock.NewMockStorageExpectValidClientID(t), nil},
+ oidc.ErrInvalidScope(),
+ },
{
"response_type missing fails",
args{&oidc.AuthRequest{Scopes: []string{"openid"}}, mock.NewMockStorageExpectValidClientID(t), nil},
@@ -282,6 +309,16 @@ func TestValidateAuthReqScopes(t *testing.T) {
err: true,
},
},
+ {
+ "scope openid missing fails",
+ args{
+ mock.NewClientExpectAny(t, op.ApplicationTypeWeb),
+ []string{"email"},
+ },
+ res{
+ err: true,
+ },
+ },
{
"scope ok",
args{
@@ -433,24 +470,6 @@ func TestValidateAuthReqRedirectURI(t *testing.T) {
},
false,
},
- {
- "code flow registered https loopback v4 native ok",
- args{
- "https://127.0.0.1:4200/callback",
- mock.NewClientWithConfig(t, []string{"https://127.0.0.1/callback"}, op.ApplicationTypeNative, nil, false),
- oidc.ResponseTypeCode,
- },
- false,
- },
- {
- "code flow registered https loopback v6 native ok",
- args{
- "https://[::1]:4200/callback",
- mock.NewClientWithConfig(t, []string{"https://[::1]/callback"}, op.ApplicationTypeNative, nil, false),
- oidc.ResponseTypeCode,
- },
- false,
- },
{
"code flow unregistered http native fails",
args{
@@ -586,60 +605,6 @@ func TestValidateAuthReqRedirectURI(t *testing.T) {
},
false,
},
- {
- "code flow dev mode has redirect globs regular ok",
- args{
- "http://registered.com/callback",
- mock.NewHasRedirectGlobsWithConfig(t, []string{"http://registered.com/*"}, op.ApplicationTypeUserAgent, nil, true),
- oidc.ResponseTypeCode,
- },
- false,
- },
- {
- "code flow dev mode has redirect globs wildcard ok",
- args{
- "http://registered.com/callback",
- mock.NewHasRedirectGlobsWithConfig(t, []string{"http://registered.com/*"}, op.ApplicationTypeUserAgent, nil, true),
- oidc.ResponseTypeCode,
- },
- false,
- },
- {
- "code flow dev mode has redirect globs double star ok",
- args{
- "http://registered.com/callback",
- mock.NewHasRedirectGlobsWithConfig(t, []string{"http://**/*"}, op.ApplicationTypeUserAgent, nil, true),
- oidc.ResponseTypeCode,
- },
- false,
- },
- {
- "code flow dev mode has redirect globs double star ok",
- args{
- "http://registered.com/callback",
- mock.NewHasRedirectGlobsWithConfig(t, []string{"http://**/*"}, op.ApplicationTypeUserAgent, nil, true),
- oidc.ResponseTypeCode,
- },
- false,
- },
- {
- "code flow dev mode has redirect globs IPv6 ok",
- args{
- "http://[::1]:80/callback",
- mock.NewHasRedirectGlobsWithConfig(t, []string{"http://\\[::1\\]:80/*"}, op.ApplicationTypeUserAgent, nil, true),
- oidc.ResponseTypeCode,
- },
- false,
- },
- {
- "code flow dev mode has redirect globs bad pattern",
- args{
- "http://registered.com/callback",
- mock.NewHasRedirectGlobsWithConfig(t, []string{"http://**/\\"}, op.ApplicationTypeUserAgent, nil, true),
- oidc.ResponseTypeCode,
- },
- true,
- },
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@@ -804,7 +769,7 @@ func TestAuthResponseURL(t *testing.T) {
redirectURI string
responseType oidc.ResponseType
responseMode oidc.ResponseMode
- response any
+ response interface{}
encoder httphelper.Encoder
}
type res struct {
@@ -822,7 +787,7 @@ func TestAuthResponseURL(t *testing.T) {
"uri",
oidc.ResponseTypeCode,
"",
- map[string]any{"test": "test"},
+ map[string]interface{}{"test": "test"},
&mockEncoder{
errors.New("error encoding"),
},
@@ -993,7 +958,7 @@ type mockEncoder struct {
err error
}
-func (m *mockEncoder) Encode(src any, dst map[string][]string) error {
+func (m *mockEncoder) Encode(src interface{}, dst map[string][]string) error {
if m.err != nil {
return m.err
}
@@ -1002,611 +967,3 @@ func (m *mockEncoder) Encode(src any, dst map[string][]string) error {
}
return nil
}
-
-// mockCrypto implements the op.Crypto interface
-// and in always equals out. (It doesn't crypt anything).
-// When returnErr != nil, that error is always returned instread.
-type mockCrypto struct {
- returnErr error
-}
-
-func (c *mockCrypto) Encrypt(s string) (string, error) {
- if c.returnErr != nil {
- return "", c.returnErr
- }
- return s, nil
-}
-
-func (c *mockCrypto) Decrypt(s string) (string, error) {
- if c.returnErr != nil {
- return "", c.returnErr
- }
- return s, nil
-}
-
-func TestAuthResponseCode(t *testing.T) {
- type args struct {
- authReq op.AuthRequest
- authorizer func(*testing.T) op.Authorizer
- }
- type res struct {
- wantCode int
- wantLocationHeader string
- wantCacheControlHeader string
- wantBody string
- }
- tests := []struct {
- name string
- args args
- res res
- }{
- {
- name: "create code error",
- args: args{
- authReq: &storage.AuthRequest{
- ID: "id1",
- TransferState: "state1",
- },
- authorizer: func(t *testing.T) op.Authorizer {
- ctrl := gomock.NewController(t)
- storage := mock.NewMockStorage(ctrl)
-
- authorizer := mock.NewMockAuthorizer(ctrl)
- authorizer.EXPECT().Storage().Return(storage)
- authorizer.EXPECT().Crypto().Return(&mockCrypto{
- returnErr: io.ErrClosedPipe,
- })
- authorizer.EXPECT().Logger().Return(slog.Default())
- return authorizer
- },
- },
- res: res{
- wantCode: http.StatusBadRequest,
- wantBody: "io: read/write on closed pipe\n",
- },
- },
- {
- name: "success with state",
- args: args{
- authReq: &storage.AuthRequest{
- ID: "id1",
- TransferState: "state1",
- },
- authorizer: func(t *testing.T) op.Authorizer {
- ctrl := gomock.NewController(t)
- storage := mock.NewMockStorage(ctrl)
- storage.EXPECT().SaveAuthCode(gomock.Any(), "id1", "id1")
-
- authorizer := mock.NewMockAuthorizer(ctrl)
- authorizer.EXPECT().Storage().Return(storage)
- authorizer.EXPECT().Crypto().Return(&mockCrypto{})
- authorizer.EXPECT().Encoder().Return(schema.NewEncoder())
- return authorizer
- },
- },
- res: res{
- wantCode: http.StatusFound,
- wantLocationHeader: "/auth/callback/?code=id1&state=state1",
- wantBody: "",
- },
- },
- {
- name: "success with state and session_state",
- args: args{
- authReq: &storage.AuthRequestWithSessionState{
- AuthRequest: &storage.AuthRequest{
- ID: "id1",
- TransferState: "state1",
- },
- SessionState: "session_state1",
- },
- authorizer: func(t *testing.T) op.Authorizer {
- ctrl := gomock.NewController(t)
- storage := mock.NewMockStorage(ctrl)
- storage.EXPECT().SaveAuthCode(gomock.Any(), "id1", "id1")
-
- authorizer := mock.NewMockAuthorizer(ctrl)
- authorizer.EXPECT().Storage().Return(storage)
- authorizer.EXPECT().Crypto().Return(&mockCrypto{})
- authorizer.EXPECT().Encoder().Return(schema.NewEncoder())
- return authorizer
- },
- },
- res: res{
- wantCode: http.StatusFound,
- wantLocationHeader: "/auth/callback/?code=id1&session_state=session_state1&state=state1",
- wantBody: "",
- },
- },
- {
- name: "success without state", // reproduce issue #415
- args: args{
- authReq: &storage.AuthRequest{
- ID: "id1",
- TransferState: "",
- },
- authorizer: func(t *testing.T) op.Authorizer {
- ctrl := gomock.NewController(t)
- storage := mock.NewMockStorage(ctrl)
- storage.EXPECT().SaveAuthCode(gomock.Any(), "id1", "id1")
-
- authorizer := mock.NewMockAuthorizer(ctrl)
- authorizer.EXPECT().Storage().Return(storage)
- authorizer.EXPECT().Crypto().Return(&mockCrypto{})
- authorizer.EXPECT().Encoder().Return(schema.NewEncoder())
- return authorizer
- },
- },
- res: res{
- wantCode: http.StatusFound,
- wantLocationHeader: "/auth/callback/?code=id1",
- wantBody: "",
- },
- },
- {
- name: "success form_post",
- args: args{
- authReq: &storage.AuthRequest{
- ID: "id1",
- CallbackURI: "https://example.com/callback",
- TransferState: "state1",
- ResponseMode: "form_post",
- },
- authorizer: func(t *testing.T) op.Authorizer {
- ctrl := gomock.NewController(t)
- storage := mock.NewMockStorage(ctrl)
- storage.EXPECT().SaveAuthCode(gomock.Any(), "id1", "id1")
-
- authorizer := mock.NewMockAuthorizer(ctrl)
- authorizer.EXPECT().Storage().Return(storage)
- authorizer.EXPECT().Crypto().Return(&mockCrypto{})
- authorizer.EXPECT().Encoder().Return(schema.NewEncoder())
- return authorizer
- },
- },
- res: res{
- wantCode: http.StatusOK,
- wantCacheControlHeader: "no-store",
- wantBody: "\n\n;for=;host=;proto=
- {
- "forwarded header without host",
- args{
- path: "/custom/",
- target: "https://issuer.com",
- header: map[string][]string{"Forwarded": {
- `by=identifier;for=identifier;proto=https`,
- }},
- },
- res{
- issuer: "https://issuer.com/custom/",
- },
- },
- {
- "forwarded header with host",
- args{
- path: "/custom/",
- target: "https://issuer.com",
- header: map[string][]string{"Forwarded": {
- `by=identifier;for=identifier;host=first.com;proto=https`,
- }},
- },
- res{
- issuer: "https://first.com/custom/",
- },
- },
- {
- "forwarded header with multiple hosts",
- args{
- path: "/custom/",
- target: "https://issuer.com",
- header: map[string][]string{"Forwarded": {
- `by=identifier;for=identifier;host=first.com;proto=https,host=second.com`,
- }},
- },
- res{
- issuer: "https://first.com/custom/",
- },
- },
- {
- "multiple forwarded headers hosts",
- args{
- path: "/custom/",
- target: "https://issuer.com",
- header: map[string][]string{"Forwarded": {
- `by=identifier;for=identifier;host=first.com;proto=https,host=second.com`,
- `by=identifier;for=identifier;host=third.com;proto=https`,
- }},
- },
- res{
- issuer: "https://first.com/custom/",
- },
- },
- {
- "custom header first",
- args{
- path: "/custom/",
- target: "https://issuer.com",
- header: map[string][]string{
- "Forwarded": {
- `by=identifier;for=identifier;host=first.com;proto=https,host=second.com`,
- `by=identifier;for=identifier;host=third.com;proto=https`,
- },
- "X-Custom-Forwarded": {
- `by=identifier;for=identifier;host=custom.com;proto=https,host=custom2.com`,
- },
- },
- opts: []IssuerFromOption{
- WithIssuerFromCustomHeaders("x-custom-forwarded"),
- },
- },
- res{
- issuer: "https://custom.com/custom/",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- issuer, err := IssuerFromForwardedOrHost(tt.args.path, tt.args.opts...)(false)
- require.NoError(t, err)
- req := httptest.NewRequest("", tt.args.target, nil)
- for k, v := range tt.args.header {
- req.Header[http.CanonicalHeaderKey(k)] = v
- }
- assert.Equal(t, tt.res.issuer, issuer(req))
- })
- }
-}
-
-func TestStaticIssuer(t *testing.T) {
- type args struct {
- issuer string
- allowInsecure bool
- }
- type res struct {
- issuer string
- err error
- }
- tests := []struct {
- name string
- args args
- res res
- }{
- {
- "invalid issuer",
- args{
- issuer: "",
- allowInsecure: false,
- },
- res{
- issuer: "",
- err: ErrInvalidIssuerNoIssuer,
- },
- },
- {
- "empty path secure",
- args{
- issuer: "https://issuer.com",
- allowInsecure: false,
- },
- res{
- issuer: "https://issuer.com",
- err: nil,
- },
- },
- {
- "custom path secure",
- args{
- issuer: "https://issuer.com/custom/",
- allowInsecure: false,
- },
- res{
- issuer: "https://issuer.com/custom/",
- err: nil,
- },
- },
- {
- "unsecure",
- args{
- issuer: "http://issuer.com",
- allowInsecure: true,
- },
- res{
- issuer: "http://issuer.com",
- err: nil,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- issuer, err := StaticIssuer(tt.args.issuer)(tt.args.allowInsecure)
- if tt.res.err == nil {
- assert.NoError(t, err)
- assert.Equal(t, tt.res.issuer, issuer(nil))
- }
- if tt.res.err != nil {
- assert.ErrorIs(t, err, tt.res.err)
+ if err := ValidateIssuer(tt.args.issuer); (err != nil) != tt.wantErr {
+ t.Errorf("ValidateIssuer() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
diff --git a/pkg/op/context.go b/pkg/op/context.go
deleted file mode 100644
index 7cff5a7..0000000
--- a/pkg/op/context.go
+++ /dev/null
@@ -1,53 +0,0 @@
-package op
-
-import (
- "context"
- "net/http"
-)
-
-type key int
-
-const (
- issuerKey key = 0
-)
-
-type IssuerInterceptor struct {
- issuerFromRequest IssuerFromRequest
-}
-
-// NewIssuerInterceptor will set the issuer into the context
-// by the provided IssuerFromRequest (e.g. returned from StaticIssuer or IssuerFromHost)
-func NewIssuerInterceptor(issuerFromRequest IssuerFromRequest) *IssuerInterceptor {
- return &IssuerInterceptor{
- issuerFromRequest: issuerFromRequest,
- }
-}
-
-func (i *IssuerInterceptor) Handler(next http.Handler) http.Handler {
- return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- i.setIssuerCtx(w, r, next)
- })
-}
-
-func (i *IssuerInterceptor) HandlerFunc(next http.HandlerFunc) http.HandlerFunc {
- return func(w http.ResponseWriter, r *http.Request) {
- i.setIssuerCtx(w, r, next)
- }
-}
-
-// IssuerFromContext reads the issuer from the context (set by an IssuerInterceptor)
-// it will return an empty string if not found
-func IssuerFromContext(ctx context.Context) string {
- ctxIssuer, _ := ctx.Value(issuerKey).(string)
- return ctxIssuer
-}
-
-// ContextWithIssuer returns a new context with issuer set to it.
-func ContextWithIssuer(ctx context.Context, issuer string) context.Context {
- return context.WithValue(ctx, issuerKey, issuer)
-}
-
-func (i *IssuerInterceptor) setIssuerCtx(w http.ResponseWriter, r *http.Request, next http.Handler) {
- r = r.WithContext(ContextWithIssuer(r.Context(), i.issuerFromRequest(r)))
- next.ServeHTTP(w, r)
-}
diff --git a/pkg/op/context_test.go b/pkg/op/context_test.go
deleted file mode 100644
index e6bfcec..0000000
--- a/pkg/op/context_test.go
+++ /dev/null
@@ -1,76 +0,0 @@
-package op
-
-import (
- "net/http"
- "net/http/httptest"
- "testing"
-
- "github.com/stretchr/testify/assert"
-)
-
-func TestIssuerInterceptor(t *testing.T) {
- type fields struct {
- issuerFromRequest IssuerFromRequest
- }
- type args struct {
- r *http.Request
- next http.Handler
- }
- type res struct {
- issuer string
- }
- tests := []struct {
- name string
- fields fields
- args args
- res res
- }{
- {
- "empty",
- fields{
- func(r *http.Request) string {
- return ""
- },
- },
- args{},
- res{
- issuer: "",
- },
- },
- {
- "static",
- fields{
- func(r *http.Request) string {
- return "static"
- },
- },
- args{},
- res{
- issuer: "static",
- },
- },
- {
- "host",
- fields{
- func(r *http.Request) string {
- return r.Host
- },
- },
- args{},
- res{
- issuer: "issuer.com",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- i := NewIssuerInterceptor(tt.fields.issuerFromRequest)
- next := http.HandlerFunc(func(_ http.ResponseWriter, r *http.Request) {
- assert.Equal(t, tt.res.issuer, IssuerFromContext(r.Context()))
- })
- req := httptest.NewRequest("", "https://issuer.com", nil)
- i.Handler(next).ServeHTTP(nil, req)
- i.HandlerFunc(next).ServeHTTP(nil, req)
- })
- }
-}
diff --git a/pkg/op/crypto.go b/pkg/op/crypto.go
index 01aaad3..f14b1de 100644
--- a/pkg/op/crypto.go
+++ b/pkg/op/crypto.go
@@ -1,7 +1,7 @@
package op
import (
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/crypto"
+ "github.com/zitadel/oidc/pkg/crypto"
)
type Crypto interface {
diff --git a/pkg/op/device.go b/pkg/op/device.go
deleted file mode 100644
index 866cbc4..0000000
--- a/pkg/op/device.go
+++ /dev/null
@@ -1,359 +0,0 @@
-package op
-
-import (
- "context"
- "crypto/rand"
- "encoding/base64"
- "errors"
- "fmt"
- "math/big"
- "net/http"
- "net/url"
- "slices"
- "strings"
- "time"
-
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
-)
-
-type DeviceAuthorizationConfig struct {
- Lifetime time.Duration
- PollInterval time.Duration
-
- // UserFormURL is the complete URL where the user must go to authorize the device.
- // Deprecated: use UserFormPath instead.
- UserFormURL string
-
- // UserFormPath is the path where the user must go to authorize the device.
- // The hostname for the URL is taken from the request by IssuerFromContext.
- UserFormPath string
- UserCode UserCodeConfig
-}
-
-type UserCodeConfig struct {
- CharSet string
- CharAmount int
- DashInterval int
-}
-
-const (
- CharSetBase20 = "BCDFGHJKLMNPQRSTVWXZ"
- CharSetDigits = "0123456789"
-)
-
-var (
- UserCodeBase20 = UserCodeConfig{
- CharSet: CharSetBase20,
- CharAmount: 8,
- DashInterval: 4,
- }
- UserCodeDigits = UserCodeConfig{
- CharSet: CharSetDigits,
- CharAmount: 9,
- DashInterval: 3,
- }
-)
-
-func DeviceAuthorizationHandler(o OpenIDProvider) func(http.ResponseWriter, *http.Request) {
- return func(w http.ResponseWriter, r *http.Request) {
- if err := DeviceAuthorization(w, r, o); err != nil {
- RequestError(w, r, err, o.Logger())
- }
- }
-}
-
-func DeviceAuthorization(w http.ResponseWriter, r *http.Request, o OpenIDProvider) error {
- ctx, span := tracer.Start(r.Context(), "DeviceAuthorization")
- r = r.WithContext(ctx)
- defer span.End()
-
- req, err := ParseDeviceCodeRequest(r, o)
- if err != nil {
- return err
- }
- response, err := createDeviceAuthorization(r.Context(), req, req.ClientID, o)
- if err != nil {
- return err
- }
-
- httphelper.MarshalJSON(w, response)
- return nil
-}
-
-func createDeviceAuthorization(ctx context.Context, req *oidc.DeviceAuthorizationRequest, clientID string, o OpenIDProvider) (*oidc.DeviceAuthorizationResponse, error) {
- ctx, span := tracer.Start(ctx, "createDeviceAuthorization")
- defer span.End()
-
- storage, err := assertDeviceStorage(o.Storage())
- if err != nil {
- return nil, err
- }
- config := o.DeviceAuthorization()
-
- deviceCode, _ := NewDeviceCode(RecommendedDeviceCodeBytes)
- userCode, err := NewUserCode([]rune(config.UserCode.CharSet), config.UserCode.CharAmount, config.UserCode.DashInterval)
- if err != nil {
- return nil, NewStatusError(err, http.StatusInternalServerError)
- }
-
- expires := time.Now().Add(config.Lifetime)
- err = storage.StoreDeviceAuthorization(ctx, clientID, deviceCode, userCode, expires, req.Scopes)
- if err != nil {
- return nil, NewStatusError(err, http.StatusInternalServerError)
- }
-
- var verification *url.URL
- if config.UserFormURL != "" {
- if verification, err = url.Parse(config.UserFormURL); err != nil {
- err = oidc.ErrServerError().WithParent(err).WithDescription("invalid URL for device user form")
- return nil, NewStatusError(err, http.StatusInternalServerError)
- }
- } else {
- if verification, err = url.Parse(IssuerFromContext(ctx)); err != nil {
- err = oidc.ErrServerError().WithParent(err).WithDescription("invalid URL for issuer")
- return nil, NewStatusError(err, http.StatusInternalServerError)
- }
- verification.Path = config.UserFormPath
- }
-
- response := &oidc.DeviceAuthorizationResponse{
- DeviceCode: deviceCode,
- UserCode: userCode,
- VerificationURI: verification.String(),
- ExpiresIn: int(config.Lifetime / time.Second),
- Interval: int(config.PollInterval / time.Second),
- }
-
- verification.RawQuery = "user_code=" + userCode
- response.VerificationURIComplete = verification.String()
- return response, nil
-}
-
-func ParseDeviceCodeRequest(r *http.Request, o OpenIDProvider) (*oidc.DeviceAuthorizationRequest, error) {
- ctx, span := tracer.Start(r.Context(), "ParseDeviceCodeRequest")
- r = r.WithContext(ctx)
- defer span.End()
-
- clientID, _, err := ClientIDFromRequest(r, o)
- if err != nil {
- return nil, err
- }
- client, err := o.Storage().GetClientByClientID(r.Context(), clientID)
- if err != nil {
- return nil, err
- }
- if !ValidateGrantType(client, oidc.GrantTypeDeviceCode) {
- return nil, oidc.ErrUnauthorizedClient().WithDescription("client missing grant type " + string(oidc.GrantTypeCode))
- }
-
- req := new(oidc.DeviceAuthorizationRequest)
- if err := o.Decoder().Decode(req, r.Form); err != nil {
- return nil, oidc.ErrInvalidRequest().WithDescription("cannot parse device authentication request").WithParent(err)
- }
- req.ClientID = clientID
-
- return req, nil
-}
-
-// 16 bytes gives 128 bit of entropy.
-// results in a 22 character base64 encoded string.
-const RecommendedDeviceCodeBytes = 16
-
-// NewDeviceCode generates a new cryptographically secure device code as a base64 encoded string.
-// The length of the string is nBytes * 4 / 3.
-// An error is never returned.
-//
-// TODO(v4): change return type to string alone.
-func NewDeviceCode(nBytes int) (string, error) {
- bytes := make([]byte, nBytes)
- rand.Read(bytes)
- return base64.RawURLEncoding.EncodeToString(bytes), nil
-}
-
-func NewUserCode(charSet []rune, charAmount, dashInterval int) (string, error) {
- var buf strings.Builder
- if dashInterval > 0 {
- buf.Grow(charAmount + charAmount/dashInterval - 1)
- } else {
- buf.Grow(charAmount)
- }
-
- max := big.NewInt(int64(len(charSet)))
-
- for i := 0; i < charAmount; i++ {
- if dashInterval != 0 && i != 0 && i%dashInterval == 0 {
- buf.WriteByte('-')
- }
-
- bi, err := rand.Int(rand.Reader, max)
- if err != nil {
- return "", fmt.Errorf("%w getting entropy for user code", err)
- }
-
- buf.WriteRune(charSet[int(bi.Int64())])
- }
-
- return buf.String(), nil
-}
-
-func DeviceAccessToken(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
- ctx, span := tracer.Start(r.Context(), "DeviceAccessToken")
- defer span.End()
- r = r.WithContext(ctx)
-
- if err := deviceAccessToken(w, r, exchanger); err != nil {
- RequestError(w, r, err, exchanger.Logger())
- }
-}
-
-func deviceAccessToken(w http.ResponseWriter, r *http.Request, exchanger Exchanger) error {
- // use a limited context timeout shorter as the default
- // poll interval of 5 seconds.
- ctx, cancel := context.WithTimeout(r.Context(), 4*time.Second)
- defer cancel()
- r = r.WithContext(ctx)
-
- clientID, clientAuthenticated, err := ClientIDFromRequest(r, exchanger)
- if err != nil {
- return err
- }
-
- req, err := ParseDeviceAccessTokenRequest(r, exchanger)
- if err != nil {
- return err
- }
- tokenRequest, err := CheckDeviceAuthorizationState(ctx, clientID, req.DeviceCode, exchanger)
- if err != nil {
- return err
- }
-
- client, err := exchanger.Storage().GetClientByClientID(ctx, clientID)
- if err != nil {
- return err
- }
- if clientAuthenticated != IsConfidentialType(client) {
- return oidc.ErrInvalidClient().WithParent(ErrNoClientCredentials).
- WithDescription("confidential client requires authentication")
- }
-
- resp, err := CreateDeviceTokenResponse(r.Context(), tokenRequest, exchanger, client)
- if err != nil {
- return err
- }
-
- httphelper.MarshalJSON(w, resp)
- return nil
-}
-
-func ParseDeviceAccessTokenRequest(r *http.Request, exchanger Exchanger) (*oidc.DeviceAccessTokenRequest, error) {
- req := new(oidc.DeviceAccessTokenRequest)
- if err := exchanger.Decoder().Decode(req, r.PostForm); err != nil {
- return nil, err
- }
- return req, nil
-}
-
-// DeviceAuthorizationState describes the current state of
-// the device authorization flow.
-// It implements the [IDTokenRequest] interface.
-type DeviceAuthorizationState struct {
- ClientID string
- Audience []string
- Scopes []string
- Expires time.Time // The time after we consider the authorization request timed-out
- Done bool // The user authenticated and approved the authorization request
- Denied bool // The user authenticated and denied the authorization request
-
- // The following fields are populated after Done == true
- Subject string
- AMR []string
- AuthTime time.Time
-}
-
-func (r *DeviceAuthorizationState) GetAMR() []string {
- return r.AMR
-}
-
-func (r *DeviceAuthorizationState) GetAudience() []string {
- if !slices.Contains(r.Audience, r.ClientID) {
- r.Audience = append(r.Audience, r.ClientID)
- }
- return r.Audience
-}
-
-func (r *DeviceAuthorizationState) GetAuthTime() time.Time {
- return r.AuthTime
-}
-
-func (r *DeviceAuthorizationState) GetClientID() string {
- return r.ClientID
-}
-
-func (r *DeviceAuthorizationState) GetScopes() []string {
- return r.Scopes
-}
-
-func (r *DeviceAuthorizationState) GetSubject() string {
- return r.Subject
-}
-
-func CheckDeviceAuthorizationState(ctx context.Context, clientID, deviceCode string, exchanger Exchanger) (*DeviceAuthorizationState, error) {
- ctx, span := tracer.Start(ctx, "CheckDeviceAuthorizationState")
- defer span.End()
-
- storage, err := assertDeviceStorage(exchanger.Storage())
- if err != nil {
- return nil, err
- }
-
- state, err := storage.GetDeviceAuthorizatonState(ctx, clientID, deviceCode)
- if errors.Is(err, context.DeadlineExceeded) {
- return nil, oidc.ErrSlowDown().WithParent(err)
- }
- if err != nil {
- return nil, oidc.ErrAccessDenied().WithParent(err)
- }
- if state.Denied {
- return state, oidc.ErrAccessDenied()
- }
- if state.Done {
- return state, nil
- }
- if time.Now().After(state.Expires) {
- return state, oidc.ErrExpiredDeviceCode()
- }
- return state, oidc.ErrAuthorizationPending()
-}
-
-func CreateDeviceTokenResponse(ctx context.Context, tokenRequest TokenRequest, creator TokenCreator, client Client) (*oidc.AccessTokenResponse, error) {
- /* TODO(v4):
- Change the TokenRequest argument type to *DeviceAuthorizationState.
- Breaking change that can not be done for v3.
- */
- ctx, span := tracer.Start(ctx, "CreateDeviceTokenResponse")
- defer span.End()
-
- accessToken, refreshToken, validity, err := CreateAccessToken(ctx, tokenRequest, client.AccessTokenType(), creator, client, "")
- if err != nil {
- return nil, err
- }
-
- response := &oidc.AccessTokenResponse{
- AccessToken: accessToken,
- RefreshToken: refreshToken,
- TokenType: oidc.BearerToken,
- ExpiresIn: uint64(validity.Seconds()),
- Scope: tokenRequest.GetScopes(),
- }
-
- // TODO(v4): remove type assertion
- if idTokenRequest, ok := tokenRequest.(IDTokenRequest); ok && slices.Contains(tokenRequest.GetScopes(), oidc.ScopeOpenID) {
- response.IDToken, err = CreateIDToken(ctx, IssuerFromContext(ctx), idTokenRequest, client.IDTokenLifetime(), accessToken, "", creator.Storage(), client)
- if err != nil {
- return nil, err
- }
- }
-
- return response, nil
-}
diff --git a/pkg/op/device_test.go b/pkg/op/device_test.go
deleted file mode 100644
index a7b5c4e..0000000
--- a/pkg/op/device_test.go
+++ /dev/null
@@ -1,538 +0,0 @@
-package op_test
-
-import (
- "context"
- "crypto/rand"
- "encoding/base64"
- "io"
- mr "math/rand"
- "net/http"
- "net/http/httptest"
- "net/url"
- "strings"
- "testing"
- "time"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/example/server/storage"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "github.com/muhlemmer/gu"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func Test_deviceAuthorizationHandler(t *testing.T) {
- type conf struct {
- UserFormURL string
- UserFormPath string
- }
- tests := []struct {
- name string
- conf conf
- }{
- {
- name: "UserFormURL",
- conf: conf{
- UserFormURL: "https://localhost:9998/device",
- },
- },
- {
- name: "UserFormPath",
- conf: conf{
- UserFormPath: "/device",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- conf := gu.PtrCopy(testConfig)
- conf.DeviceAuthorization.UserFormURL = tt.conf.UserFormURL
- conf.DeviceAuthorization.UserFormPath = tt.conf.UserFormPath
- provider := newTestProvider(conf)
-
- req := &oidc.DeviceAuthorizationRequest{
- Scopes: []string{"foo", "bar"},
- ClientID: "device",
- }
- values := make(url.Values)
- testProvider.Encoder().Encode(req, values)
- body := strings.NewReader(values.Encode())
-
- r := httptest.NewRequest(http.MethodPost, "/", body)
- r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
- r = r.WithContext(op.ContextWithIssuer(r.Context(), testIssuer))
-
- w := httptest.NewRecorder()
-
- runWithRandReader(mr.New(mr.NewSource(1)), func() {
- op.DeviceAuthorizationHandler(provider)(w, r)
- })
-
- result := w.Result()
-
- assert.Less(t, result.StatusCode, 300)
-
- got, _ := io.ReadAll(result.Body)
- assert.JSONEq(t, `{"device_code":"Uv38ByGCZU8WP18PmmIdcg", "expires_in":300, "interval":5, "user_code":"JKRV-FRGK", "verification_uri":"https://localhost:9998/device", "verification_uri_complete":"https://localhost:9998/device?user_code=JKRV-FRGK"}`, string(got))
- })
- }
-}
-
-func TestParseDeviceCodeRequest(t *testing.T) {
- tests := []struct {
- name string
- req *oidc.DeviceAuthorizationRequest
- wantErr bool
- }{
- {
- name: "empty request",
- wantErr: true,
- },
- {
- name: "missing grant type",
- req: &oidc.DeviceAuthorizationRequest{
- Scopes: oidc.SpaceDelimitedArray{"foo", "bar"},
- ClientID: "web",
- },
- wantErr: true,
- },
- {
- name: "client not found",
- req: &oidc.DeviceAuthorizationRequest{
- Scopes: oidc.SpaceDelimitedArray{"foo", "bar"},
- ClientID: "foobar",
- },
- wantErr: true,
- },
- {
- name: "success",
- req: &oidc.DeviceAuthorizationRequest{
- Scopes: oidc.SpaceDelimitedArray{"foo", "bar"},
- ClientID: "device",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- var body io.Reader
- if tt.req != nil {
- values := make(url.Values)
- testProvider.Encoder().Encode(tt.req, values)
- body = strings.NewReader(values.Encode())
- }
-
- r := httptest.NewRequest(http.MethodPost, "/", body)
- r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
-
- got, err := op.ParseDeviceCodeRequest(r, testProvider)
- if tt.wantErr {
- require.Error(t, err)
- return
- }
- assert.Equal(t, tt.req, got)
- })
- }
-}
-
-func runWithRandReader(r io.Reader, f func()) {
- originalReader := rand.Reader
- rand.Reader = r
- defer func() {
- rand.Reader = originalReader
- }()
-
- f()
-}
-
-func TestNewDeviceCode(t *testing.T) {
- for i := 1; i <= 32; i++ {
- got, err := op.NewDeviceCode(i)
- require.NoError(t, err)
- assert.Len(t, got, base64.RawURLEncoding.EncodedLen(i))
- }
-}
-
-func TestNewUserCode(t *testing.T) {
- type args struct {
- charset []rune
- charAmount int
- dashInterval int
- }
- tests := []struct {
- name string
- args args
- reader io.Reader
- want string
- wantErr bool
- }{
- {
- name: "reader error",
- args: args{
- charset: []rune(op.CharSetBase20),
- charAmount: 8,
- dashInterval: 4,
- },
- reader: errReader{},
- wantErr: true,
- },
- {
- name: "base20",
- args: args{
- charset: []rune(op.CharSetBase20),
- charAmount: 8,
- dashInterval: 4,
- },
- reader: mr.New(mr.NewSource(1)),
- want: "XKCD-HTTD",
- },
- {
- name: "digits",
- args: args{
- charset: []rune(op.CharSetDigits),
- charAmount: 9,
- dashInterval: 3,
- },
- reader: mr.New(mr.NewSource(1)),
- want: "271-256-225",
- },
- {
- name: "no dashes",
- args: args{
- charset: []rune(op.CharSetDigits),
- charAmount: 9,
- },
- reader: mr.New(mr.NewSource(1)),
- want: "271256225",
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- runWithRandReader(tt.reader, func() {
- got, err := op.NewUserCode(tt.args.charset, tt.args.charAmount, tt.args.dashInterval)
- if tt.wantErr {
- require.ErrorIs(t, err, io.ErrNoProgress)
- } else {
- require.NoError(t, err)
- }
- assert.Equal(t, tt.want, got)
- })
-
- })
- }
-
- t.Run("crypto/rand", func(t *testing.T) {
- const testN = 100000
-
- for _, c := range []op.UserCodeConfig{op.UserCodeBase20, op.UserCodeDigits} {
- t.Run(c.CharSet, func(t *testing.T) {
- results := make(map[string]int)
-
- for i := 0; i < testN; i++ {
- code, err := op.NewUserCode([]rune(c.CharSet), c.CharAmount, c.DashInterval)
- require.NoError(t, err)
- results[code]++
- }
-
- t.Log(results)
-
- var duplicates int
- for code, count := range results {
- assert.Less(t, count, 3, code)
- if count == 2 {
- duplicates++
- }
- }
-
- })
- }
- })
-}
-
-func BenchmarkNewUserCode(b *testing.B) {
- type args struct {
- charset []rune
- charAmount int
- dashInterval int
- }
- tests := []struct {
- name string
- args args
- reader io.Reader
- }{
- {
- name: "math rand, base20",
- args: args{
- charset: []rune(op.CharSetBase20),
- charAmount: 8,
- dashInterval: 4,
- },
- reader: mr.New(mr.NewSource(1)),
- },
- {
- name: "math rand, digits",
- args: args{
- charset: []rune(op.CharSetDigits),
- charAmount: 9,
- dashInterval: 3,
- },
- reader: mr.New(mr.NewSource(1)),
- },
- {
- name: "crypto rand, base20",
- args: args{
- charset: []rune(op.CharSetBase20),
- charAmount: 8,
- dashInterval: 4,
- },
- reader: rand.Reader,
- },
- {
- name: "crypto rand, digits",
- args: args{
- charset: []rune(op.CharSetDigits),
- charAmount: 9,
- dashInterval: 3,
- },
- reader: rand.Reader,
- },
- }
- for _, tt := range tests {
- runWithRandReader(tt.reader, func() {
- b.Run(tt.name, func(b *testing.B) {
- for i := 0; i < b.N; i++ {
- _, err := op.NewUserCode(tt.args.charset, tt.args.charAmount, tt.args.dashInterval)
- require.NoError(b, err)
- }
- })
-
- })
- }
-}
-
-func TestDeviceAccessToken(t *testing.T) {
- storage := testProvider.Storage().(*storage.Storage)
- storage.StoreDeviceAuthorization(context.Background(), "native", "qwerty", "yuiop", time.Now().Add(time.Minute), []string{"foo"})
- storage.CompleteDeviceAuthorization(context.Background(), "yuiop", "tim")
-
- values := make(url.Values)
- values.Set("client_id", "native")
- values.Set("grant_type", string(oidc.GrantTypeDeviceCode))
- values.Set("device_code", "qwerty")
-
- r := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(values.Encode()))
- r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
- w := httptest.NewRecorder()
-
- op.DeviceAccessToken(w, r, testProvider)
-
- result := w.Result()
- got, _ := io.ReadAll(result.Body)
- t.Log(string(got))
- assert.Less(t, result.StatusCode, 300)
- assert.NotEmpty(t, string(got))
-}
-
-func TestCheckDeviceAuthorizationState(t *testing.T) {
- now := time.Now()
-
- storage := testProvider.Storage().(*storage.Storage)
- storage.StoreDeviceAuthorization(context.Background(), "native", "pending", "pending", now.Add(time.Minute), []string{"foo"})
- storage.StoreDeviceAuthorization(context.Background(), "native", "denied", "denied", now.Add(time.Minute), []string{"foo"})
- storage.StoreDeviceAuthorization(context.Background(), "native", "completed", "completed", now.Add(time.Minute), []string{"foo"})
- storage.StoreDeviceAuthorization(context.Background(), "native", "expired", "expired", now.Add(-time.Minute), []string{"foo"})
-
- storage.DenyDeviceAuthorization(context.Background(), "denied")
- storage.CompleteDeviceAuthorization(context.Background(), "completed", "tim")
-
- exceededCtx, cancel := context.WithTimeout(context.Background(), -time.Second)
- defer cancel()
-
- type args struct {
- ctx context.Context
- clientID string
- deviceCode string
- }
- tests := []struct {
- name string
- args args
- want *op.DeviceAuthorizationState
- wantErr error
- }{
- {
- name: "pending",
- args: args{
- ctx: context.Background(),
- clientID: "native",
- deviceCode: "pending",
- },
- want: &op.DeviceAuthorizationState{
- ClientID: "native",
- Scopes: []string{"foo"},
- Expires: now.Add(time.Minute),
- },
- wantErr: oidc.ErrAuthorizationPending(),
- },
- {
- name: "slow down",
- args: args{
- ctx: exceededCtx,
- clientID: "native",
- deviceCode: "ok",
- },
- wantErr: oidc.ErrSlowDown(),
- },
- {
- name: "wrong client",
- args: args{
- ctx: context.Background(),
- clientID: "foo",
- deviceCode: "ok",
- },
- wantErr: oidc.ErrAccessDenied(),
- },
- {
- name: "denied",
- args: args{
- ctx: context.Background(),
- clientID: "native",
- deviceCode: "denied",
- },
- want: &op.DeviceAuthorizationState{
- ClientID: "native",
- Scopes: []string{"foo"},
- Expires: now.Add(time.Minute),
- Denied: true,
- },
- wantErr: oidc.ErrAccessDenied(),
- },
- {
- name: "completed",
- args: args{
- ctx: context.Background(),
- clientID: "native",
- deviceCode: "completed",
- },
- want: &op.DeviceAuthorizationState{
- ClientID: "native",
- Scopes: []string{"foo"},
- Expires: now.Add(time.Minute),
- Subject: "tim",
- Done: true,
- },
- },
- {
- name: "expired",
- args: args{
- ctx: context.Background(),
- clientID: "native",
- deviceCode: "expired",
- },
- want: &op.DeviceAuthorizationState{
- ClientID: "native",
- Scopes: []string{"foo"},
- Expires: now.Add(-time.Minute),
- },
- wantErr: oidc.ErrExpiredDeviceCode(),
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got, err := op.CheckDeviceAuthorizationState(tt.args.ctx, tt.args.clientID, tt.args.deviceCode, testProvider)
- require.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestCreateDeviceTokenResponse(t *testing.T) {
- tests := []struct {
- name string
- tokenRequest op.TokenRequest
- wantAccessToken bool
- wantRefreshToken bool
- wantIDToken bool
- wantErr bool
- }{
- {
- name: "access token",
- tokenRequest: &op.DeviceAuthorizationState{
- ClientID: "client1",
- Subject: "id1",
- AMR: []string{"password"},
- AuthTime: time.Now(),
- },
- wantAccessToken: true,
- },
- {
- name: "access and refresh tokens",
- tokenRequest: &op.DeviceAuthorizationState{
- ClientID: "client1",
- Subject: "id1",
- AMR: []string{"password"},
- AuthTime: time.Now(),
- Scopes: []string{oidc.ScopeOfflineAccess},
- },
- wantAccessToken: true,
- wantRefreshToken: true,
- },
- {
- name: "access and id token",
- tokenRequest: &op.DeviceAuthorizationState{
- ClientID: "client1",
- Subject: "id1",
- AMR: []string{"password"},
- AuthTime: time.Now(),
- Scopes: []string{oidc.ScopeOpenID},
- },
- wantAccessToken: true,
- wantIDToken: true,
- },
- {
- name: "access, refresh and id token",
- tokenRequest: &op.DeviceAuthorizationState{
- ClientID: "client1",
- Subject: "id1",
- AMR: []string{"password"},
- AuthTime: time.Now(),
- Scopes: []string{oidc.ScopeOfflineAccess, oidc.ScopeOpenID},
- },
- wantAccessToken: true,
- wantRefreshToken: true,
- wantIDToken: true,
- },
- {
- name: "id token creation error",
- tokenRequest: &op.DeviceAuthorizationState{
- ClientID: "client1",
- Subject: "foobar",
- AMR: []string{"password"},
- AuthTime: time.Now(),
- Scopes: []string{oidc.ScopeOfflineAccess, oidc.ScopeOpenID},
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- client, err := testProvider.Storage().GetClientByClientID(context.Background(), "native")
- require.NoError(t, err)
-
- got, err := op.CreateDeviceTokenResponse(context.Background(), tt.tokenRequest, testProvider, client)
- if tt.wantErr {
- require.Error(t, err)
- return
- }
- require.NoError(t, err)
- assert.InDelta(t, 300, got.ExpiresIn, 2)
- if tt.wantAccessToken {
- assert.NotEmpty(t, got.AccessToken, "access token")
- }
- if tt.wantRefreshToken {
- assert.NotEmpty(t, got.RefreshToken, "refresh token")
- }
- if tt.wantIDToken {
- assert.NotEmpty(t, got.IDToken, "id token")
- }
- })
- }
-}
diff --git a/pkg/op/discovery.go b/pkg/op/discovery.go
index 9b3ddb6..100bfc8 100644
--- a/pkg/op/discovery.go
+++ b/pkg/op/discovery.go
@@ -1,17 +1,49 @@
package op
import (
- "context"
"net/http"
- jose "github.com/go-jose/go-jose/v4"
-
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
-type DiscoverStorage interface {
- SignatureAlgorithms(context.Context) ([]jose.SignatureAlgorithm, error)
+func discoveryHandler(c Configuration, s Signer) func(http.ResponseWriter, *http.Request) {
+ return func(w http.ResponseWriter, r *http.Request) {
+ Discover(w, CreateDiscoveryConfig(c, s))
+ }
+}
+
+func Discover(w http.ResponseWriter, config *oidc.DiscoveryConfiguration) {
+ httphelper.MarshalJSON(w, config)
+}
+
+func CreateDiscoveryConfig(c Configuration, s Signer) *oidc.DiscoveryConfiguration {
+ return &oidc.DiscoveryConfiguration{
+ Issuer: c.Issuer(),
+ AuthorizationEndpoint: c.AuthorizationEndpoint().Absolute(c.Issuer()),
+ TokenEndpoint: c.TokenEndpoint().Absolute(c.Issuer()),
+ IntrospectionEndpoint: c.IntrospectionEndpoint().Absolute(c.Issuer()),
+ UserinfoEndpoint: c.UserinfoEndpoint().Absolute(c.Issuer()),
+ RevocationEndpoint: c.RevocationEndpoint().Absolute(c.Issuer()),
+ EndSessionEndpoint: c.EndSessionEndpoint().Absolute(c.Issuer()),
+ JwksURI: c.KeysEndpoint().Absolute(c.Issuer()),
+ ScopesSupported: Scopes(c),
+ ResponseTypesSupported: ResponseTypes(c),
+ GrantTypesSupported: GrantTypes(c),
+ SubjectTypesSupported: SubjectTypes(c),
+ IDTokenSigningAlgValuesSupported: SigAlgorithms(s),
+ RequestObjectSigningAlgValuesSupported: RequestObjectSigAlgorithms(c),
+ TokenEndpointAuthMethodsSupported: AuthMethodsTokenEndpoint(c),
+ TokenEndpointAuthSigningAlgValuesSupported: TokenSigAlgorithms(c),
+ IntrospectionEndpointAuthSigningAlgValuesSupported: IntrospectionSigAlgorithms(c),
+ IntrospectionEndpointAuthMethodsSupported: AuthMethodsIntrospectionEndpoint(c),
+ RevocationEndpointAuthSigningAlgValuesSupported: RevocationSigAlgorithms(c),
+ RevocationEndpointAuthMethodsSupported: AuthMethodsRevocationEndpoint(c),
+ ClaimsSupported: SupportedClaims(c),
+ CodeChallengeMethodsSupported: CodeChallengeMethods(c),
+ UILocalesSupported: c.SupportedUILocales(),
+ RequestParameterSupported: c.RequestObjectSupported(),
+ }
}
var DefaultSupportedScopes = []string{
@@ -23,89 +55,8 @@ var DefaultSupportedScopes = []string{
oidc.ScopeOfflineAccess,
}
-func discoveryHandler(c Configuration, s DiscoverStorage) func(http.ResponseWriter, *http.Request) {
- return func(w http.ResponseWriter, r *http.Request) {
- Discover(w, CreateDiscoveryConfig(r.Context(), c, s))
- }
-}
-
-func Discover(w http.ResponseWriter, config *oidc.DiscoveryConfiguration) {
- httphelper.MarshalJSON(w, config)
-}
-
-func CreateDiscoveryConfig(ctx context.Context, config Configuration, storage DiscoverStorage) *oidc.DiscoveryConfiguration {
- issuer := IssuerFromContext(ctx)
- return &oidc.DiscoveryConfiguration{
- Issuer: issuer,
- AuthorizationEndpoint: config.AuthorizationEndpoint().Absolute(issuer),
- TokenEndpoint: config.TokenEndpoint().Absolute(issuer),
- IntrospectionEndpoint: config.IntrospectionEndpoint().Absolute(issuer),
- UserinfoEndpoint: config.UserinfoEndpoint().Absolute(issuer),
- RevocationEndpoint: config.RevocationEndpoint().Absolute(issuer),
- EndSessionEndpoint: config.EndSessionEndpoint().Absolute(issuer),
- JwksURI: config.KeysEndpoint().Absolute(issuer),
- DeviceAuthorizationEndpoint: config.DeviceAuthorizationEndpoint().Absolute(issuer),
- CheckSessionIframe: config.CheckSessionIframe().Absolute(issuer),
- ScopesSupported: Scopes(config),
- ResponseTypesSupported: ResponseTypes(config),
- GrantTypesSupported: GrantTypes(config),
- SubjectTypesSupported: SubjectTypes(config),
- IDTokenSigningAlgValuesSupported: SigAlgorithms(ctx, storage),
- RequestObjectSigningAlgValuesSupported: RequestObjectSigAlgorithms(config),
- TokenEndpointAuthMethodsSupported: AuthMethodsTokenEndpoint(config),
- TokenEndpointAuthSigningAlgValuesSupported: TokenSigAlgorithms(config),
- IntrospectionEndpointAuthSigningAlgValuesSupported: IntrospectionSigAlgorithms(config),
- IntrospectionEndpointAuthMethodsSupported: AuthMethodsIntrospectionEndpoint(config),
- RevocationEndpointAuthSigningAlgValuesSupported: RevocationSigAlgorithms(config),
- RevocationEndpointAuthMethodsSupported: AuthMethodsRevocationEndpoint(config),
- ClaimsSupported: SupportedClaims(config),
- CodeChallengeMethodsSupported: CodeChallengeMethods(config),
- UILocalesSupported: config.SupportedUILocales(),
- RequestParameterSupported: config.RequestObjectSupported(),
- BackChannelLogoutSupported: config.BackChannelLogoutSupported(),
- BackChannelLogoutSessionSupported: config.BackChannelLogoutSessionSupported(),
- }
-}
-
-func createDiscoveryConfigV2(ctx context.Context, config Configuration, storage DiscoverStorage, endpoints *Endpoints) *oidc.DiscoveryConfiguration {
- issuer := IssuerFromContext(ctx)
- return &oidc.DiscoveryConfiguration{
- Issuer: issuer,
- AuthorizationEndpoint: endpoints.Authorization.Absolute(issuer),
- TokenEndpoint: endpoints.Token.Absolute(issuer),
- IntrospectionEndpoint: endpoints.Introspection.Absolute(issuer),
- UserinfoEndpoint: endpoints.Userinfo.Absolute(issuer),
- RevocationEndpoint: endpoints.Revocation.Absolute(issuer),
- EndSessionEndpoint: endpoints.EndSession.Absolute(issuer),
- JwksURI: endpoints.JwksURI.Absolute(issuer),
- DeviceAuthorizationEndpoint: endpoints.DeviceAuthorization.Absolute(issuer),
- ScopesSupported: Scopes(config),
- ResponseTypesSupported: ResponseTypes(config),
- GrantTypesSupported: GrantTypes(config),
- SubjectTypesSupported: SubjectTypes(config),
- IDTokenSigningAlgValuesSupported: SigAlgorithms(ctx, storage),
- RequestObjectSigningAlgValuesSupported: RequestObjectSigAlgorithms(config),
- TokenEndpointAuthMethodsSupported: AuthMethodsTokenEndpoint(config),
- TokenEndpointAuthSigningAlgValuesSupported: TokenSigAlgorithms(config),
- IntrospectionEndpointAuthSigningAlgValuesSupported: IntrospectionSigAlgorithms(config),
- IntrospectionEndpointAuthMethodsSupported: AuthMethodsIntrospectionEndpoint(config),
- RevocationEndpointAuthSigningAlgValuesSupported: RevocationSigAlgorithms(config),
- RevocationEndpointAuthMethodsSupported: AuthMethodsRevocationEndpoint(config),
- ClaimsSupported: SupportedClaims(config),
- CodeChallengeMethodsSupported: CodeChallengeMethods(config),
- UILocalesSupported: config.SupportedUILocales(),
- RequestParameterSupported: config.RequestObjectSupported(),
- BackChannelLogoutSupported: config.BackChannelLogoutSupported(),
- BackChannelLogoutSessionSupported: config.BackChannelLogoutSessionSupported(),
- }
-}
-
func Scopes(c Configuration) []string {
- provider, ok := c.(*Provider)
- if ok && provider.config.SupportedScopes != nil {
- return provider.config.SupportedScopes
- }
- return DefaultSupportedScopes
+ return DefaultSupportedScopes // TODO: config
}
func ResponseTypes(c Configuration) []string {
@@ -133,38 +84,46 @@ func GrantTypes(c Configuration) []oidc.GrantType {
if c.GrantTypeJWTAuthorizationSupported() {
grantTypes = append(grantTypes, oidc.GrantTypeBearer)
}
- if c.GrantTypeDeviceCodeSupported() {
- grantTypes = append(grantTypes, oidc.GrantTypeDeviceCode)
- }
return grantTypes
}
+func SupportedClaims(c Configuration) []string {
+ return []string{ // TODO: config
+ "sub",
+ "aud",
+ "exp",
+ "iat",
+ "iss",
+ "auth_time",
+ "nonce",
+ "acr",
+ "amr",
+ "c_hash",
+ "at_hash",
+ "act",
+ "scopes",
+ "client_id",
+ "azp",
+ "preferred_username",
+ "name",
+ "family_name",
+ "given_name",
+ "locale",
+ "email",
+ "email_verified",
+ "phone_number",
+ "phone_number_verified",
+ }
+}
+
+func SigAlgorithms(s Signer) []string {
+ return []string{string(s.SignatureAlgorithm())}
+}
+
func SubjectTypes(c Configuration) []string {
return []string{"public"} // TODO: config
}
-func SigAlgorithms(ctx context.Context, storage DiscoverStorage) []string {
- ctx, span := tracer.Start(ctx, "SigAlgorithms")
- defer span.End()
-
- algorithms, err := storage.SignatureAlgorithms(ctx)
- if err != nil {
- return nil
- }
- algs := make([]string, len(algorithms))
- for i, algorithm := range algorithms {
- algs[i] = string(algorithm)
- }
- return algs
-}
-
-func RequestObjectSigAlgorithms(c Configuration) []string {
- if !c.RequestObjectSupported() {
- return nil
- }
- return c.RequestObjectSigningAlgorithmsSupported()
-}
-
func AuthMethodsTokenEndpoint(c Configuration) []oidc.AuthMethod {
authMethods := []oidc.AuthMethod{
oidc.AuthMethodNone,
@@ -186,13 +145,6 @@ func TokenSigAlgorithms(c Configuration) []string {
return c.TokenEndpointSigningAlgorithmsSupported()
}
-func IntrospectionSigAlgorithms(c Configuration) []string {
- if !c.IntrospectionAuthMethodPrivateKeyJWTSupported() {
- return nil
- }
- return c.IntrospectionEndpointSigningAlgorithmsSupported()
-}
-
func AuthMethodsIntrospectionEndpoint(c Configuration) []oidc.AuthMethod {
authMethods := []oidc.AuthMethod{
oidc.AuthMethodBasic,
@@ -203,13 +155,6 @@ func AuthMethodsIntrospectionEndpoint(c Configuration) []oidc.AuthMethod {
return authMethods
}
-func RevocationSigAlgorithms(c Configuration) []string {
- if !c.RevocationAuthMethodPrivateKeyJWTSupported() {
- return nil
- }
- return c.RevocationEndpointSigningAlgorithmsSupported()
-}
-
func AuthMethodsRevocationEndpoint(c Configuration) []oidc.AuthMethod {
authMethods := []oidc.AuthMethod{
oidc.AuthMethodNone,
@@ -224,15 +169,6 @@ func AuthMethodsRevocationEndpoint(c Configuration) []oidc.AuthMethod {
return authMethods
}
-func SupportedClaims(c Configuration) []string {
- provider, ok := c.(*Provider)
- if ok && provider.config.SupportedClaims != nil {
- return provider.config.SupportedClaims
- }
-
- return DefaultSupportedClaims
-}
-
func CodeChallengeMethods(c Configuration) []oidc.CodeChallengeMethod {
codeMethods := make([]oidc.CodeChallengeMethod, 0, 1)
if c.CodeMethodS256Supported() {
@@ -240,3 +176,24 @@ func CodeChallengeMethods(c Configuration) []oidc.CodeChallengeMethod {
}
return codeMethods
}
+
+func IntrospectionSigAlgorithms(c Configuration) []string {
+ if !c.IntrospectionAuthMethodPrivateKeyJWTSupported() {
+ return nil
+ }
+ return c.IntrospectionEndpointSigningAlgorithmsSupported()
+}
+
+func RevocationSigAlgorithms(c Configuration) []string {
+ if !c.RevocationAuthMethodPrivateKeyJWTSupported() {
+ return nil
+ }
+ return c.RevocationEndpointSigningAlgorithmsSupported()
+}
+
+func RequestObjectSigAlgorithms(c Configuration) []string {
+ if !c.RequestObjectSupported() {
+ return nil
+ }
+ return c.RequestObjectSigningAlgorithmsSupported()
+}
diff --git a/pkg/op/discovery_test.go b/pkg/op/discovery_test.go
index 63f1b98..1d74f75 100644
--- a/pkg/op/discovery_test.go
+++ b/pkg/op/discovery_test.go
@@ -1,19 +1,18 @@
package op_test
import (
- "context"
"net/http"
"net/http/httptest"
+ "reflect"
"testing"
- jose "github.com/go-jose/go-jose/v4"
"github.com/golang/mock/gomock"
- "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op/mock"
+ "github.com/zitadel/oidc/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/op"
+ "github.com/zitadel/oidc/pkg/op/mock"
)
func TestDiscover(t *testing.T) {
@@ -48,9 +47,8 @@ func TestDiscover(t *testing.T) {
func TestCreateDiscoveryConfig(t *testing.T) {
type args struct {
- ctx context.Context
- c op.Configuration
- s op.DiscoverStorage
+ c op.Configuration
+ s op.Signer
}
tests := []struct {
name string
@@ -61,8 +59,9 @@ func TestCreateDiscoveryConfig(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- got := op.CreateDiscoveryConfig(tt.args.ctx, tt.args.c, tt.args.s)
- assert.Equal(t, tt.want, got)
+ if got := op.CreateDiscoveryConfig(tt.args.c, tt.args.s); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("CreateDiscoveryConfig() = %v, want %v", got, tt.want)
+ }
})
}
}
@@ -81,16 +80,12 @@ func Test_scopes(t *testing.T) {
args{},
op.DefaultSupportedScopes,
},
- {
- "custom scopes",
- args{newTestProvider(&op.Config{SupportedScopes: []string{"test1", "test2"}})},
- []string{"test1", "test2"},
- },
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- got := op.Scopes(tt.args.c)
- assert.Equal(t, tt.want, got)
+ if got := op.Scopes(tt.args.c); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("scopes() = %v, want %v", got, tt.want)
+ }
})
}
}
@@ -104,16 +99,13 @@ func Test_ResponseTypes(t *testing.T) {
args args
want []string
}{
- {
- "code and implicit flow",
- args{},
- []string{"code", "id_token", "id_token token"},
- },
+ // TODO: Add test cases.
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- got := op.ResponseTypes(tt.args.c)
- assert.Equal(t, tt.want, got)
+ if got := op.ResponseTypes(tt.args.c); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("responseTypes() = %v, want %v", got, tt.want)
+ }
})
}
}
@@ -125,53 +117,63 @@ func Test_GrantTypes(t *testing.T) {
tests := []struct {
name string
args args
- want []oidc.GrantType
+ want []string
+ }{
+ // TODO: Add test cases.
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if got := op.GrantTypes(tt.args.c); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("grantTypes() = %v, want %v", got, tt.want)
+ }
+ })
+ }
+}
+
+func TestSupportedClaims(t *testing.T) {
+ type args struct {
+ c op.Configuration
+ }
+ tests := []struct {
+ name string
+ args args
+ want []string
+ }{
+ // TODO: Add test cases.
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if got := op.SupportedClaims(tt.args.c); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("SupportedClaims() = %v, want %v", got, tt.want)
+ }
+ })
+ }
+}
+
+func Test_SigAlgorithms(t *testing.T) {
+ m := mock.NewMockSigner(gomock.NewController(t))
+ type args struct {
+ s op.Signer
+ }
+ tests := []struct {
+ name string
+ args args
+ want []string
}{
{
- "code and implicit flow",
- args{
- func() op.Configuration {
- c := mock.NewMockConfiguration(gomock.NewController(t))
- c.EXPECT().GrantTypeRefreshTokenSupported().Return(false)
- c.EXPECT().GrantTypeTokenExchangeSupported().Return(false)
- c.EXPECT().GrantTypeJWTAuthorizationSupported().Return(false)
- c.EXPECT().GrantTypeClientCredentialsSupported().Return(false)
- c.EXPECT().GrantTypeDeviceCodeSupported().Return(false)
- return c
- }(),
- },
- []oidc.GrantType{
- oidc.GrantTypeCode,
- oidc.GrantTypeImplicit,
- },
- },
- {
- "code, implicit flow, refresh token, token exchange, jwt profile, client_credentials",
- args{
- func() op.Configuration {
- c := mock.NewMockConfiguration(gomock.NewController(t))
- c.EXPECT().GrantTypeRefreshTokenSupported().Return(true)
- c.EXPECT().GrantTypeTokenExchangeSupported().Return(true)
- c.EXPECT().GrantTypeJWTAuthorizationSupported().Return(true)
- c.EXPECT().GrantTypeClientCredentialsSupported().Return(true)
- c.EXPECT().GrantTypeDeviceCodeSupported().Return(false)
- return c
- }(),
- },
- []oidc.GrantType{
- oidc.GrantTypeCode,
- oidc.GrantTypeImplicit,
- oidc.GrantTypeRefreshToken,
- oidc.GrantTypeClientCredentials,
- oidc.GrantTypeTokenExchange,
- oidc.GrantTypeBearer,
- },
+ "",
+ args{func() op.Signer {
+ m.EXPECT().SignatureAlgorithm().Return(jose.RS256)
+ return m
+ }()},
+ []string{"RS256"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- got := op.GrantTypes(tt.args.c)
- assert.Equal(t, tt.want, got)
+ if got := op.SigAlgorithms(tt.args.s); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("sigAlgorithms() = %v, want %v", got, tt.want)
+ }
})
}
}
@@ -193,80 +195,9 @@ func Test_SubjectTypes(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- got := op.SubjectTypes(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_SigAlgorithms(t *testing.T) {
- m := mock.NewMockDiscoverStorage(gomock.NewController(t))
- type args struct {
- s op.DiscoverStorage
- }
- tests := []struct {
- name string
- args args
- want []string
- }{
- {
- "",
- args{func() op.DiscoverStorage {
- m.EXPECT().SignatureAlgorithms(gomock.Any()).Return([]jose.SignatureAlgorithm{jose.RS256}, nil)
- return m
- }()},
- []string{"RS256"},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.SigAlgorithms(context.Background(), tt.args.s)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_RequestObjectSigAlgorithms(t *testing.T) {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []string
- }{
- {
- "not supported, empty",
- args{func() op.Configuration {
- m.EXPECT().RequestObjectSupported().Return(false)
- return m
- }()},
- nil,
- },
- {
- "supported, empty",
- args{func() op.Configuration {
- m.EXPECT().RequestObjectSupported().Return(true)
- m.EXPECT().RequestObjectSigningAlgorithmsSupported().Return(nil)
- return m
- }()},
- nil,
- },
- {
- "supported, list",
- args{func() op.Configuration {
- m.EXPECT().RequestObjectSupported().Return(true)
- m.EXPECT().RequestObjectSigningAlgorithmsSupported().Return([]string{"RS256"})
- return m
- }()},
- []string{"RS256"},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.RequestObjectSigAlgorithms(tt.args.c)
- assert.Equal(t, tt.want, got)
+ if got := op.SubjectTypes(tt.args.c); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("subjectTypes() = %v, want %v", got, tt.want)
+ }
})
}
}
@@ -313,311 +244,9 @@ func Test_AuthMethodsTokenEndpoint(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- got := op.AuthMethodsTokenEndpoint(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_TokenSigAlgorithms(t *testing.T) {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []string
- }{
- {
- "not supported, empty",
- args{func() op.Configuration {
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(false)
- return m
- }()},
- nil,
- },
- {
- "supported, empty",
- args{func() op.Configuration {
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(true)
- m.EXPECT().TokenEndpointSigningAlgorithmsSupported().Return(nil)
- return m
- }()},
- nil,
- },
- {
- "supported, list",
- args{func() op.Configuration {
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(true)
- m.EXPECT().TokenEndpointSigningAlgorithmsSupported().Return([]string{"RS256"})
- return m
- }()},
- []string{"RS256"},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.TokenSigAlgorithms(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_IntrospectionSigAlgorithms(t *testing.T) {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []string
- }{
- {
- "not supported, empty",
- args{func() op.Configuration {
- m.EXPECT().IntrospectionAuthMethodPrivateKeyJWTSupported().Return(false)
- return m
- }()},
- nil,
- },
- {
- "supported, empty",
- args{func() op.Configuration {
- m.EXPECT().IntrospectionAuthMethodPrivateKeyJWTSupported().Return(true)
- m.EXPECT().IntrospectionEndpointSigningAlgorithmsSupported().Return(nil)
- return m
- }()},
- nil,
- },
- {
- "supported, list",
- args{func() op.Configuration {
- m.EXPECT().IntrospectionAuthMethodPrivateKeyJWTSupported().Return(true)
- m.EXPECT().IntrospectionEndpointSigningAlgorithmsSupported().Return([]string{"RS256"})
- return m
- }()},
- []string{"RS256"},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.IntrospectionSigAlgorithms(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_AuthMethodsIntrospectionEndpoint(t *testing.T) {
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []oidc.AuthMethod
- }{
- {
- "basic only",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(false)
- return m
- }()},
- []oidc.AuthMethod{oidc.AuthMethodBasic},
- },
- {
- "basic and private_key_jwt",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(true)
- return m
- }()},
- []oidc.AuthMethod{oidc.AuthMethodBasic, oidc.AuthMethodPrivateKeyJWT},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.AuthMethodsIntrospectionEndpoint(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_RevocationSigAlgorithms(t *testing.T) {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []string
- }{
- {
- "not supported, empty",
- args{func() op.Configuration {
- m.EXPECT().RevocationAuthMethodPrivateKeyJWTSupported().Return(false)
- return m
- }()},
- nil,
- },
- {
- "supported, empty",
- args{func() op.Configuration {
- m.EXPECT().RevocationAuthMethodPrivateKeyJWTSupported().Return(true)
- m.EXPECT().RevocationEndpointSigningAlgorithmsSupported().Return(nil)
- return m
- }()},
- nil,
- },
- {
- "supported, list",
- args{func() op.Configuration {
- m.EXPECT().RevocationAuthMethodPrivateKeyJWTSupported().Return(true)
- m.EXPECT().RevocationEndpointSigningAlgorithmsSupported().Return([]string{"RS256"})
- return m
- }()},
- []string{"RS256"},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.RevocationSigAlgorithms(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_AuthMethodsRevocationEndpoint(t *testing.T) {
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []oidc.AuthMethod
- }{
- {
- "none and basic",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().AuthMethodPostSupported().Return(false)
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(false)
- return m
- }()},
- []oidc.AuthMethod{oidc.AuthMethodNone, oidc.AuthMethodBasic},
- },
- {
- "none, basic and post",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().AuthMethodPostSupported().Return(true)
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(false)
- return m
- }()},
- []oidc.AuthMethod{oidc.AuthMethodNone, oidc.AuthMethodBasic, oidc.AuthMethodPost},
- },
- {
- "none, basic, post and private_key_jwt",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().AuthMethodPostSupported().Return(true)
- m.EXPECT().AuthMethodPrivateKeyJWTSupported().Return(true)
- return m
- }()},
- []oidc.AuthMethod{oidc.AuthMethodNone, oidc.AuthMethodBasic, oidc.AuthMethodPost, oidc.AuthMethodPrivateKeyJWT},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.AuthMethodsRevocationEndpoint(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestSupportedClaims(t *testing.T) {
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []string
- }{
- {
- "scopes",
- args{},
- []string{
- "sub",
- "aud",
- "exp",
- "iat",
- "iss",
- "auth_time",
- "nonce",
- "acr",
- "amr",
- "c_hash",
- "at_hash",
- "act",
- "scopes",
- "client_id",
- "azp",
- "preferred_username",
- "name",
- "family_name",
- "given_name",
- "locale",
- "email",
- "email_verified",
- "phone_number",
- "phone_number_verified",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.SupportedClaims(tt.args.c)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_CodeChallengeMethods(t *testing.T) {
- type args struct {
- c op.Configuration
- }
- tests := []struct {
- name string
- args args
- want []oidc.CodeChallengeMethod
- }{
- {
- "not supported",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().CodeMethodS256Supported().Return(false)
- return m
- }()},
- []oidc.CodeChallengeMethod{},
- },
- {
- "S256",
- args{func() op.Configuration {
- m := mock.NewMockConfiguration(gomock.NewController(t))
- m.EXPECT().CodeMethodS256Supported().Return(true)
- return m
- }()},
- []oidc.CodeChallengeMethod{oidc.CodeChallengeMethodS256},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := op.CodeChallengeMethods(tt.args.c)
- assert.Equal(t, tt.want, got)
+ if got := op.AuthMethodsTokenEndpoint(tt.args.c); !reflect.DeepEqual(got, tt.want) {
+ t.Errorf("authMethods() = %v, want %v", got, tt.want)
+ }
})
}
}
diff --git a/pkg/op/endpoint.go b/pkg/op/endpoint.go
index 1ac1cad..b1e1507 100644
--- a/pkg/op/endpoint.go
+++ b/pkg/op/endpoint.go
@@ -1,46 +1,32 @@
package op
-import (
- "errors"
- "strings"
-)
+import "strings"
type Endpoint struct {
path string
url string
}
-func NewEndpoint(path string) *Endpoint {
- return &Endpoint{path: path}
+func NewEndpoint(path string) Endpoint {
+ return Endpoint{path: path}
}
-func NewEndpointWithURL(path, url string) *Endpoint {
- return &Endpoint{path: path, url: url}
+func NewEndpointWithURL(path, url string) Endpoint {
+ return Endpoint{path: path, url: url}
}
-func (e *Endpoint) Relative() string {
- if e == nil {
- return ""
- }
+func (e Endpoint) Relative() string {
return relativeEndpoint(e.path)
}
-func (e *Endpoint) Absolute(host string) string {
- if e == nil {
- return ""
- }
+func (e Endpoint) Absolute(host string) string {
if e.url != "" {
return e.url
}
return absoluteEndpoint(host, e.path)
}
-var ErrNilEndpoint = errors.New("nil endpoint")
-
-func (e *Endpoint) Validate() error {
- if e == nil {
- return ErrNilEndpoint
- }
+func (e Endpoint) Validate() error {
return nil // TODO:
}
diff --git a/pkg/op/endpoint_test.go b/pkg/op/endpoint_test.go
index 5b98c6e..7c8d1ce 100644
--- a/pkg/op/endpoint_test.go
+++ b/pkg/op/endpoint_test.go
@@ -3,14 +3,13 @@ package op_test
import (
"testing"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "github.com/stretchr/testify/require"
+ "github.com/zitadel/oidc/pkg/op"
)
func TestEndpoint_Path(t *testing.T) {
tests := []struct {
name string
- e *op.Endpoint
+ e op.Endpoint
want string
}{
{
@@ -28,11 +27,6 @@ func TestEndpoint_Path(t *testing.T) {
op.NewEndpointWithURL("/test", "http://test.com/test"),
"/test",
},
- {
- "nil",
- nil,
- "",
- },
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@@ -49,7 +43,7 @@ func TestEndpoint_Absolute(t *testing.T) {
}
tests := []struct {
name string
- e *op.Endpoint
+ e op.Endpoint
args args
want string
}{
@@ -83,12 +77,6 @@ func TestEndpoint_Absolute(t *testing.T) {
args{"https://host"},
"https://test.com/test",
},
- {
- "nil",
- nil,
- args{"https://host"},
- "",
- },
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@@ -103,19 +91,16 @@ func TestEndpoint_Absolute(t *testing.T) {
func TestEndpoint_Validate(t *testing.T) {
tests := []struct {
name string
- e *op.Endpoint
- wantErr error
+ e op.Endpoint
+ wantErr bool
}{
- {
- "nil",
- nil,
- op.ErrNilEndpoint,
- },
+ // TODO: Add test cases.
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- err := tt.e.Validate()
- require.ErrorIs(t, err, tt.wantErr)
+ if err := tt.e.Validate(); (err != nil) != tt.wantErr {
+ t.Errorf("Endpoint.Validate() error = %v, wantErr %v", err, tt.wantErr)
+ }
})
}
}
diff --git a/pkg/op/error.go b/pkg/op/error.go
index 272f85e..3c820d6 100644
--- a/pkg/op/error.go
+++ b/pkg/op/error.go
@@ -1,14 +1,10 @@
package op
import (
- "context"
- "errors"
- "fmt"
- "log/slog"
"net/http"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type ErrAuthRequest interface {
@@ -17,181 +13,34 @@ type ErrAuthRequest interface {
GetState() string
}
-// LogAuthRequest is an optional interface,
-// that allows logging AuthRequest fields.
-// If the AuthRequest does not implement this interface,
-// no details shall be printed to the logs.
-type LogAuthRequest interface {
- ErrAuthRequest
- slog.LogValuer
-}
-
-func AuthRequestError(w http.ResponseWriter, r *http.Request, authReq ErrAuthRequest, err error, authorizer Authorizer) {
- e := oidc.DefaultToServerError(err, err.Error())
- logger := authorizer.Logger().With("oidc_error", e)
-
+func AuthRequestError(w http.ResponseWriter, r *http.Request, authReq ErrAuthRequest, err error, encoder httphelper.Encoder) {
if authReq == nil {
- logger.Log(r.Context(), e.LogLevel(), "auth request")
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
-
- if logAuthReq, ok := authReq.(LogAuthRequest); ok {
- logger = logger.With("auth_request", logAuthReq)
- }
-
+ e := oidc.DefaultToServerError(err, err.Error())
if authReq.GetRedirectURI() == "" || e.IsRedirectDisabled() {
- logger.Log(r.Context(), e.LogLevel(), "auth request: not redirecting")
http.Error(w, e.Description, http.StatusBadRequest)
return
}
e.State = authReq.GetState()
- var sessionState string
- authRequestSessionState, ok := authReq.(AuthRequestSessionState)
- if ok {
- sessionState = authRequestSessionState.GetSessionState()
- }
- e.SessionState = sessionState
- var responseMode oidc.ResponseMode
- if rm, ok := authReq.(interface{ GetResponseMode() oidc.ResponseMode }); ok {
- responseMode = rm.GetResponseMode()
- }
- url, err := AuthResponseURL(authReq.GetRedirectURI(), authReq.GetResponseType(), responseMode, e, authorizer.Encoder())
- if err != nil {
- logger.ErrorContext(r.Context(), "auth response URL", "error", err)
- http.Error(w, err.Error(), http.StatusBadRequest)
- return
- }
- logger.Log(r.Context(), e.LogLevel(), "auth request")
- http.Redirect(w, r, url, http.StatusFound)
-}
-
-func RequestError(w http.ResponseWriter, r *http.Request, err error, logger *slog.Logger) {
- e := oidc.DefaultToServerError(err, err.Error())
- status := http.StatusBadRequest
- if e.ErrorType == oidc.InvalidClient {
- status = http.StatusUnauthorized
- }
- logger.Log(r.Context(), e.LogLevel(), "request error", "oidc_error", e)
- httphelper.MarshalJSONWithStatus(w, e, status)
-}
-
-// TryErrorRedirect tries to handle an error by redirecting a client.
-// If this attempt fails, an error is returned that must be returned
-// to the client instead.
-func TryErrorRedirect(ctx context.Context, authReq ErrAuthRequest, parent error, encoder httphelper.Encoder, logger *slog.Logger) (*Redirect, error) {
- e := oidc.DefaultToServerError(parent, parent.Error())
- logger = logger.With("oidc_error", e)
-
- if authReq == nil {
- logger.Log(ctx, e.LogLevel(), "auth request")
- return nil, AsStatusError(e, http.StatusBadRequest)
- }
-
- if logAuthReq, ok := authReq.(LogAuthRequest); ok {
- logger = logger.With("auth_request", logAuthReq)
- }
-
- if authReq.GetRedirectURI() == "" || e.IsRedirectDisabled() {
- logger.Log(ctx, e.LogLevel(), "auth request: not redirecting")
- return nil, AsStatusError(e, http.StatusBadRequest)
- }
-
- e.State = authReq.GetState()
- var sessionState string
- authRequestSessionState, ok := authReq.(AuthRequestSessionState)
- if ok {
- sessionState = authRequestSessionState.GetSessionState()
- }
- e.SessionState = sessionState
var responseMode oidc.ResponseMode
if rm, ok := authReq.(interface{ GetResponseMode() oidc.ResponseMode }); ok {
responseMode = rm.GetResponseMode()
}
url, err := AuthResponseURL(authReq.GetRedirectURI(), authReq.GetResponseType(), responseMode, e, encoder)
if err != nil {
- logger.ErrorContext(ctx, "auth response URL", "error", err)
- return nil, AsStatusError(err, http.StatusBadRequest)
- }
- logger.Log(ctx, e.LogLevel(), "auth request redirect", "url", url)
- return NewRedirect(url), nil
-}
-
-// StatusError wraps an error with a HTTP status code.
-// The status code is passed to the handler's writer.
-type StatusError struct {
- parent error
- statusCode int
-}
-
-// NewStatusError sets the parent and statusCode to a new StatusError.
-// It is recommended for parent to be an [oidc.Error].
-//
-// Typically implementations should only use this to signal something
-// very specific, like an internal server error.
-// If a returned error is not a StatusError, the framework
-// will set a statusCode based on what the standard specifies,
-// which is [http.StatusBadRequest] for most of the time.
-// If the error encountered can described clearly with a [oidc.Error],
-// do not use this function, as it might break standard rules!
-func NewStatusError(parent error, statusCode int) StatusError {
- return StatusError{
- parent: parent,
- statusCode: statusCode,
- }
-}
-
-// AsStatusError unwraps a StatusError from err
-// and returns it unmodified if found.
-// If no StatuError was found, a new one is returned
-// with statusCode set to it as a default.
-func AsStatusError(err error, statusCode int) (target StatusError) {
- if errors.As(err, &target) {
- return target
- }
- return NewStatusError(err, statusCode)
-}
-
-func (e StatusError) Error() string {
- return fmt.Sprintf("%s: %s", http.StatusText(e.statusCode), e.parent.Error())
-}
-
-func (e StatusError) Unwrap() error {
- return e.parent
-}
-
-func (e StatusError) Is(err error) bool {
- var target StatusError
- if !errors.As(err, &target) {
- return false
- }
- return errors.Is(e.parent, target.parent) &&
- e.statusCode == target.statusCode
-}
-
-// WriteError asserts for a [StatusError] containing an [oidc.Error].
-// If no `StatusError` is found, the status code will default to [http.StatusBadRequest].
-// If no `oidc.Error` was found in the parent, the error type defaults to [oidc.ServerError].
-// When there was no `StatusError` and the `oidc.Error` is of type `oidc.ServerError`,
-// the status code will be set to [http.StatusInternalServerError]
-func WriteError(w http.ResponseWriter, r *http.Request, err error, logger *slog.Logger) {
- var statusError StatusError
- if errors.As(err, &statusError) {
- writeError(w, r,
- oidc.DefaultToServerError(statusError.parent, statusError.parent.Error()),
- statusError.statusCode, logger,
- )
+ http.Error(w, err.Error(), http.StatusBadRequest)
return
}
- statusCode := http.StatusBadRequest
- e := oidc.DefaultToServerError(err, err.Error())
- if e.ErrorType == oidc.ServerError {
- statusCode = http.StatusInternalServerError
- }
- writeError(w, r, e, statusCode, logger)
+ http.Redirect(w, r, url, http.StatusFound)
}
-func writeError(w http.ResponseWriter, r *http.Request, err *oidc.Error, statusCode int, logger *slog.Logger) {
- logger.Log(r.Context(), err.LogLevel(), "request error", "oidc_error", err, "status_code", statusCode)
- httphelper.MarshalJSONWithStatus(w, err, statusCode)
+func RequestError(w http.ResponseWriter, r *http.Request, err error) {
+ e := oidc.DefaultToServerError(err, err.Error())
+ status := http.StatusBadRequest
+ if e.ErrorType == oidc.InvalidClient {
+ status = 401
+ }
+ httphelper.MarshalJSONWithStatus(w, e, status)
}
diff --git a/pkg/op/error_test.go b/pkg/op/error_test.go
deleted file mode 100644
index 9271cf1..0000000
--- a/pkg/op/error_test.go
+++ /dev/null
@@ -1,682 +0,0 @@
-package op
-
-import (
- "context"
- "fmt"
- "io"
- "log/slog"
- "net/http"
- "net/http/httptest"
- "net/url"
- "strings"
- "testing"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "github.com/zitadel/schema"
-)
-
-func TestAuthRequestError(t *testing.T) {
- type args struct {
- authReq ErrAuthRequest
- err error
- }
- tests := []struct {
- name string
- args args
- wantCode int
- wantHeaders map[string]string
- wantBody string
- wantLog string
- }{
- {
- name: "nil auth request",
- args: args{
- authReq: nil,
- err: io.ErrClosedPipe,
- },
- wantCode: http.StatusBadRequest,
- wantBody: "io: read/write on closed pipe\n",
- wantLog: `{
- "level":"ERROR",
- "msg":"auth request",
- "time":"not",
- "oidc_error":{
- "description":"io: read/write on closed pipe",
- "parent":"io: read/write on closed pipe",
- "type":"server_error"
- }
- }`,
- },
- {
- name: "auth request, no redirect URI",
- args: args{
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- err: oidc.ErrInteractionRequired().WithDescription("sign in"),
- },
- wantCode: http.StatusBadRequest,
- wantBody: "sign in\n",
- wantLog: `{
- "level":"WARN",
- "msg":"auth request: not redirecting",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "oidc_error":{
- "description":"sign in",
- "type":"interaction_required"
- }
- }`,
- },
- {
- name: "auth request, redirect disabled",
- args: args{
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- RedirectURI: "http://example.com/callback",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- err: oidc.ErrInvalidRequestRedirectURI().WithDescription("oops"),
- },
- wantCode: http.StatusBadRequest,
- wantBody: "oops\n",
- wantLog: `{
- "level":"WARN",
- "msg":"auth request: not redirecting",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"http://example.com/callback",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "oidc_error":{
- "description":"oops",
- "type":"invalid_request",
- "redirect_disabled":true
- }
- }`,
- },
- {
- name: "auth request, url parse error",
- args: args{
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- RedirectURI: "can't parse this!\n",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- err: oidc.ErrInteractionRequired().WithDescription("sign in"),
- },
- wantCode: http.StatusBadRequest,
- wantBody: "ErrorType=server_error Parent=parse \"can't parse this!\\n\": net/url: invalid control character in URL\n",
- wantLog: `{
- "level":"ERROR",
- "msg":"auth response URL",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"can't parse this!\n",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "error":{
- "type":"server_error",
- "parent":"parse \"can't parse this!\\n\": net/url: invalid control character in URL"
- },
- "oidc_error":{
- "description":"sign in",
- "type":"interaction_required"
- }
- }`,
- },
- {
- name: "auth request redirect",
- args: args{
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- RedirectURI: "http://example.com/callback",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- err: oidc.ErrInteractionRequired().WithDescription("sign in"),
- },
- wantCode: http.StatusFound,
- wantHeaders: map[string]string{"Location": "http://example.com/callback?error=interaction_required&error_description=sign+in&state=state1"},
- wantLog: `{
- "level":"WARN",
- "msg":"auth request",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"http://example.com/callback",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "oidc_error":{
- "description":"sign in",
- "type":"interaction_required"
- }
- }`,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- logOut := new(strings.Builder)
- authorizer := &Provider{
- encoder: schema.NewEncoder(),
- logger: slog.New(
- slog.NewJSONHandler(logOut, &slog.HandlerOptions{
- Level: slog.LevelInfo,
- }).WithAttrs([]slog.Attr{slog.String("time", "not")}),
- ),
- }
-
- w := httptest.NewRecorder()
- r := httptest.NewRequest("POST", "/path", nil)
- AuthRequestError(w, r, tt.args.authReq, tt.args.err, authorizer)
-
- res := w.Result()
- defer res.Body.Close()
-
- assert.Equal(t, tt.wantCode, res.StatusCode)
- for key, wantHeader := range tt.wantHeaders {
- gotHeader := res.Header.Get(key)
- assert.Equalf(t, wantHeader, gotHeader, "header %q", key)
- }
- gotBody, err := io.ReadAll(res.Body)
- require.NoError(t, err, "read result body")
- assert.Equal(t, tt.wantBody, string(gotBody), "result body")
-
- gotLog := logOut.String()
- t.Log(gotLog)
- assert.JSONEq(t, tt.wantLog, gotLog, "log output")
- })
- }
-}
-
-func TestRequestError(t *testing.T) {
- tests := []struct {
- name string
- err error
- wantCode int
- wantBody string
- wantLog string
- }{
- {
- name: "server error",
- err: io.ErrClosedPipe,
- wantCode: http.StatusBadRequest,
- wantBody: `{"error":"server_error", "error_description":"io: read/write on closed pipe"}`,
- wantLog: `{
- "level":"ERROR",
- "msg":"request error",
- "time":"not",
- "oidc_error":{
- "parent":"io: read/write on closed pipe",
- "description":"io: read/write on closed pipe",
- "type":"server_error"}
- }`,
- },
- {
- name: "invalid client",
- err: oidc.ErrInvalidClient().WithDescription("not good"),
- wantCode: http.StatusUnauthorized,
- wantBody: `{"error":"invalid_client", "error_description":"not good"}`,
- wantLog: `{
- "level":"WARN",
- "msg":"request error",
- "time":"not",
- "oidc_error":{
- "description":"not good",
- "type":"invalid_client"}
- }`,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- logOut := new(strings.Builder)
- logger := slog.New(
- slog.NewJSONHandler(logOut, &slog.HandlerOptions{
- Level: slog.LevelInfo,
- }).WithAttrs([]slog.Attr{slog.String("time", "not")}),
- )
- w := httptest.NewRecorder()
- r := httptest.NewRequest("POST", "/path", nil)
- RequestError(w, r, tt.err, logger)
-
- res := w.Result()
- defer res.Body.Close()
-
- assert.Equal(t, tt.wantCode, res.StatusCode, "status code")
-
- gotBody, err := io.ReadAll(res.Body)
- require.NoError(t, err, "read result body")
- assert.JSONEq(t, tt.wantBody, string(gotBody), "result body")
-
- gotLog := logOut.String()
- t.Log(gotLog)
- assert.JSONEq(t, tt.wantLog, gotLog, "log output")
- })
- }
-}
-
-func TestTryErrorRedirect(t *testing.T) {
- type args struct {
- ctx context.Context
- authReq ErrAuthRequest
- parent error
- }
- tests := []struct {
- name string
- args args
- want *Redirect
- wantErr error
- wantLog string
- }{
- {
- name: "nil auth request",
- args: args{
- ctx: context.Background(),
- authReq: nil,
- parent: io.ErrClosedPipe,
- },
- wantErr: NewStatusError(io.ErrClosedPipe, http.StatusBadRequest),
- wantLog: `{
- "level":"ERROR",
- "msg":"auth request",
- "time":"not",
- "oidc_error":{
- "description":"io: read/write on closed pipe",
- "parent":"io: read/write on closed pipe",
- "type":"server_error"
- }
- }`,
- },
- {
- name: "auth request, no redirect URI",
- args: args{
- ctx: context.Background(),
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- parent: oidc.ErrInteractionRequired().WithDescription("sign in"),
- },
- wantErr: NewStatusError(oidc.ErrInteractionRequired().WithDescription("sign in"), http.StatusBadRequest),
- wantLog: `{
- "level":"WARN",
- "msg":"auth request: not redirecting",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "oidc_error":{
- "description":"sign in",
- "type":"interaction_required"
- }
- }`,
- },
- {
- name: "auth request, redirect disabled",
- args: args{
- ctx: context.Background(),
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- RedirectURI: "http://example.com/callback",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- parent: oidc.ErrInvalidRequestRedirectURI().WithDescription("oops"),
- },
- wantErr: NewStatusError(oidc.ErrInvalidRequestRedirectURI().WithDescription("oops"), http.StatusBadRequest),
- wantLog: `{
- "level":"WARN",
- "msg":"auth request: not redirecting",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"http://example.com/callback",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "oidc_error":{
- "description":"oops",
- "type":"invalid_request",
- "redirect_disabled":true
- }
- }`,
- },
- {
- name: "auth request, url parse error",
- args: args{
- ctx: context.Background(),
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- RedirectURI: "can't parse this!\n",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- parent: oidc.ErrInteractionRequired().WithDescription("sign in"),
- },
- wantErr: func() error {
- //lint:ignore SA1007 just recreating the error for testing
- _, err := url.Parse("can't parse this!\n")
- err = oidc.ErrServerError().WithParent(err)
- return NewStatusError(err, http.StatusBadRequest)
- }(),
- wantLog: `{
- "level":"ERROR",
- "msg":"auth response URL",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"can't parse this!\n",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "error":{
- "type":"server_error",
- "parent":"parse \"can't parse this!\\n\": net/url: invalid control character in URL"
- },
- "oidc_error":{
- "description":"sign in",
- "type":"interaction_required"
- }
- }`,
- },
- {
- name: "auth request redirect",
- args: args{
- ctx: context.Background(),
- authReq: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"a", "b"},
- ResponseType: "responseType",
- ClientID: "123",
- RedirectURI: "http://example.com/callback",
- State: "state1",
- ResponseMode: oidc.ResponseModeQuery,
- },
- parent: oidc.ErrInteractionRequired().WithDescription("sign in"),
- },
- want: &Redirect{
- Header: make(http.Header),
- URL: "http://example.com/callback?error=interaction_required&error_description=sign+in&state=state1",
- },
- wantLog: `{
- "level":"WARN",
- "msg":"auth request redirect",
- "time":"not",
- "auth_request":{
- "client_id":"123",
- "redirect_uri":"http://example.com/callback",
- "response_type":"responseType",
- "scopes":"a b"
- },
- "oidc_error":{
- "description":"sign in",
- "type":"interaction_required"
- },
- "url":"http://example.com/callback?error=interaction_required&error_description=sign+in&state=state1"
- }`,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- logOut := new(strings.Builder)
- logger := slog.New(
- slog.NewJSONHandler(logOut, &slog.HandlerOptions{
- Level: slog.LevelInfo,
- }).WithAttrs([]slog.Attr{slog.String("time", "not")}),
- )
- encoder := schema.NewEncoder()
-
- got, err := TryErrorRedirect(tt.args.ctx, tt.args.authReq, tt.args.parent, encoder, logger)
- require.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, tt.want, got)
-
- gotLog := logOut.String()
- t.Log(gotLog)
- assert.JSONEq(t, tt.wantLog, gotLog, "log output")
- })
- }
-}
-
-func TestNewStatusError(t *testing.T) {
- err := NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError)
-
- want := "Internal Server Error: io: read/write on closed pipe"
- got := fmt.Sprint(err)
- assert.Equal(t, want, got)
-}
-
-func TestAsStatusError(t *testing.T) {
- type args struct {
- err error
- statusCode int
- }
- tests := []struct {
- name string
- args args
- want string
- }{
- {
- name: "already status error",
- args: args{
- err: NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError),
- statusCode: http.StatusBadRequest,
- },
- want: "Internal Server Error: io: read/write on closed pipe",
- },
- {
- name: "oidc error",
- args: args{
- err: oidc.ErrAcrInvalid,
- statusCode: http.StatusBadRequest,
- },
- want: "Bad Request: acr is invalid",
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := AsStatusError(tt.args.err, tt.args.statusCode)
- got := fmt.Sprint(err)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestStatusError_Unwrap(t *testing.T) {
- err := NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError)
- require.ErrorIs(t, err, io.ErrClosedPipe)
-}
-
-func TestStatusError_Is(t *testing.T) {
- type args struct {
- err error
- }
- tests := []struct {
- name string
- args args
- want bool
- }{
- {
- name: "nil error",
- args: args{err: nil},
- want: false,
- },
- {
- name: "other error",
- args: args{err: io.EOF},
- want: false,
- },
- {
- name: "other parent",
- args: args{err: NewStatusError(io.EOF, http.StatusInternalServerError)},
- want: false,
- },
- {
- name: "other status",
- args: args{err: NewStatusError(io.ErrClosedPipe, http.StatusInsufficientStorage)},
- want: false,
- },
- {
- name: "same",
- args: args{err: NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError)},
- want: true,
- },
- {
- name: "wrapped",
- args: args{err: fmt.Errorf("wrap: %w", NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError))},
- want: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- e := NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError)
- if got := e.Is(tt.args.err); got != tt.want {
- t.Errorf("StatusError.Is() = %v, want %v", got, tt.want)
- }
- })
- }
-}
-
-func TestWriteError(t *testing.T) {
- tests := []struct {
- name string
- err error
- wantStatus int
- wantBody string
- wantLog string
- }{
- {
- name: "not a status or oidc error",
- err: io.ErrClosedPipe,
- wantStatus: http.StatusInternalServerError,
- wantBody: `{
- "error":"server_error",
- "error_description":"io: read/write on closed pipe"
- }`,
- wantLog: `{
- "level":"ERROR",
- "msg":"request error",
- "oidc_error":{
- "description":"io: read/write on closed pipe",
- "parent":"io: read/write on closed pipe",
- "type":"server_error"
- },
- "status_code":500,
- "time":"not"
- }`,
- },
- {
- name: "status error w/o oidc",
- err: NewStatusError(io.ErrClosedPipe, http.StatusInternalServerError),
- wantStatus: http.StatusInternalServerError,
- wantBody: `{
- "error":"server_error",
- "error_description":"io: read/write on closed pipe"
- }`,
- wantLog: `{
- "level":"ERROR",
- "msg":"request error",
- "oidc_error":{
- "description":"io: read/write on closed pipe",
- "parent":"io: read/write on closed pipe",
- "type":"server_error"
- },
- "status_code":500,
- "time":"not"
- }`,
- },
- {
- name: "oidc error w/o status",
- err: oidc.ErrInvalidRequest().WithDescription("oops"),
- wantStatus: http.StatusBadRequest,
- wantBody: `{
- "error":"invalid_request",
- "error_description":"oops"
- }`,
- wantLog: `{
- "level":"WARN",
- "msg":"request error",
- "oidc_error":{
- "description":"oops",
- "type":"invalid_request"
- },
- "status_code":400,
- "time":"not"
- }`,
- },
- {
- name: "status with oidc error",
- err: NewStatusError(
- oidc.ErrUnauthorizedClient().WithDescription("oops"),
- http.StatusUnauthorized,
- ),
- wantStatus: http.StatusUnauthorized,
- wantBody: `{
- "error":"unauthorized_client",
- "error_description":"oops"
- }`,
- wantLog: `{
- "level":"WARN",
- "msg":"request error",
- "oidc_error":{
- "description":"oops",
- "type":"unauthorized_client"
- },
- "status_code":401,
- "time":"not"
- }`,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- logOut := new(strings.Builder)
- logger := slog.New(
- slog.NewJSONHandler(logOut, &slog.HandlerOptions{
- Level: slog.LevelInfo,
- }).WithAttrs([]slog.Attr{slog.String("time", "not")}),
- )
- r := httptest.NewRequest("GET", "/target", nil)
- w := httptest.NewRecorder()
-
- WriteError(w, r, tt.err, logger)
- res := w.Result()
- assert.Equal(t, tt.wantStatus, res.StatusCode, "status code")
- gotBody, err := io.ReadAll(res.Body)
- require.NoError(t, err)
- assert.JSONEq(t, tt.wantBody, string(gotBody), "body")
- assert.JSONEq(t, tt.wantLog, logOut.String())
- })
- }
-}
diff --git a/pkg/op/form_post.html.tmpl b/pkg/op/form_post.html.tmpl
deleted file mode 100644
index 7bc9ab3..0000000
--- a/pkg/op/form_post.html.tmpl
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-Found .",
- },
- },
- {
- // This call will fail. A successful test is already
- // part of client/integration_test.go
- name: "code exchange",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeCode),
- "code": "123",
- },
- wantCode: http.StatusUnauthorized,
- json: `{"error":"invalid_client"}`,
- },
- {
- name: "JWT authorization",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeBearer),
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- "assertion": jwtToken,
- },
- wantCode: http.StatusBadRequest,
- json: "{\"error\":\"server_error\",\"error_description\":\"audience is not valid: Audience must contain client_id \\\"https://localhost:9998/\\\"\"}",
- },
- {
- name: "Token exchange",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeTokenExchange),
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- "subject_token": jwtToken,
- "subject_token_type": string(oidc.AccessTokenType),
- },
- wantCode: http.StatusOK,
- contains: []string{
- `{"access_token":"`,
- `","issued_token_type":"urn:ietf:params:oauth:token-type:refresh_token","token_type":"Bearer","expires_in":299,"scope":"openid offline_access","refresh_token":"`,
- },
- },
- {
- name: "Client credentials exchange",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- basicAuth: &basicAuth{"sid1", "verysecret"},
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeClientCredentials),
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- },
- wantCode: http.StatusOK,
- contains: []string{`{"access_token":"`, `","token_type":"Bearer","expires_in":299,"scope":"openid offline_access"}`},
- },
- {
- // This call will fail. A successful test is already
- // part of device_test.go
- name: "device token",
- method: http.MethodPost,
- path: testProvider.TokenEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- header: map[string]string{
- "Content-Type": "application/x-www-form-urlencoded",
- },
- body: map[string]string{
- "grant_type": string(oidc.GrantTypeDeviceCode),
- "device_code": "123",
- },
- wantCode: http.StatusBadRequest,
- json: `{"error":"access_denied","error_description":"The authorization request was denied."}`,
- },
- {
- name: "missing grant type",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- wantCode: http.StatusBadRequest,
- json: `{"error":"invalid_request","error_description":"grant_type missing"}`,
- },
- {
- name: "unsupported grant type",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": "foo",
- },
- wantCode: http.StatusBadRequest,
- json: `{"error":"unsupported_grant_type","error_description":"foo not supported"}`,
- },
- {
- name: "introspection",
- method: http.MethodGet,
- path: testProvider.IntrospectionEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- values: map[string]string{
- "token": accessToken,
- },
- wantCode: http.StatusOK,
- json: `{"active":true,"scope":"openid offline_access email profile phone","client_id":"web","sub":"id1","username":"test-user@localhost","name":"Test User","given_name":"Test","family_name":"User","locale":"de","preferred_username":"test-user@localhost","email":"test-user@zitadel.ch","email_verified":true}`,
- },
- {
- name: "user info",
- method: http.MethodGet,
- path: testProvider.UserinfoEndpoint().Relative(),
- header: map[string]string{
- "authorization": "Bearer " + accessToken,
- },
- wantCode: http.StatusOK,
- json: `{"sub":"id1","name":"Test User","given_name":"Test","family_name":"User","locale":"de","preferred_username":"test-user@localhost","email":"test-user@zitadel.ch","email_verified":true}`,
- },
- {
- name: "refresh token",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeRefreshToken),
- "refresh_token": refreshToken,
- "client_id": client.GetID(),
- "client_secret": "secret",
- },
- wantCode: http.StatusOK,
- contains: []string{
- `{"access_token":"`,
- `","token_type":"Bearer","refresh_token":"`,
- `","expires_in":299,"id_token":"`,
- },
- },
- {
- name: "revoke",
- method: http.MethodGet,
- path: testProvider.RevocationEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- values: map[string]string{
- "token": accessTokenRevoke,
- },
- wantCode: http.StatusOK,
- },
- {
- name: "end session",
- method: http.MethodGet,
- path: testProvider.EndSessionEndpoint().Relative(),
- values: map[string]string{
- "id_token_hint": idToken,
- "client_id": "web",
- },
- wantCode: http.StatusFound,
- headerContains: map[string]string{"Location": "/logged-out"},
- contains: []string{`Found .`},
- },
- {
- name: "keys",
- method: http.MethodGet,
- path: testProvider.KeysEndpoint().Relative(),
- wantCode: http.StatusOK,
- contains: []string{
- `{"keys":[{"use":"sig","kty":"RSA","kid":"`,
- `","alg":"RS256","n":"`, `","e":"AQAB"}]}`,
- },
- },
- {
- name: "device authorization",
- method: http.MethodGet,
- path: testProvider.DeviceAuthorizationEndpoint().Relative(),
- basicAuth: &basicAuth{"device", "secret"},
- values: map[string]string{
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- },
- wantCode: http.StatusOK,
- contains: []string{
- `{"device_code":"`, `","user_code":"`,
- `","verification_uri":"https://localhost:9998/device"`,
- `"verification_uri_complete":"https://localhost:9998/device?user_code=`,
- `","expires_in":300,"interval":5}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- u := gu.PtrCopy(serverURL)
- u.Path = tt.path
- if tt.values != nil {
- u.RawQuery = mapAsValues(tt.values)
- }
- var body io.Reader
- if tt.body != nil {
- body = strings.NewReader(mapAsValues(tt.body))
- }
-
- req := httptest.NewRequest(tt.method, u.String(), body)
- for k, v := range tt.header {
- req.Header.Set(k, v)
- }
- if tt.basicAuth != nil {
- req.SetBasicAuth(tt.basicAuth.username, tt.basicAuth.password)
- }
-
- rec := httptest.NewRecorder()
- testProvider.ServeHTTP(rec, req)
-
- resp := rec.Result()
- require.NoError(t, err)
- assert.Equal(t, tt.wantCode, resp.StatusCode)
-
- respBody, err := io.ReadAll(resp.Body)
- require.NoError(t, err)
-
- respBodyString := string(respBody)
- t.Log(respBodyString)
- t.Log(resp.Header)
-
- if tt.json != "" {
- assert.JSONEq(t, tt.json, respBodyString)
- }
- for _, c := range tt.contains {
- assert.Contains(t, respBodyString, c)
- }
- for k, v := range tt.headerContains {
- assert.Contains(t, resp.Header.Get(k), v)
- }
- })
- }
-}
-
-func TestWithCustomEndpoints(t *testing.T) {
- type args struct {
- auth *op.Endpoint
- token *op.Endpoint
- userInfo *op.Endpoint
- revocation *op.Endpoint
- endSession *op.Endpoint
- keys *op.Endpoint
- }
- tests := []struct {
- name string
- args args
- wantErr error
- }{
- {
- name: "all nil",
- args: args{},
- wantErr: op.ErrNilEndpoint,
- },
- {
- name: "all set",
- args: args{
- auth: op.NewEndpoint("/authorize"),
- token: op.NewEndpoint("/oauth/token"),
- userInfo: op.NewEndpoint("/userinfo"),
- revocation: op.NewEndpoint("/revoke"),
- endSession: op.NewEndpoint("/end_session"),
- keys: op.NewEndpoint("/keys"),
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- provider, err := op.NewOpenIDProvider(testIssuer, testConfig,
- storage.NewStorage(storage.NewUserStore(testIssuer)),
- op.WithCustomEndpoints(tt.args.auth, tt.args.token, tt.args.userInfo, tt.args.revocation, tt.args.endSession, tt.args.keys),
- )
- require.ErrorIs(t, err, tt.wantErr)
- if tt.wantErr != nil {
- return
- }
- assert.Equal(t, tt.args.auth, provider.AuthorizationEndpoint())
- assert.Equal(t, tt.args.token, provider.TokenEndpoint())
- assert.Equal(t, tt.args.userInfo, provider.UserinfoEndpoint())
- assert.Equal(t, tt.args.revocation, provider.RevocationEndpoint())
- assert.Equal(t, tt.args.endSession, provider.EndSessionEndpoint())
- assert.Equal(t, tt.args.keys, provider.KeysEndpoint())
- })
- }
-}
diff --git a/pkg/op/probes.go b/pkg/op/probes.go
index fa713da..7b80fb4 100644
--- a/pkg/op/probes.go
+++ b/pkg/op/probes.go
@@ -5,7 +5,7 @@ import (
"errors"
"net/http"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
+ httphelper "github.com/zitadel/oidc/pkg/http"
)
type ProbesFn func(context.Context) error
@@ -31,6 +31,15 @@ func Readiness(w http.ResponseWriter, r *http.Request, probes ...ProbesFn) {
ok(w)
}
+func ReadySigner(s Signer) ProbesFn {
+ return func(ctx context.Context) error {
+ if s == nil {
+ return errors.New("no signer")
+ }
+ return s.Health(ctx)
+ }
+}
+
func ReadyStorage(s Storage) ProbesFn {
return func(ctx context.Context) error {
if s == nil {
@@ -41,9 +50,9 @@ func ReadyStorage(s Storage) ProbesFn {
}
func ok(w http.ResponseWriter) {
- httphelper.MarshalJSON(w, Status{"ok"})
+ httphelper.MarshalJSON(w, status{"ok"})
}
-type Status struct {
+type status struct {
Status string `json:"status,omitempty"`
}
diff --git a/pkg/op/server.go b/pkg/op/server.go
deleted file mode 100644
index d45b734..0000000
--- a/pkg/op/server.go
+++ /dev/null
@@ -1,350 +0,0 @@
-package op
-
-import (
- "context"
- "net/http"
- "net/url"
-
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/muhlemmer/gu"
-)
-
-// Server describes the interface that needs to be implemented to serve
-// OpenID Connect and Oauth2 standard requests.
-//
-// Methods are called after the HTTP route is resolved and
-// the request body is parsed into the Request's Data field.
-// When a method is called, it can be assumed that required fields,
-// as described in their relevant standard, are validated already.
-// The Response Data field may be of any type to allow flexibility
-// to extend responses with custom fields. There are however requirements
-// in the standards regarding the response models. Where applicable
-// the method documentation gives a recommended type which can be used
-// directly or extended upon.
-//
-// The addition of new methods is not considered a breaking change
-// as defined by semver rules.
-// Implementations MUST embed [UnimplementedServer] to maintain
-// forward compatibility.
-//
-// EXPERIMENTAL: may change until v4
-type Server interface {
- // Health returns a status of "ok" once the Server is listening.
- // The recommended Response Data type is [Status].
- Health(context.Context, *Request[struct{}]) (*Response, error)
-
- // Ready returns a status of "ok" once all dependencies,
- // such as database storage, are ready.
- // An error can be returned to explain what is not ready.
- // The recommended Response Data type is [Status].
- Ready(context.Context, *Request[struct{}]) (*Response, error)
-
- // Discovery returns the OpenID Provider Configuration Information for this server.
- // https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig
- // The recommended Response Data type is [oidc.DiscoveryConfiguration].
- Discovery(context.Context, *Request[struct{}]) (*Response, error)
-
- // Keys serves the JWK set which the client can use verify signatures from the op.
- // https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata `jwks_uri` key.
- // The recommended Response Data type is [jose.JSONWebKeySet].
- Keys(context.Context, *Request[struct{}]) (*Response, error)
-
- // VerifyAuthRequest verifies the Auth Request and
- // adds the Client to the request.
- //
- // When the `request` field is populated with a
- // "Request Object" JWT, it needs to be Validated
- // and its claims overwrite any fields in the AuthRequest.
- // If the implementation does not support "Request Object",
- // it MUST return an [oidc.ErrRequestNotSupported].
- // https://openid.net/specs/openid-connect-core-1_0.html#RequestObject
- VerifyAuthRequest(context.Context, *Request[oidc.AuthRequest]) (*ClientRequest[oidc.AuthRequest], error)
-
- // Authorize initiates the authorization flow and redirects to a login page.
- // See the various https://openid.net/specs/openid-connect-core-1_0.html
- // authorize endpoint sections (one for each type of flow).
- Authorize(context.Context, *ClientRequest[oidc.AuthRequest]) (*Redirect, error)
-
- // DeviceAuthorization initiates the device authorization flow.
- // https://datatracker.ietf.org/doc/html/rfc8628#section-3.1
- // The recommended Response Data type is [oidc.DeviceAuthorizationResponse].
- DeviceAuthorization(context.Context, *ClientRequest[oidc.DeviceAuthorizationRequest]) (*Response, error)
-
- // VerifyClient is called on most oauth/token handlers to authenticate,
- // using either a secret (POST, Basic) or assertion (JWT).
- // If no secrets are provided, the client must be public.
- // This method is called before each method that takes a
- // [ClientRequest] argument.
- VerifyClient(context.Context, *Request[ClientCredentials]) (Client, error)
-
- // CodeExchange returns Tokens after an authorization code
- // is obtained in a successful Authorize flow.
- // It is called by the Token endpoint handler when
- // grant_type has the value authorization_code
- // https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint
- // The recommended Response Data type is [oidc.AccessTokenResponse].
- CodeExchange(context.Context, *ClientRequest[oidc.AccessTokenRequest]) (*Response, error)
-
- // RefreshToken returns new Tokens after verifying a Refresh token.
- // It is called by the Token endpoint handler when
- // grant_type has the value refresh_token
- // https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens
- // The recommended Response Data type is [oidc.AccessTokenResponse].
- RefreshToken(context.Context, *ClientRequest[oidc.RefreshTokenRequest]) (*Response, error)
-
- // JWTProfile handles the OAuth 2.0 JWT Profile Authorization Grant
- // It is called by the Token endpoint handler when
- // grant_type has the value urn:ietf:params:oauth:grant-type:jwt-bearer
- // https://datatracker.ietf.org/doc/html/rfc7523#section-2.1
- // The recommended Response Data type is [oidc.AccessTokenResponse].
- JWTProfile(context.Context, *Request[oidc.JWTProfileGrantRequest]) (*Response, error)
-
- // TokenExchange handles the OAuth 2.0 token exchange grant
- // It is called by the Token endpoint handler when
- // grant_type has the value urn:ietf:params:oauth:grant-type:token-exchange
- // https://datatracker.ietf.org/doc/html/rfc8693
- // The recommended Response Data type is [oidc.AccessTokenResponse].
- TokenExchange(context.Context, *ClientRequest[oidc.TokenExchangeRequest]) (*Response, error)
-
- // ClientCredentialsExchange handles the OAuth 2.0 client credentials grant
- // It is called by the Token endpoint handler when
- // grant_type has the value client_credentials
- // https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
- // The recommended Response Data type is [oidc.AccessTokenResponse].
- ClientCredentialsExchange(context.Context, *ClientRequest[oidc.ClientCredentialsRequest]) (*Response, error)
-
- // DeviceToken handles the OAuth 2.0 Device Authorization Grant
- // It is called by the Token endpoint handler when
- // grant_type has the value urn:ietf:params:oauth:grant-type:device_code.
- // It is typically called in a polling fashion and appropriate errors
- // should be returned to signal authorization_pending or access_denied etc.
- // https://datatracker.ietf.org/doc/html/rfc8628#section-3.4,
- // https://datatracker.ietf.org/doc/html/rfc8628#section-3.5.
- // The recommended Response Data type is [oidc.AccessTokenResponse].
- DeviceToken(context.Context, *ClientRequest[oidc.DeviceAccessTokenRequest]) (*Response, error)
-
- // Introspect handles the OAuth 2.0 Token Introspection endpoint.
- // https://datatracker.ietf.org/doc/html/rfc7662
- // The recommended Response Data type is [oidc.IntrospectionResponse].
- Introspect(context.Context, *Request[IntrospectionRequest]) (*Response, error)
-
- // UserInfo handles the UserInfo endpoint and returns Claims about the authenticated End-User.
- // https://openid.net/specs/openid-connect-core-1_0.html#UserInfo
- // The recommended Response Data type is [oidc.UserInfo].
- UserInfo(context.Context, *Request[oidc.UserInfoRequest]) (*Response, error)
-
- // Revocation handles token revocation using an access or refresh token.
- // https://datatracker.ietf.org/doc/html/rfc7009
- // There are no response requirements. Data may remain empty.
- Revocation(context.Context, *ClientRequest[oidc.RevocationRequest]) (*Response, error)
-
- // EndSession handles the OpenID Connect RP-Initiated Logout.
- // https://openid.net/specs/openid-connect-rpinitiated-1_0.html
- // There are no response requirements. Data may remain empty.
- EndSession(context.Context, *Request[oidc.EndSessionRequest]) (*Redirect, error)
-
- // mustImpl forces implementations to embed the UnimplementedServer for forward
- // compatibility with the interface.
- mustImpl()
-}
-
-// Request contains the [http.Request] informational fields
-// and parsed Data from the request body (POST) or URL parameters (GET).
-// Data can be assumed to be validated according to the applicable
-// standard for the specific endpoints.
-//
-// EXPERIMENTAL: may change until v4
-type Request[T any] struct {
- Method string
- URL *url.URL
- Header http.Header
- Form url.Values
- PostForm url.Values
- Data *T
-}
-
-func (r *Request[_]) path() string {
- return r.URL.Path
-}
-
-func newRequest[T any](r *http.Request, data *T) *Request[T] {
- return &Request[T]{
- Method: r.Method,
- URL: r.URL,
- Header: r.Header,
- Form: r.Form,
- PostForm: r.PostForm,
- Data: data,
- }
-}
-
-// ClientRequest is a Request with a verified client attached to it.
-// Methods that receive this argument may assume the client was authenticated,
-// or verified to be a public client.
-//
-// EXPERIMENTAL: may change until v4
-type ClientRequest[T any] struct {
- *Request[T]
- Client Client
-}
-
-func newClientRequest[T any](r *http.Request, data *T, client Client) *ClientRequest[T] {
- return &ClientRequest[T]{
- Request: newRequest[T](r, data),
- Client: client,
- }
-}
-
-// Response object for most [Server] methods.
-//
-// EXPERIMENTAL: may change until v4
-type Response struct {
- // Header map will be merged with the
- // header on the [http.ResponseWriter].
- Header http.Header
-
- // Data will be JSON marshaled to
- // the response body.
- // We allow any type, so that implementations
- // can extend the standard types as they wish.
- // However, each method will recommend which
- // (base) type to use as model, in order to
- // be compliant with the standards.
- Data any
-}
-
-// NewResponse creates a new response for data,
-// without custom headers.
-func NewResponse(data any) *Response {
- return &Response{
- Header: make(http.Header),
- Data: data,
- }
-}
-
-func (resp *Response) writeOut(w http.ResponseWriter) {
- gu.MapMerge(resp.Header, w.Header())
- httphelper.MarshalJSON(w, resp.Data)
-}
-
-// Redirect is a special response type which will
-// initiate a [http.StatusFound] redirect.
-// The Params field will be encoded and set to the
-// URL's RawQuery field before building the URL.
-//
-// EXPERIMENTAL: may change until v4
-type Redirect struct {
- // Header map will be merged with the
- // header on the [http.ResponseWriter].
- Header http.Header
-
- URL string
-}
-
-func NewRedirect(url string) *Redirect {
- return &Redirect{
- Header: make(http.Header),
- URL: url,
- }
-}
-
-func (red *Redirect) writeOut(w http.ResponseWriter, r *http.Request) {
- gu.MapMerge(red.Header, w.Header())
- http.Redirect(w, r, red.URL, http.StatusFound)
-}
-
-type UnimplementedServer struct{}
-
-// UnimplementedStatusCode is the status code returned for methods
-// that are not yet implemented.
-// Note that this means methods in the sense of the Go interface,
-// and not http methods covered by "501 Not Implemented".
-var UnimplementedStatusCode = http.StatusNotFound
-
-func unimplementedError(r interface{ path() string }) StatusError {
- err := oidc.ErrServerError().WithDescription("%s not implemented on this server", r.path())
- return NewStatusError(err, UnimplementedStatusCode)
-}
-
-func unimplementedGrantError(gt oidc.GrantType) StatusError {
- err := oidc.ErrUnsupportedGrantType().WithDescription("%s not supported", gt)
- return NewStatusError(err, http.StatusBadRequest) // https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
-}
-
-func (UnimplementedServer) mustImpl() {}
-
-func (UnimplementedServer) Health(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) Ready(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) Discovery(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) Keys(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) VerifyAuthRequest(ctx context.Context, r *Request[oidc.AuthRequest]) (*ClientRequest[oidc.AuthRequest], error) {
- if r.Data.RequestParam != "" {
- return nil, oidc.ErrRequestNotSupported()
- }
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) Authorize(ctx context.Context, r *ClientRequest[oidc.AuthRequest]) (*Redirect, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) DeviceAuthorization(ctx context.Context, r *ClientRequest[oidc.DeviceAuthorizationRequest]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) VerifyClient(ctx context.Context, r *Request[ClientCredentials]) (Client, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) CodeExchange(ctx context.Context, r *ClientRequest[oidc.AccessTokenRequest]) (*Response, error) {
- return nil, unimplementedGrantError(oidc.GrantTypeCode)
-}
-
-func (UnimplementedServer) RefreshToken(ctx context.Context, r *ClientRequest[oidc.RefreshTokenRequest]) (*Response, error) {
- return nil, unimplementedGrantError(oidc.GrantTypeRefreshToken)
-}
-
-func (UnimplementedServer) JWTProfile(ctx context.Context, r *Request[oidc.JWTProfileGrantRequest]) (*Response, error) {
- return nil, unimplementedGrantError(oidc.GrantTypeBearer)
-}
-
-func (UnimplementedServer) TokenExchange(ctx context.Context, r *ClientRequest[oidc.TokenExchangeRequest]) (*Response, error) {
- return nil, unimplementedGrantError(oidc.GrantTypeTokenExchange)
-}
-
-func (UnimplementedServer) ClientCredentialsExchange(ctx context.Context, r *ClientRequest[oidc.ClientCredentialsRequest]) (*Response, error) {
- return nil, unimplementedGrantError(oidc.GrantTypeClientCredentials)
-}
-
-func (UnimplementedServer) DeviceToken(ctx context.Context, r *ClientRequest[oidc.DeviceAccessTokenRequest]) (*Response, error) {
- return nil, unimplementedGrantError(oidc.GrantTypeDeviceCode)
-}
-
-func (UnimplementedServer) Introspect(ctx context.Context, r *Request[IntrospectionRequest]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) UserInfo(ctx context.Context, r *Request[oidc.UserInfoRequest]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) Revocation(ctx context.Context, r *ClientRequest[oidc.RevocationRequest]) (*Response, error) {
- return nil, unimplementedError(r)
-}
-
-func (UnimplementedServer) EndSession(ctx context.Context, r *Request[oidc.EndSessionRequest]) (*Redirect, error) {
- return nil, unimplementedError(r)
-}
diff --git a/pkg/op/server_http.go b/pkg/op/server_http.go
deleted file mode 100644
index d71a354..0000000
--- a/pkg/op/server_http.go
+++ /dev/null
@@ -1,524 +0,0 @@
-package op
-
-import (
- "context"
- "log/slog"
- "net/http"
- "net/url"
-
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/go-chi/chi/v5"
- "github.com/rs/cors"
- "github.com/zitadel/logging"
- "github.com/zitadel/schema"
-)
-
-// RegisterServer registers an implementation of Server.
-// The resulting handler takes care of routing and request parsing,
-// with some basic validation of required fields.
-// The routes can be customized with [WithEndpoints].
-//
-// EXPERIMENTAL: may change until v4
-func RegisterServer(server Server, endpoints Endpoints, options ...ServerOption) http.Handler {
- decoder := schema.NewDecoder()
- decoder.IgnoreUnknownKeys(true)
-
- ws := &webServer{
- router: chi.NewRouter(),
- server: server,
- endpoints: endpoints,
- decoder: decoder,
- corsOpts: &defaultCORSOptions,
- logger: slog.Default(),
- }
-
- for _, option := range options {
- option(ws)
- }
-
- ws.createRouter()
- ws.handler = ws.router
- if ws.corsOpts != nil {
- ws.handler = cors.New(*ws.corsOpts).Handler(ws.router)
- }
- return ws
-}
-
-type ServerOption func(s *webServer)
-
-// WithHTTPMiddleware sets the passed middleware chain to the root of
-// the Server's router.
-func WithHTTPMiddleware(m ...func(http.Handler) http.Handler) ServerOption {
- return func(s *webServer) {
- s.router.Use(m...)
- }
-}
-
-// WithSetRouter allows customization or the Server's router.
-func WithSetRouter(set func(chi.Router)) ServerOption {
- return func(s *webServer) {
- set(s.router)
- }
-}
-
-// WithDecoder overrides the default decoder,
-// which is a [schema.Decoder] with IgnoreUnknownKeys set to true.
-func WithDecoder(decoder httphelper.Decoder) ServerOption {
- return func(s *webServer) {
- s.decoder = decoder
- }
-}
-
-// WithServerCORSOptions sets the CORS policy for the Server's router.
-func WithServerCORSOptions(opts *cors.Options) ServerOption {
- return func(s *webServer) {
- s.corsOpts = opts
- }
-}
-
-// WithFallbackLogger overrides the fallback logger, which
-// is used when no logger was found in the context.
-// Defaults to [slog.Default].
-func WithFallbackLogger(logger *slog.Logger) ServerOption {
- return func(s *webServer) {
- s.logger = logger
- }
-}
-
-type webServer struct {
- server Server
- router *chi.Mux
- handler http.Handler
- endpoints Endpoints
- decoder httphelper.Decoder
- corsOpts *cors.Options
- logger *slog.Logger
-}
-
-func (s *webServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
- s.handler.ServeHTTP(w, r)
-}
-
-func (s *webServer) getLogger(ctx context.Context) *slog.Logger {
- if logger, ok := logging.FromContext(ctx); ok {
- return logger
- }
- return s.logger
-}
-
-func (s *webServer) createRouter() {
- s.router.HandleFunc(healthEndpoint, simpleHandler(s, s.server.Health))
- s.router.HandleFunc(readinessEndpoint, simpleHandler(s, s.server.Ready))
- s.router.HandleFunc(oidc.DiscoveryEndpoint, simpleHandler(s, s.server.Discovery))
-
- s.endpointRoute(s.endpoints.Authorization, s.authorizeHandler)
- s.endpointRoute(s.endpoints.DeviceAuthorization, s.withClient(s.deviceAuthorizationHandler))
- s.endpointRoute(s.endpoints.Token, s.tokensHandler)
- s.endpointRoute(s.endpoints.Introspection, s.introspectionHandler)
- s.endpointRoute(s.endpoints.Userinfo, s.userInfoHandler)
- s.endpointRoute(s.endpoints.Revocation, s.withClient(s.revocationHandler))
- s.endpointRoute(s.endpoints.EndSession, s.endSessionHandler)
- s.endpointRoute(s.endpoints.JwksURI, simpleHandler(s, s.server.Keys))
-}
-
-func (s *webServer) endpointRoute(e *Endpoint, hf http.HandlerFunc) {
- if e != nil {
- traceHandler := func(w http.ResponseWriter, r *http.Request) {
- ctx, span := tracer.Start(r.Context(), e.Relative())
- r = r.WithContext(ctx)
- hf(w, r)
- defer span.End()
- }
- s.router.HandleFunc(e.Relative(), traceHandler)
- s.logger.Info("registered route", "endpoint", e.Relative())
- }
-}
-
-type clientHandler func(w http.ResponseWriter, r *http.Request, client Client)
-
-func (s *webServer) withClient(handler clientHandler) http.HandlerFunc {
- return func(w http.ResponseWriter, r *http.Request) {
- ctx, span := tracer.Start(r.Context(), r.URL.Path)
- defer span.End()
- r = r.WithContext(ctx)
-
- client, err := s.verifyRequestClient(r)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if grantType := oidc.GrantType(r.Form.Get("grant_type")); grantType != "" {
- if !ValidateGrantType(client, grantType) {
- WriteError(w, r, oidc.ErrUnauthorizedClient().WithDescription("grant_type %q not allowed", grantType), s.getLogger(r.Context()))
- return
- }
- }
- handler(w, r, client)
- }
-}
-
-func (s *webServer) verifyRequestClient(r *http.Request) (_ Client, err error) {
- cc, err := s.parseClientCredentials(r)
- if err != nil {
- return nil, err
- }
- return s.server.VerifyClient(r.Context(), &Request[ClientCredentials]{
- Method: r.Method,
- URL: r.URL,
- Header: r.Header,
- Form: r.Form,
- Data: cc,
- })
-}
-
-func (s *webServer) parseClientCredentials(r *http.Request) (_ *ClientCredentials, err error) {
- if err := r.ParseForm(); err != nil {
- return nil, oidc.ErrInvalidRequest().WithDescription("error parsing form").WithParent(err)
- }
- cc := new(ClientCredentials)
- if err = s.decoder.Decode(cc, r.Form); err != nil {
- return nil, oidc.ErrInvalidRequest().WithDescription("error decoding form").WithParent(err)
- }
- // Basic auth takes precedence, so if set it overwrites the form data.
- if clientID, clientSecret, ok := r.BasicAuth(); ok {
- cc.ClientID, err = url.QueryUnescape(clientID)
- if err != nil {
- return nil, oidc.ErrInvalidClient().WithDescription("invalid basic auth header").WithParent(err)
- }
- cc.ClientSecret, err = url.QueryUnescape(clientSecret)
- if err != nil {
- return nil, oidc.ErrInvalidClient().WithDescription("invalid basic auth header").WithParent(err)
- }
- }
- if cc.ClientID == "" && cc.ClientAssertion == "" {
- return nil, oidc.ErrInvalidRequest().WithDescription("client_id or client_assertion must be provided")
- }
- if cc.ClientAssertion != "" && cc.ClientAssertionType != oidc.ClientAssertionTypeJWTAssertion {
- return nil, oidc.ErrInvalidRequest().WithDescription("invalid client_assertion_type %s", cc.ClientAssertionType)
- }
- return cc, nil
-}
-
-func (s *webServer) authorizeHandler(w http.ResponseWriter, r *http.Request) {
- request, err := decodeRequest[oidc.AuthRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- redirect, err := s.authorize(r.Context(), newRequest(r, request))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- redirect.writeOut(w, r)
-}
-
-func (s *webServer) authorize(ctx context.Context, r *Request[oidc.AuthRequest]) (_ *Redirect, err error) {
- cr, err := s.server.VerifyAuthRequest(ctx, r)
- if err != nil {
- return nil, err
- }
- authReq := cr.Data
- if authReq.RedirectURI == "" {
- return nil, ErrAuthReqMissingRedirectURI
- }
- authReq.MaxAge, err = ValidateAuthReqPrompt(authReq.Prompt, authReq.MaxAge)
- if err != nil {
- return nil, err
- }
- authReq.Scopes, err = ValidateAuthReqScopes(cr.Client, authReq.Scopes)
- if err != nil {
- return nil, err
- }
- if err := ValidateAuthReqRedirectURI(cr.Client, authReq.RedirectURI, authReq.ResponseType); err != nil {
- return nil, err
- }
- if err := ValidateAuthReqResponseType(cr.Client, authReq.ResponseType); err != nil {
- return nil, err
- }
- return s.server.Authorize(ctx, cr)
-}
-
-func (s *webServer) deviceAuthorizationHandler(w http.ResponseWriter, r *http.Request, client Client) {
- request, err := decodeRequest[oidc.DeviceAuthorizationRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.DeviceAuthorization(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) tokensHandler(w http.ResponseWriter, r *http.Request) {
- if err := r.ParseForm(); err != nil {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("error parsing form").WithParent(err), s.getLogger(r.Context()))
- return
- }
-
- switch grantType := oidc.GrantType(r.Form.Get("grant_type")); grantType {
- case oidc.GrantTypeCode:
- s.withClient(s.codeExchangeHandler)(w, r)
- case oidc.GrantTypeRefreshToken:
- s.withClient(s.refreshTokenHandler)(w, r)
- case oidc.GrantTypeClientCredentials:
- s.withClient(s.clientCredentialsHandler)(w, r)
- case oidc.GrantTypeBearer:
- s.jwtProfileHandler(w, r)
- case oidc.GrantTypeTokenExchange:
- s.withClient(s.tokenExchangeHandler)(w, r)
- case oidc.GrantTypeDeviceCode:
- s.withClient(s.deviceTokenHandler)(w, r)
- case "":
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("grant_type missing"), s.getLogger(r.Context()))
- default:
- WriteError(w, r, unimplementedGrantError(grantType), s.getLogger(r.Context()))
- }
-}
-
-func (s *webServer) jwtProfileHandler(w http.ResponseWriter, r *http.Request) {
- request, err := decodeRequest[oidc.JWTProfileGrantRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.Assertion == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("assertion missing"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.JWTProfile(r.Context(), newRequest(r, request))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) codeExchangeHandler(w http.ResponseWriter, r *http.Request, client Client) {
- request, err := decodeRequest[oidc.AccessTokenRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.Code == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("code missing"), s.getLogger(r.Context()))
- return
- }
- if request.RedirectURI == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("redirect_uri missing"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.CodeExchange(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) refreshTokenHandler(w http.ResponseWriter, r *http.Request, client Client) {
- request, err := decodeRequest[oidc.RefreshTokenRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.RefreshToken == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("refresh_token missing"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.RefreshToken(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) tokenExchangeHandler(w http.ResponseWriter, r *http.Request, client Client) {
- request, err := decodeRequest[oidc.TokenExchangeRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.SubjectToken == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("subject_token missing"), s.getLogger(r.Context()))
- return
- }
- if request.SubjectTokenType == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("subject_token_type missing"), s.getLogger(r.Context()))
- return
- }
- if !request.SubjectTokenType.IsSupported() {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("subject_token_type is not supported"), s.getLogger(r.Context()))
- return
- }
- if request.RequestedTokenType != "" && !request.RequestedTokenType.IsSupported() {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("requested_token_type is not supported"), s.getLogger(r.Context()))
- return
- }
- if request.ActorTokenType != "" && !request.ActorTokenType.IsSupported() {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("actor_token_type is not supported"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.TokenExchange(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) clientCredentialsHandler(w http.ResponseWriter, r *http.Request, client Client) {
- if client.AuthMethod() == oidc.AuthMethodNone {
- WriteError(w, r, oidc.ErrInvalidClient().WithDescription("client must be authenticated"), s.getLogger(r.Context()))
- return
- }
-
- request, err := decodeRequest[oidc.ClientCredentialsRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.ClientCredentialsExchange(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) deviceTokenHandler(w http.ResponseWriter, r *http.Request, client Client) {
- request, err := decodeRequest[oidc.DeviceAccessTokenRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.DeviceCode == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("device_code missing"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.DeviceToken(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) introspectionHandler(w http.ResponseWriter, r *http.Request) {
- cc, err := s.parseClientCredentials(r)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if cc.ClientSecret == "" && cc.ClientAssertion == "" {
- WriteError(w, r, oidc.ErrInvalidClient().WithDescription("client must be authenticated"), s.getLogger(r.Context()))
- return
- }
- request, err := decodeRequest[oidc.IntrospectionRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.Token == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("token missing"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.Introspect(r.Context(), newRequest(r, &IntrospectionRequest{cc, request}))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) userInfoHandler(w http.ResponseWriter, r *http.Request) {
- request, err := decodeRequest[oidc.UserInfoRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if token, err := getAccessToken(r); err == nil {
- request.AccessToken = token
- }
- if request.AccessToken == "" {
- err = NewStatusError(
- oidc.ErrInvalidRequest().WithDescription("access token missing"),
- http.StatusUnauthorized,
- )
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.UserInfo(r.Context(), newRequest(r, request))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) revocationHandler(w http.ResponseWriter, r *http.Request, client Client) {
- request, err := decodeRequest[oidc.RevocationRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- if request.Token == "" {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("token missing"), s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.Revocation(r.Context(), newClientRequest(r, request, client))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
-}
-
-func (s *webServer) endSessionHandler(w http.ResponseWriter, r *http.Request) {
- request, err := decodeRequest[oidc.EndSessionRequest](s.decoder, r, false)
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp, err := s.server.EndSession(r.Context(), newRequest(r, request))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w, r)
-}
-
-func simpleHandler(s *webServer, method func(context.Context, *Request[struct{}]) (*Response, error)) http.HandlerFunc {
- return func(w http.ResponseWriter, r *http.Request) {
- if err := r.ParseForm(); err != nil {
- WriteError(w, r, oidc.ErrInvalidRequest().WithDescription("error parsing form").WithParent(err), s.getLogger(r.Context()))
- return
- }
- resp, err := method(r.Context(), newRequest(r, &struct{}{}))
- if err != nil {
- WriteError(w, r, err, s.getLogger(r.Context()))
- return
- }
- resp.writeOut(w)
- }
-}
-
-func decodeRequest[R any](decoder httphelper.Decoder, r *http.Request, postOnly bool) (*R, error) {
- dst := new(R)
- if err := r.ParseForm(); err != nil {
- return nil, oidc.ErrInvalidRequest().WithDescription("error parsing form").WithParent(err)
- }
- form := r.Form
- if postOnly {
- form = r.PostForm
- }
- if err := decoder.Decode(dst, form); err != nil {
- return nil, oidc.ErrInvalidRequest().WithDescription("error decoding form").WithParent(err)
- }
- return dst, nil
-}
diff --git a/pkg/op/server_http_routes_test.go b/pkg/op/server_http_routes_test.go
deleted file mode 100644
index 02200ee..0000000
--- a/pkg/op/server_http_routes_test.go
+++ /dev/null
@@ -1,345 +0,0 @@
-package op_test
-
-import (
- "context"
- "io"
- "net/http"
- "net/http/httptest"
- "net/url"
- "strings"
- "testing"
- "time"
-
- "github.com/muhlemmer/gu"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/client"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
-)
-
-func jwtProfile() (string, error) {
- keyData, err := client.ConfigFromKeyFile("../../example/server/service-key1.json")
- if err != nil {
- return "", err
- }
- signer, err := client.NewSignerFromPrivateKeyByte([]byte(keyData.Key), keyData.KeyID)
- if err != nil {
- return "", err
- }
- return client.SignedJWTProfileAssertion(keyData.UserID, []string{testIssuer}, time.Hour, signer)
-}
-
-func TestServerRoutes(t *testing.T) {
- server := op.RegisterLegacyServer(op.NewLegacyServer(testProvider, *op.DefaultEndpoints), op.AuthorizeCallbackHandler(testProvider))
-
- storage := testProvider.Storage().(routesTestStorage)
- ctx := op.ContextWithIssuer(context.Background(), testIssuer)
-
- client, err := storage.GetClientByClientID(ctx, "web")
- require.NoError(t, err)
-
- oidcAuthReq := &oidc.AuthRequest{
- ClientID: client.GetID(),
- RedirectURI: "https://example.com",
- MaxAge: gu.Ptr[uint](300),
- Scopes: oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess, oidc.ScopeEmail, oidc.ScopeProfile, oidc.ScopePhone},
- ResponseType: oidc.ResponseTypeCode,
- }
-
- authReq, err := storage.CreateAuthRequest(ctx, oidcAuthReq, "id1")
- require.NoError(t, err)
- storage.AuthRequestDone(authReq.GetID())
-
- accessToken, refreshToken, _, err := op.CreateAccessToken(ctx, authReq, op.AccessTokenTypeBearer, testProvider, client, "")
- require.NoError(t, err)
- accessTokenRevoke, _, _, err := op.CreateAccessToken(ctx, authReq, op.AccessTokenTypeBearer, testProvider, client, "")
- require.NoError(t, err)
- idToken, err := op.CreateIDToken(ctx, testIssuer, authReq, time.Hour, accessToken, "123", storage, client)
- require.NoError(t, err)
- jwtToken, _, _, err := op.CreateAccessToken(ctx, authReq, op.AccessTokenTypeJWT, testProvider, client, "")
- require.NoError(t, err)
- jwtProfileToken, err := jwtProfile()
- require.NoError(t, err)
-
- oidcAuthReq.IDTokenHint = idToken
-
- serverURL, err := url.Parse(testIssuer)
- require.NoError(t, err)
-
- type basicAuth struct {
- username, password string
- }
-
- tests := []struct {
- name string
- method string
- path string
- basicAuth *basicAuth
- header map[string]string
- values map[string]string
- body map[string]string
- wantCode int
- headerContains map[string]string
- json string // test for exact json output
- contains []string // when the body output is not constant, we just check for snippets to be present in the response
- }{
- {
- name: "health",
- method: http.MethodGet,
- path: "/healthz",
- wantCode: http.StatusOK,
- json: `{"status":"ok"}`,
- },
- {
- name: "ready",
- method: http.MethodGet,
- path: "/ready",
- wantCode: http.StatusOK,
- json: `{"status":"ok"}`,
- },
- {
- name: "discovery",
- method: http.MethodGet,
- path: oidc.DiscoveryEndpoint,
- wantCode: http.StatusOK,
- json: `{"issuer":"https://localhost:9998/","authorization_endpoint":"https://localhost:9998/authorize","token_endpoint":"https://localhost:9998/oauth/token","introspection_endpoint":"https://localhost:9998/oauth/introspect","userinfo_endpoint":"https://localhost:9998/userinfo","revocation_endpoint":"https://localhost:9998/revoke","end_session_endpoint":"https://localhost:9998/end_session","device_authorization_endpoint":"https://localhost:9998/device_authorization","jwks_uri":"https://localhost:9998/keys","scopes_supported":["openid","profile","email","phone","address","offline_access"],"response_types_supported":["code","id_token","id_token token"],"grant_types_supported":["authorization_code","implicit","refresh_token","client_credentials","urn:ietf:params:oauth:grant-type:token-exchange","urn:ietf:params:oauth:grant-type:jwt-bearer","urn:ietf:params:oauth:grant-type:device_code"],"subject_types_supported":["public"],"id_token_signing_alg_values_supported":["RS256"],"request_object_signing_alg_values_supported":["RS256"],"token_endpoint_auth_methods_supported":["none","client_secret_basic","client_secret_post","private_key_jwt"],"token_endpoint_auth_signing_alg_values_supported":["RS256"],"revocation_endpoint_auth_methods_supported":["none","client_secret_basic","client_secret_post","private_key_jwt"],"revocation_endpoint_auth_signing_alg_values_supported":["RS256"],"introspection_endpoint_auth_methods_supported":["client_secret_basic","private_key_jwt"],"introspection_endpoint_auth_signing_alg_values_supported":["RS256"],"claims_supported":["sub","aud","exp","iat","iss","auth_time","nonce","acr","amr","c_hash","at_hash","act","scopes","client_id","azp","preferred_username","name","family_name","given_name","locale","email","email_verified","phone_number","phone_number_verified"],"code_challenge_methods_supported":["S256"],"ui_locales_supported":["en"],"request_parameter_supported":true,"request_uri_parameter_supported":false}`,
- },
- {
- name: "authorization",
- method: http.MethodGet,
- path: testProvider.AuthorizationEndpoint().Relative(),
- values: map[string]string{
- "client_id": client.GetID(),
- "redirect_uri": "https://example.com",
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- "response_type": string(oidc.ResponseTypeCode),
- },
- wantCode: http.StatusFound,
- headerContains: map[string]string{"Location": "/login/username?authRequestID="},
- },
- {
- // This call will fail. A successfull test is already
- // part of client/integration_test.go
- name: "code exchange",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeCode),
- "client_id": client.GetID(),
- "client_secret": "secret",
- "redirect_uri": "https://example.com",
- "code": "123",
- },
- wantCode: http.StatusBadRequest,
- json: `{"error":"invalid_grant", "error_description":"invalid code"}`,
- },
- {
- name: "JWT authorization",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeBearer),
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- "assertion": jwtProfileToken,
- },
- wantCode: http.StatusOK,
- contains: []string{`{"access_token":`, `"token_type":"Bearer","expires_in":299,"scope":"openid"}`},
- },
- {
- name: "Token exchange",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeTokenExchange),
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- "subject_token": jwtToken,
- "subject_token_type": string(oidc.AccessTokenType),
- },
- wantCode: http.StatusOK,
- contains: []string{
- `{"access_token":"`,
- `","issued_token_type":"urn:ietf:params:oauth:token-type:refresh_token","token_type":"Bearer","expires_in":299,"scope":"openid offline_access","refresh_token":"`,
- },
- },
- {
- name: "Client credentials exchange",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- basicAuth: &basicAuth{"sid1", "verysecret"},
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeClientCredentials),
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- },
- wantCode: http.StatusOK,
- contains: []string{`{"access_token":"`, `","token_type":"Bearer","expires_in":299,"scope":"openid offline_access"}`},
- },
- {
- // This call will fail. A successful test is already
- // part of device_test.go
- name: "device token",
- method: http.MethodPost,
- path: testProvider.TokenEndpoint().Relative(),
- basicAuth: &basicAuth{"device", "secret"},
- header: map[string]string{
- "Content-Type": "application/x-www-form-urlencoded",
- },
- body: map[string]string{
- "grant_type": string(oidc.GrantTypeDeviceCode),
- "device_code": "123",
- },
- wantCode: http.StatusBadRequest,
- json: `{"error":"access_denied","error_description":"The authorization request was denied."}`,
- },
- {
- name: "missing grant type",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- wantCode: http.StatusBadRequest,
- json: `{"error":"invalid_request","error_description":"grant_type missing"}`,
- },
- {
- name: "unsupported grant type",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": "foo",
- },
- wantCode: http.StatusBadRequest,
- json: `{"error":"unsupported_grant_type","error_description":"foo not supported"}`,
- },
- {
- name: "introspection",
- method: http.MethodGet,
- path: testProvider.IntrospectionEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- values: map[string]string{
- "token": accessToken,
- },
- wantCode: http.StatusOK,
- json: `{"active":true,"scope":"openid offline_access email profile phone","client_id":"web","sub":"id1","username":"test-user@localhost","name":"Test User","given_name":"Test","family_name":"User","locale":"de","preferred_username":"test-user@localhost","email":"test-user@zitadel.ch","email_verified":true}`,
- },
- {
- name: "user info",
- method: http.MethodGet,
- path: testProvider.UserinfoEndpoint().Relative(),
- header: map[string]string{
- "authorization": "Bearer " + accessToken,
- },
- wantCode: http.StatusOK,
- json: `{"sub":"id1","name":"Test User","given_name":"Test","family_name":"User","locale":"de","preferred_username":"test-user@localhost","email":"test-user@zitadel.ch","email_verified":true}`,
- },
- {
- name: "refresh token",
- method: http.MethodGet,
- path: testProvider.TokenEndpoint().Relative(),
- values: map[string]string{
- "grant_type": string(oidc.GrantTypeRefreshToken),
- "refresh_token": refreshToken,
- "client_id": client.GetID(),
- "client_secret": "secret",
- },
- wantCode: http.StatusOK,
- contains: []string{
- `{"access_token":"`,
- `","token_type":"Bearer","refresh_token":"`,
- `","expires_in":299,"id_token":"`,
- },
- },
- {
- name: "revoke",
- method: http.MethodGet,
- path: testProvider.RevocationEndpoint().Relative(),
- basicAuth: &basicAuth{"web", "secret"},
- values: map[string]string{
- "token": accessTokenRevoke,
- },
- wantCode: http.StatusOK,
- },
- {
- name: "end session",
- method: http.MethodGet,
- path: testProvider.EndSessionEndpoint().Relative(),
- values: map[string]string{
- "id_token_hint": idToken,
- "client_id": "web",
- },
- wantCode: http.StatusFound,
- headerContains: map[string]string{"Location": "/logged-out"},
- contains: []string{`Found .`},
- },
- {
- name: "keys",
- method: http.MethodGet,
- path: testProvider.KeysEndpoint().Relative(),
- wantCode: http.StatusOK,
- contains: []string{
- `{"keys":[{"use":"sig","kty":"RSA","kid":"`,
- `","alg":"RS256","n":"`, `","e":"AQAB"}]}`,
- },
- },
- {
- name: "device authorization",
- method: http.MethodGet,
- path: testProvider.DeviceAuthorizationEndpoint().Relative(),
- basicAuth: &basicAuth{"device", "secret"},
- values: map[string]string{
- "scope": oidc.SpaceDelimitedArray{oidc.ScopeOpenID, oidc.ScopeOfflineAccess}.String(),
- },
- wantCode: http.StatusOK,
- contains: []string{
- `{"device_code":"`, `","user_code":"`,
- `","verification_uri":"https://localhost:9998/device"`,
- `"verification_uri_complete":"https://localhost:9998/device?user_code=`,
- `","expires_in":300,"interval":5}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- u := gu.PtrCopy(serverURL)
- u.Path = tt.path
- if tt.values != nil {
- u.RawQuery = mapAsValues(tt.values)
- }
- var body io.Reader
- if tt.body != nil {
- body = strings.NewReader(mapAsValues(tt.body))
- }
-
- req := httptest.NewRequest(tt.method, u.String(), body)
- for k, v := range tt.header {
- req.Header.Set(k, v)
- }
- if tt.basicAuth != nil {
- req.SetBasicAuth(tt.basicAuth.username, tt.basicAuth.password)
- }
-
- rec := httptest.NewRecorder()
- server.ServeHTTP(rec, req)
-
- resp := rec.Result()
- require.NoError(t, err)
- assert.Equal(t, tt.wantCode, resp.StatusCode)
-
- respBody, err := io.ReadAll(resp.Body)
- require.NoError(t, err)
-
- respBodyString := string(respBody)
- t.Log(respBodyString)
- t.Log(resp.Header)
-
- if tt.json != "" {
- assert.JSONEq(t, tt.json, respBodyString)
- }
- for _, c := range tt.contains {
- assert.Contains(t, respBodyString, c)
- }
- for k, v := range tt.headerContains {
- assert.Contains(t, resp.Header.Get(k), v)
- }
- })
- }
-}
diff --git a/pkg/op/server_http_test.go b/pkg/op/server_http_test.go
deleted file mode 100644
index 75d02ca..0000000
--- a/pkg/op/server_http_test.go
+++ /dev/null
@@ -1,1328 +0,0 @@
-package op
-
-import (
- "bytes"
- "context"
- "fmt"
- "io"
- "log/slog"
- "net/http"
- "net/http/httptest"
- "net/url"
- "os"
- "strings"
- "testing"
- "time"
-
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/muhlemmer/gu"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "github.com/zitadel/schema"
-)
-
-func TestRegisterServer(t *testing.T) {
- server := UnimplementedServer{}
- endpoints := Endpoints{
- Authorization: &Endpoint{
- path: "/auth",
- },
- }
- decoder := schema.NewDecoder()
- logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
-
- h := RegisterServer(server, endpoints,
- WithDecoder(decoder),
- WithFallbackLogger(logger),
- )
- got := h.(*webServer)
- assert.Equal(t, got.server, server)
- assert.Equal(t, got.endpoints, endpoints)
- assert.Equal(t, got.decoder, decoder)
- assert.Equal(t, got.logger, logger)
-}
-
-type testClient struct {
- id string
- appType ApplicationType
- authMethod oidc.AuthMethod
- accessTokenType AccessTokenType
- responseTypes []oidc.ResponseType
- grantTypes []oidc.GrantType
- devMode bool
-}
-
-type clientType string
-
-const (
- clientTypeWeb clientType = "web"
- clientTypeNative clientType = "native"
- clientTypeUserAgent clientType = "useragent"
-)
-
-func newClient(kind clientType) *testClient {
- client := &testClient{
- id: string(kind),
- }
-
- switch kind {
- case clientTypeWeb:
- client.appType = ApplicationTypeWeb
- client.authMethod = oidc.AuthMethodBasic
- client.accessTokenType = AccessTokenTypeBearer
- client.responseTypes = []oidc.ResponseType{oidc.ResponseTypeCode}
- case clientTypeNative:
- client.appType = ApplicationTypeNative
- client.authMethod = oidc.AuthMethodNone
- client.accessTokenType = AccessTokenTypeBearer
- client.responseTypes = []oidc.ResponseType{oidc.ResponseTypeCode}
- case clientTypeUserAgent:
- client.appType = ApplicationTypeUserAgent
- client.authMethod = oidc.AuthMethodBasic
- client.accessTokenType = AccessTokenTypeJWT
- client.responseTypes = []oidc.ResponseType{oidc.ResponseTypeIDToken}
- default:
- panic(fmt.Errorf("invalid client type %s", kind))
- }
- return client
-}
-
-func (c *testClient) RedirectURIs() []string {
- return []string{
- "https://registered.com/callback",
- "http://registered.com/callback",
- "http://localhost:9999/callback",
- "custom://callback",
- }
-}
-
-func (c *testClient) PostLogoutRedirectURIs() []string {
- return []string{}
-}
-
-func (c *testClient) LoginURL(id string) string {
- return "login?id=" + id
-}
-
-func (c *testClient) ApplicationType() ApplicationType {
- return c.appType
-}
-
-func (c *testClient) AuthMethod() oidc.AuthMethod {
- return c.authMethod
-}
-
-func (c *testClient) GetID() string {
- return c.id
-}
-
-func (c *testClient) AccessTokenLifetime() time.Duration {
- return 5 * time.Minute
-}
-
-func (c *testClient) IDTokenLifetime() time.Duration {
- return 5 * time.Minute
-}
-
-func (c *testClient) AccessTokenType() AccessTokenType {
- return c.accessTokenType
-}
-
-func (c *testClient) ResponseTypes() []oidc.ResponseType {
- return c.responseTypes
-}
-
-func (c *testClient) GrantTypes() []oidc.GrantType {
- return c.grantTypes
-}
-
-func (c *testClient) DevMode() bool {
- return c.devMode
-}
-
-func (c *testClient) AllowedScopes() []string {
- return nil
-}
-
-func (c *testClient) RestrictAdditionalIdTokenScopes() func(scopes []string) []string {
- return func(scopes []string) []string {
- return scopes
- }
-}
-
-func (c *testClient) RestrictAdditionalAccessTokenScopes() func(scopes []string) []string {
- return func(scopes []string) []string {
- return scopes
- }
-}
-
-func (c *testClient) IsScopeAllowed(scope string) bool {
- return false
-}
-
-func (c *testClient) IDTokenUserinfoClaimsAssertion() bool {
- return false
-}
-
-func (c *testClient) ClockSkew() time.Duration {
- return 0
-}
-
-type requestVerifier struct {
- UnimplementedServer
- client Client
-}
-
-func (s *requestVerifier) VerifyAuthRequest(ctx context.Context, r *Request[oidc.AuthRequest]) (*ClientRequest[oidc.AuthRequest], error) {
- if s.client == nil {
- return nil, oidc.ErrServerError()
- }
- return &ClientRequest[oidc.AuthRequest]{
- Request: r,
- Client: s.client,
- }, nil
-}
-
-func (s *requestVerifier) VerifyClient(ctx context.Context, r *Request[ClientCredentials]) (Client, error) {
- if s.client == nil {
- return nil, oidc.ErrServerError()
- }
- return s.client, nil
-}
-
-var testDecoder = func() *schema.Decoder {
- decoder := schema.NewDecoder()
- decoder.IgnoreUnknownKeys(true)
- return decoder
-}()
-
-type webServerResult struct {
- wantStatus int
- wantBody string
-}
-
-func runWebServerTest(t *testing.T, handler http.HandlerFunc, r *http.Request, want webServerResult) {
- t.Helper()
- if r.Method == http.MethodPost {
- r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
- }
- w := httptest.NewRecorder()
- handler(w, r)
- res := w.Result()
- assert.Equal(t, want.wantStatus, res.StatusCode)
- body, err := io.ReadAll(res.Body)
- require.NoError(t, err)
- assert.JSONEq(t, want.wantBody, string(body))
-}
-
-func Test_webServer_withClient(t *testing.T) {
- tests := []struct {
- name string
- r *http.Request
- want webServerResult
- }{
- {
- name: "parse error",
- r: httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(make([]byte, 11<<20))),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error parsing form"}`,
- },
- },
- {
- name: "invalid grant type",
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("client_id=native&grant_type=bad&foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unauthorized_client", "error_description":"grant_type \"bad\" not allowed"}`,
- },
- },
- {
- name: "no grant type",
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("client_id=native&foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusOK,
- wantBody: `{"foo":"bar"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: &requestVerifier{
- client: newClient(clientTypeNative),
- },
- decoder: testDecoder,
- logger: slog.Default(),
- }
- handler := func(w http.ResponseWriter, r *http.Request, client Client) {
- fmt.Fprintf(w, `{"foo":%q}`, r.FormValue("foo"))
- }
- runWebServerTest(t, s.withClient(handler), tt.r, tt.want)
- })
- }
-}
-
-func Test_webServer_verifyRequestClient(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want Client
- wantErr error
- }{
- {
- name: "parse form error",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(make([]byte, 11<<20))),
- wantErr: oidc.ErrInvalidRequest().WithDescription("error parsing form"),
- },
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- wantErr: oidc.ErrInvalidRequest().WithDescription("error decoding form"),
- },
- {
- name: "basic auth, client_id error",
- decoder: testDecoder,
- r: func() *http.Request {
- r := httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar"))
- r.SetBasicAuth(`%%%`, "secret")
- return r
- }(),
- wantErr: oidc.ErrInvalidClient().WithDescription("invalid basic auth header"),
- },
- {
- name: "basic auth, client_secret error",
- decoder: testDecoder,
- r: func() *http.Request {
- r := httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar"))
- r.SetBasicAuth("web", `%%%`)
- return r
- }(),
- wantErr: oidc.ErrInvalidClient().WithDescription("invalid basic auth header"),
- },
- {
- name: "missing client id and assertion",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- wantErr: oidc.ErrInvalidRequest().WithDescription("client_id or client_assertion must be provided"),
- },
- {
- name: "wrong assertion type",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar&client_assertion=xxx&client_assertion_type=wrong")),
- wantErr: oidc.ErrInvalidRequest().WithDescription("invalid client_assertion_type wrong"),
- },
- {
- name: "unimplemented verify client called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar&client_id=web")),
- wantErr: StatusError{
- parent: oidc.ErrServerError().WithDescription("/ not implemented on this server"),
- statusCode: UnimplementedStatusCode,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- tt.r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
- got, err := s.verifyRequestClient(tt.r)
- require.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_webServer_authorizeHandler(t *testing.T) {
- type fields struct {
- server Server
- decoder httphelper.Decoder
- }
- tests := []struct {
- name string
- fields fields
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- fields: fields{
- server: &requestVerifier{},
- decoder: schema.NewDecoder(),
- },
- r: httptest.NewRequest(http.MethodPost, "/authorize", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "server error",
- fields: fields{
- server: &requestVerifier{},
- decoder: testDecoder,
- },
- r: httptest.NewRequest(http.MethodPost, "/authorize", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusInternalServerError,
- wantBody: `{"error":"server_error"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: tt.fields.server,
- decoder: tt.fields.decoder,
- logger: slog.Default(),
- }
- runWebServerTest(t, s.authorizeHandler, tt.r, tt.want)
- })
- }
-}
-
-func Test_webServer_authorize(t *testing.T) {
- type args struct {
- ctx context.Context
- r *Request[oidc.AuthRequest]
- }
- tests := []struct {
- name string
- server Server
- args args
- want *Redirect
- wantErr error
- }{
- {
- name: "verify error",
- server: &requestVerifier{},
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- Data: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"openid"},
- ResponseType: oidc.ResponseTypeCode,
- ClientID: "web",
- RedirectURI: "https://registered.com/callback",
- MaxAge: gu.Ptr[uint](300),
- },
- },
- },
- wantErr: oidc.ErrServerError(),
- },
- {
- name: "missing redirect",
- server: &requestVerifier{
- client: newClient(clientTypeWeb),
- },
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- Data: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"openid"},
- ResponseType: oidc.ResponseTypeCode,
- ClientID: "web",
- MaxAge: gu.Ptr[uint](300),
- },
- },
- },
- wantErr: ErrAuthReqMissingRedirectURI,
- },
- {
- name: "invalid prompt",
- server: &requestVerifier{
- client: newClient(clientTypeWeb),
- },
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- Data: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"openid"},
- ResponseType: oidc.ResponseTypeCode,
- ClientID: "web",
- RedirectURI: "https://registered.com/callback",
- MaxAge: gu.Ptr[uint](300),
- Prompt: []string{oidc.PromptNone, oidc.PromptLogin},
- },
- },
- },
- wantErr: oidc.ErrInvalidRequest().WithDescription("The prompt parameter `none` must only be used as a single value"),
- },
- {
- name: "missing scopes",
- server: &requestVerifier{
- client: newClient(clientTypeWeb),
- },
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- Data: &oidc.AuthRequest{
- ResponseType: oidc.ResponseTypeCode,
- ClientID: "web",
- RedirectURI: "https://registered.com/callback",
- MaxAge: gu.Ptr[uint](300),
- Prompt: []string{oidc.PromptNone},
- },
- },
- },
- wantErr: oidc.ErrInvalidRequest().
- WithDescription("The scope of your request is missing. Please ensure some scopes are requested. " +
- "If you have any questions, you may contact the administrator of the application."),
- },
- {
- name: "invalid redirect",
- server: &requestVerifier{
- client: newClient(clientTypeWeb),
- },
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- Data: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"openid"},
- ResponseType: oidc.ResponseTypeCode,
- ClientID: "web",
- RedirectURI: "https://example.com/callback",
- MaxAge: gu.Ptr[uint](300),
- Prompt: []string{oidc.PromptNone},
- },
- },
- },
- wantErr: oidc.ErrInvalidRequestRedirectURI().
- WithDescription("The requested redirect_uri is missing in the client configuration. " +
- "If you have any questions, you may contact the administrator of the application."),
- },
- {
- name: "invalid response type",
- server: &requestVerifier{
- client: newClient(clientTypeWeb),
- },
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- Data: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"openid"},
- ResponseType: oidc.ResponseTypeIDToken,
- ClientID: "web",
- RedirectURI: "https://registered.com/callback",
- MaxAge: gu.Ptr[uint](300),
- Prompt: []string{oidc.PromptNone},
- },
- },
- },
- wantErr: oidc.ErrUnauthorizedClient().WithDescription("The requested response type is missing in the client configuration. " +
- "If you have any questions, you may contact the administrator of the application."),
- },
- {
- name: "unimplemented Authorize called",
- server: &requestVerifier{
- client: newClient(clientTypeWeb),
- },
- args: args{
- ctx: context.Background(),
- r: &Request[oidc.AuthRequest]{
- URL: &url.URL{
- Path: "/authorize",
- },
- Data: &oidc.AuthRequest{
- Scopes: oidc.SpaceDelimitedArray{"openid"},
- ResponseType: oidc.ResponseTypeCode,
- ClientID: "web",
- RedirectURI: "https://registered.com/callback",
- MaxAge: gu.Ptr[uint](300),
- Prompt: []string{oidc.PromptNone},
- },
- },
- },
- wantErr: StatusError{
- parent: oidc.ErrServerError().WithDescription("/authorize not implemented on this server"),
- statusCode: UnimplementedStatusCode,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: tt.server,
- decoder: testDecoder,
- logger: slog.Default(),
- }
- got, err := s.authorize(tt.args.ctx, tt.args.r)
- require.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_webServer_deviceAuthorizationHandler(t *testing.T) {
- type fields struct {
- server Server
- decoder httphelper.Decoder
- }
- tests := []struct {
- name string
- fields fields
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- fields: fields{
- server: &requestVerifier{},
- decoder: schema.NewDecoder(),
- },
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "unimplemented DeviceAuthorization called",
- fields: fields{
- server: &requestVerifier{
- client: newClient(clientTypeNative),
- },
- decoder: testDecoder,
- },
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("client_id=native_client")),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: tt.fields.server,
- decoder: tt.fields.decoder,
- logger: slog.Default(),
- }
- client := newClient(clientTypeUserAgent)
- runWebServerClientTest(t, s.deviceAuthorizationHandler, tt.r, client, tt.want)
- })
- }
-}
-
-func Test_webServer_tokensHandler(t *testing.T) {
- tests := []struct {
- name string
- r *http.Request
- want webServerResult
- }{
- {
- name: "parse form error",
- r: httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(make([]byte, 11<<20))),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error parsing form"}`,
- },
- },
- {
- name: "missing grant type",
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"grant_type missing"}`,
- },
- },
- {
- name: "invalid grant type",
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("grant_type=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"bar not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- logger: slog.Default(),
- }
- runWebServerTest(t, s.tokensHandler, tt.r, tt.want)
- })
- }
-}
-
-func Test_webServer_jwtProfileHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "assertion missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"assertion missing"}`,
- },
- },
- {
- name: "unimplemented JWTProfile called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("assertion=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"urn:ietf:params:oauth:grant-type:jwt-bearer not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerTest(t, s.jwtProfileHandler, tt.r, tt.want)
- })
- }
-}
-
-func runWebServerClientTest(t *testing.T, handler func(http.ResponseWriter, *http.Request, Client), r *http.Request, client Client, want webServerResult) {
- t.Helper()
- runWebServerTest(t, func(client Client) http.HandlerFunc {
- return func(w http.ResponseWriter, r *http.Request) {
- handler(w, r, client)
- }
- }(client), r, want)
-}
-
-func Test_webServer_codeExchangeHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "code missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"code missing"}`,
- },
- },
- {
- name: "redirect missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("code=123")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"redirect_uri missing"}`,
- },
- },
- {
- name: "unimplemented CodeExchange called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("code=123&redirect_uri=https://example.com/callback")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"authorization_code not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- client := newClient(clientTypeUserAgent)
- runWebServerClientTest(t, s.codeExchangeHandler, tt.r, client, tt.want)
- })
- }
-}
-
-func Test_webServer_refreshTokenHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "refresh token missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"refresh_token missing"}`,
- },
- },
- {
- name: "unimplemented RefreshToken called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("refresh_token=xxx")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"refresh_token not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- client := newClient(clientTypeUserAgent)
- runWebServerClientTest(t, s.refreshTokenHandler, tt.r, client, tt.want)
- })
- }
-}
-
-func Test_webServer_tokenExchangeHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "subject token missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"subject_token missing"}`,
- },
- },
- {
- name: "subject token type missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("subject_token=xxx")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"subject_token_type missing"}`,
- },
- },
- {
- name: "subject token type unsupported",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("subject_token=xxx&subject_token_type=foo")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"subject_token_type is not supported"}`,
- },
- },
- {
- name: "unsupported requested token type",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("subject_token=xxx&subject_token_type=urn:ietf:params:oauth:token-type:access_token&requested_token_type=foo")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"requested_token_type is not supported"}`,
- },
- },
- {
- name: "unsupported actor token type",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("subject_token=xxx&subject_token_type=urn:ietf:params:oauth:token-type:access_token&requested_token_type=urn:ietf:params:oauth:token-type:access_token&actor_token_type=foo")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"actor_token_type is not supported"}`,
- },
- },
- {
- name: "unimplemented TokenExchange called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("subject_token=xxx&subject_token_type=urn:ietf:params:oauth:token-type:access_token&requested_token_type=urn:ietf:params:oauth:token-type:access_token&actor_token_type=urn:ietf:params:oauth:token-type:access_token")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"urn:ietf:params:oauth:grant-type:token-exchange not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- client := newClient(clientTypeUserAgent)
- runWebServerClientTest(t, s.tokenExchangeHandler, tt.r, client, tt.want)
- })
- }
-}
-
-func Test_webServer_clientCredentialsHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- client Client
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- client: newClient(clientTypeUserAgent),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "public client",
- decoder: testDecoder,
- client: newClient(clientTypeNative),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_client", "error_description":"client must be authenticated"}`,
- },
- },
- {
- name: "unimplemented ClientCredentialsExchange called",
- decoder: testDecoder,
- client: newClient(clientTypeUserAgent),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"client_credentials not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerClientTest(t, s.clientCredentialsHandler, tt.r, tt.client, tt.want)
- })
- }
-}
-
-func Test_webServer_deviceTokenHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "device code missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"device_code missing"}`,
- },
- },
- {
- name: "unimplemented DeviceToken called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("device_code=xxx")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"unsupported_grant_type", "error_description":"urn:ietf:params:oauth:grant-type:device_code not supported"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- client := newClient(clientTypeUserAgent)
- runWebServerClientTest(t, s.deviceTokenHandler, tt.r, client, tt.want)
- })
- }
-}
-
-func Test_webServer_introspectionHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "public client",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("client_id=123")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_client", "error_description":"client must be authenticated"}`,
- },
- },
- {
- name: "token missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("client_id=123&client_secret=SECRET")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"token missing"}`,
- },
- },
- {
- name: "unimplemented Introspect called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("client_id=123&client_secret=SECRET&token=xxx")),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerTest(t, s.introspectionHandler, tt.r, tt.want)
- })
- }
-}
-
-func Test_webServer_userInfoHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "access token missing",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusUnauthorized,
- wantBody: `{"error":"invalid_request", "error_description":"access token missing"}`,
- },
- },
- {
- name: "unimplemented UserInfo called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("access_token=xxx")),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- {
- name: "bearer",
- decoder: testDecoder,
- r: func() *http.Request {
- r := httptest.NewRequest(http.MethodGet, "/", nil)
- r.Header.Set("authorization", strings.Join([]string{"Bearer", "xxx"}, " "))
- return r
- }(),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerTest(t, s.userInfoHandler, tt.r, tt.want)
- })
- }
-}
-
-func Test_webServer_revocationHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- client Client
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- client: newClient(clientTypeWeb),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "token missing",
- decoder: testDecoder,
- client: newClient(clientTypeWeb),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"token missing"}`,
- },
- },
- {
- name: "unimplemented Revocation called, confidential client",
- decoder: testDecoder,
- client: newClient(clientTypeWeb),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("token=xxx")),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- {
- name: "unimplemented Revocation called, public client",
- decoder: testDecoder,
- client: newClient(clientTypeNative),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("token=xxx")),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerClientTest(t, s.revocationHandler, tt.r, tt.client, tt.want)
- })
- }
-}
-
-func Test_webServer_endSessionHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- r *http.Request
- want webServerResult
- }{
- {
- name: "decoder error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error decoding form"}`,
- },
- },
- {
- name: "unimplemented EndSession called",
- decoder: testDecoder,
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("id_token_hint=xxx")),
- want: webServerResult{
- wantStatus: UnimplementedStatusCode,
- wantBody: `{"error":"server_error", "error_description":"/ not implemented on this server"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerTest(t, s.endSessionHandler, tt.r, tt.want)
- })
- }
-}
-
-func Test_webServer_simpleHandler(t *testing.T) {
- tests := []struct {
- name string
- decoder httphelper.Decoder
- method func(context.Context, *Request[struct{}]) (*Response, error)
- r *http.Request
- want webServerResult
- }{
- {
- name: "parse error",
- decoder: schema.NewDecoder(),
- r: httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(make([]byte, 11<<20))),
- want: webServerResult{
- wantStatus: http.StatusBadRequest,
- wantBody: `{"error":"invalid_request", "error_description":"error parsing form"}`,
- },
- },
- {
- name: "method error",
- decoder: schema.NewDecoder(),
- method: func(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- return nil, io.ErrClosedPipe
- },
- r: httptest.NewRequest(http.MethodGet, "/", bytes.NewReader(make([]byte, 11<<20))),
- want: webServerResult{
- wantStatus: http.StatusInternalServerError,
- wantBody: `{"error":"server_error", "error_description":"io: read/write on closed pipe"}`,
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- s := &webServer{
- server: UnimplementedServer{},
- decoder: tt.decoder,
- logger: slog.Default(),
- }
- runWebServerTest(t, simpleHandler(s, tt.method), tt.r, tt.want)
- })
- }
-}
-
-func Test_decodeRequest(t *testing.T) {
- type dst struct {
- A string `schema:"a"`
- B string `schema:"b"`
- }
- type args struct {
- r *http.Request
- postOnly bool
- }
- tests := []struct {
- name string
- args args
- want *dst
- wantErr error
- }{
- {
- name: "parse error",
- args: args{
- r: httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(make([]byte, 11<<20))),
- },
- wantErr: oidc.ErrInvalidRequest().WithDescription("error parsing form"),
- },
- {
- name: "decode error",
- args: args{
- r: httptest.NewRequest(http.MethodPost, "/", strings.NewReader("foo=bar")),
- },
- wantErr: oidc.ErrInvalidRequest().WithDescription("error decoding form"),
- },
- {
- name: "success, get",
- args: args{
- r: httptest.NewRequest(http.MethodGet, "/?a=b&b=a", nil),
- },
- want: &dst{
- A: "b",
- B: "a",
- },
- },
- {
- name: "success, post only",
- args: args{
- r: httptest.NewRequest(http.MethodPost, "/?b=a", strings.NewReader("a=b&")),
- postOnly: true,
- },
- want: &dst{
- A: "b",
- },
- },
- {
- name: "success, post mixed",
- args: args{
- r: httptest.NewRequest(http.MethodPost, "/?b=a", strings.NewReader("a=b&")),
- postOnly: false,
- },
- want: &dst{
- A: "b",
- B: "a",
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- if tt.args.r.Method == http.MethodPost {
- tt.args.r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
- }
- got, err := decodeRequest[dst](schema.NewDecoder(), tt.args.r, tt.args.postOnly)
- require.ErrorIs(t, err, tt.wantErr)
- assert.Equal(t, tt.want, got)
- })
- }
-}
diff --git a/pkg/op/server_legacy.go b/pkg/op/server_legacy.go
deleted file mode 100644
index 06e4e93..0000000
--- a/pkg/op/server_legacy.go
+++ /dev/null
@@ -1,457 +0,0 @@
-package op
-
-import (
- "context"
- "errors"
- "net/http"
- "time"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/go-chi/chi/v5"
-)
-
-// ExtendedLegacyServer allows embedding [LegacyServer] in a struct,
-// so that its methods can be individually overridden.
-//
-// EXPERIMENTAL: may change until v4
-type ExtendedLegacyServer interface {
- Server
- Provider() OpenIDProvider
- Endpoints() Endpoints
- AuthCallbackURL() func(context.Context, string) string
-}
-
-// RegisterLegacyServer registers a [LegacyServer] or an extension thereof.
-// It takes care of registering the IssuerFromRequest middleware.
-// The authorizeCallbackHandler is registered on `/callback` under the authorization endpoint.
-// Neither are part of the bare [Server] interface.
-//
-// EXPERIMENTAL: may change until v4
-func RegisterLegacyServer(s ExtendedLegacyServer, authorizeCallbackHandler http.HandlerFunc, options ...ServerOption) http.Handler {
- options = append(options,
- WithHTTPMiddleware(intercept(s.Provider().IssuerFromRequest)),
- WithSetRouter(func(r chi.Router) {
- r.HandleFunc(s.Endpoints().Authorization.Relative()+authCallbackPathSuffix, authorizeCallbackHandler)
- }),
- )
- return RegisterServer(s, s.Endpoints(), options...)
-}
-
-// LegacyServer is an implementation of [Server] that
-// simply wraps an [OpenIDProvider].
-// It can be used to transition from the former Provider/Storage
-// interfaces to the new Server interface.
-//
-// EXPERIMENTAL: may change until v4
-type LegacyServer struct {
- UnimplementedServer
- provider OpenIDProvider
- endpoints Endpoints
-}
-
-// NewLegacyServer wraps provider in a `Server` implementation
-//
-// Only non-nil endpoints will be registered on the router.
-// Nil endpoints are disabled.
-//
-// The passed endpoints is also used for the discovery config,
-// and endpoints already set to the provider are ignored.
-// Any `With*Endpoint()` option used on the provider is
-// therefore ineffective.
-//
-// EXPERIMENTAL: may change until v4
-func NewLegacyServer(provider OpenIDProvider, endpoints Endpoints) *LegacyServer {
- return &LegacyServer{
- provider: provider,
- endpoints: endpoints,
- }
-}
-
-func (s *LegacyServer) Provider() OpenIDProvider {
- return s.provider
-}
-
-func (s *LegacyServer) Endpoints() Endpoints {
- return s.endpoints
-}
-
-// AuthCallbackURL builds the url for the redirect (with the requestID) after a successful login
-func (s *LegacyServer) AuthCallbackURL() func(context.Context, string) string {
- return func(ctx context.Context, requestID string) string {
- ctx, span := tracer.Start(ctx, "LegacyServer.AuthCallbackURL")
- defer span.End()
-
- return s.endpoints.Authorization.Absolute(IssuerFromContext(ctx)) + authCallbackPathSuffix + "?id=" + requestID
- }
-}
-
-func (s *LegacyServer) Health(_ context.Context, r *Request[struct{}]) (*Response, error) {
- return NewResponse(Status{Status: "ok"}), nil
-}
-
-func (s *LegacyServer) Ready(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- for _, probe := range s.provider.Probes() {
- // shouldn't we run probes in Go routines?
- if err := probe(ctx); err != nil {
- return nil, AsStatusError(err, http.StatusInternalServerError)
- }
- }
- return NewResponse(Status{Status: "ok"}), nil
-}
-
-func (s *LegacyServer) Discovery(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.Discovery")
- defer span.End()
-
- return NewResponse(
- createDiscoveryConfigV2(ctx, s.provider, s.provider.Storage(), &s.endpoints),
- ), nil
-}
-
-func (s *LegacyServer) Keys(ctx context.Context, r *Request[struct{}]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.Keys")
- defer span.End()
-
- keys, err := s.provider.Storage().KeySet(ctx)
- if err != nil {
- return nil, AsStatusError(err, http.StatusInternalServerError)
- }
- return NewResponse(jsonWebKeySet(keys)), nil
-}
-
-var (
- ErrAuthReqMissingClientID = errors.New("auth request is missing client_id")
- ErrAuthReqMissingRedirectURI = errors.New("auth request is missing redirect_uri")
-)
-
-func (s *LegacyServer) VerifyAuthRequest(ctx context.Context, r *Request[oidc.AuthRequest]) (*ClientRequest[oidc.AuthRequest], error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.VerifyAuthRequest")
- defer span.End()
-
- if r.Data.RequestParam != "" {
- if !s.provider.RequestObjectSupported() {
- return nil, oidc.ErrRequestNotSupported()
- }
- err := ParseRequestObject(ctx, r.Data, s.provider.Storage(), IssuerFromContext(ctx))
- if err != nil {
- return nil, err
- }
- }
- if r.Data.ClientID == "" {
- return nil, oidc.ErrInvalidRequest().WithParent(ErrAuthReqMissingClientID).WithDescription(ErrAuthReqMissingClientID.Error())
- }
- client, err := s.provider.Storage().GetClientByClientID(ctx, r.Data.ClientID)
- if err != nil {
- return nil, oidc.DefaultToServerError(err, "unable to retrieve client by id")
- }
-
- return &ClientRequest[oidc.AuthRequest]{
- Request: r,
- Client: client,
- }, nil
-}
-
-func (s *LegacyServer) Authorize(ctx context.Context, r *ClientRequest[oidc.AuthRequest]) (_ *Redirect, err error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.Authorize")
- defer span.End()
-
- userID, err := ValidateAuthReqIDTokenHint(ctx, r.Data.IDTokenHint, s.provider.IDTokenHintVerifier(ctx))
- if err != nil {
- return nil, err
- }
- req, err := s.provider.Storage().CreateAuthRequest(ctx, r.Data, userID)
- if err != nil {
- return TryErrorRedirect(ctx, r.Data, oidc.DefaultToServerError(err, "unable to save auth request"), s.provider.Encoder(), s.provider.Logger())
- }
- return NewRedirect(r.Client.LoginURL(req.GetID())), nil
-}
-
-func (s *LegacyServer) DeviceAuthorization(ctx context.Context, r *ClientRequest[oidc.DeviceAuthorizationRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.DeviceAuthorization")
- defer span.End()
-
- response, err := createDeviceAuthorization(ctx, r.Data, r.Client.GetID(), s.provider)
- if err != nil {
- return nil, AsStatusError(err, http.StatusInternalServerError)
- }
- return NewResponse(response), nil
-}
-
-func (s *LegacyServer) VerifyClient(ctx context.Context, r *Request[ClientCredentials]) (Client, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.VerifyClient")
- defer span.End()
-
- if oidc.GrantType(r.Form.Get("grant_type")) == oidc.GrantTypeClientCredentials {
- storage, ok := s.provider.Storage().(ClientCredentialsStorage)
- if !ok {
- return nil, oidc.ErrUnsupportedGrantType().WithDescription("client_credentials grant not supported")
- }
- return storage.ClientCredentials(ctx, r.Data.ClientID, r.Data.ClientSecret)
- }
-
- if r.Data.ClientAssertionType == oidc.ClientAssertionTypeJWTAssertion {
- jwtExchanger, ok := s.provider.(JWTAuthorizationGrantExchanger)
- if !ok || !s.provider.AuthMethodPrivateKeyJWTSupported() {
- return nil, oidc.ErrInvalidClient().WithDescription("auth_method private_key_jwt not supported")
- }
- return AuthorizePrivateJWTKey(ctx, r.Data.ClientAssertion, jwtExchanger)
- }
- client, err := s.provider.Storage().GetClientByClientID(ctx, r.Data.ClientID)
- if err != nil {
- return nil, oidc.ErrInvalidClient().WithParent(err)
- }
-
- switch client.AuthMethod() {
- case oidc.AuthMethodNone:
- return client, nil
- case oidc.AuthMethodPrivateKeyJWT:
- return nil, oidc.ErrInvalidClient().WithDescription("private_key_jwt not allowed for this client")
- case oidc.AuthMethodPost:
- if !s.provider.AuthMethodPostSupported() {
- return nil, oidc.ErrInvalidClient().WithDescription("auth_method post not supported")
- }
- }
-
- err = AuthorizeClientIDSecret(ctx, r.Data.ClientID, r.Data.ClientSecret, s.provider.Storage())
- if err != nil {
- return nil, err
- }
-
- return client, nil
-}
-
-func (s *LegacyServer) CodeExchange(ctx context.Context, r *ClientRequest[oidc.AccessTokenRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.CodeExchange")
- defer span.End()
-
- authReq, err := AuthRequestByCode(ctx, s.provider.Storage(), r.Data.Code)
- if err != nil {
- return nil, err
- }
- if r.Client.AuthMethod() == oidc.AuthMethodNone || r.Data.CodeVerifier != "" {
- if err = AuthorizeCodeChallenge(r.Data.CodeVerifier, authReq.GetCodeChallenge()); err != nil {
- return nil, err
- }
- }
- if r.Data.RedirectURI != authReq.GetRedirectURI() {
- return nil, oidc.ErrInvalidGrant().WithDescription("redirect_uri does not correspond")
- }
- resp, err := CreateTokenResponse(ctx, authReq, r.Client, s.provider, true, r.Data.Code, "")
- if err != nil {
- return nil, err
- }
- return NewResponse(resp), nil
-}
-
-func (s *LegacyServer) RefreshToken(ctx context.Context, r *ClientRequest[oidc.RefreshTokenRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.RefreshToken")
- defer span.End()
-
- if !s.provider.GrantTypeRefreshTokenSupported() {
- return nil, unimplementedGrantError(oidc.GrantTypeRefreshToken)
- }
- request, err := RefreshTokenRequestByRefreshToken(ctx, s.provider.Storage(), r.Data.RefreshToken)
- if err != nil {
- return nil, err
- }
- if r.Client.GetID() != request.GetClientID() {
- return nil, oidc.ErrInvalidGrant()
- }
- if err = ValidateRefreshTokenScopes(r.Data.Scopes, request); err != nil {
- return nil, err
- }
- resp, err := CreateTokenResponse(ctx, request, r.Client, s.provider, true, "", r.Data.RefreshToken)
- if err != nil {
- return nil, err
- }
- return NewResponse(resp), nil
-}
-
-func (s *LegacyServer) JWTProfile(ctx context.Context, r *Request[oidc.JWTProfileGrantRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.JWTProfile")
- defer span.End()
-
- exchanger, ok := s.provider.(JWTAuthorizationGrantExchanger)
- if !ok {
- return nil, unimplementedGrantError(oidc.GrantTypeBearer)
- }
- tokenRequest, err := VerifyJWTAssertion(ctx, r.Data.Assertion, exchanger.JWTProfileVerifier(ctx))
- if err != nil {
- return nil, oidc.ErrInvalidRequest().WithParent(err).WithDescription("assertion invalid")
- }
-
- tokenRequest.Scopes, err = exchanger.Storage().ValidateJWTProfileScopes(ctx, tokenRequest.Issuer, r.Data.Scope)
- if err != nil {
- return nil, err
- }
- resp, err := CreateJWTTokenResponse(ctx, tokenRequest, exchanger)
- if err != nil {
- return nil, err
- }
- return NewResponse(resp), nil
-}
-
-func (s *LegacyServer) TokenExchange(ctx context.Context, r *ClientRequest[oidc.TokenExchangeRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.TokenExchange")
- defer span.End()
-
- if !s.provider.GrantTypeTokenExchangeSupported() {
- return nil, unimplementedGrantError(oidc.GrantTypeTokenExchange)
- }
- tokenExchangeRequest, err := CreateTokenExchangeRequest(ctx, r.Data, r.Client, s.provider)
- if err != nil {
- return nil, err
- }
- resp, err := CreateTokenExchangeResponse(ctx, tokenExchangeRequest, r.Client, s.provider)
- if err != nil {
- return nil, err
- }
- return NewResponse(resp), nil
-}
-
-func (s *LegacyServer) ClientCredentialsExchange(ctx context.Context, r *ClientRequest[oidc.ClientCredentialsRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.ClientCredentialsExchange")
- defer span.End()
-
- storage, ok := s.provider.Storage().(ClientCredentialsStorage)
- if !ok {
- return nil, unimplementedGrantError(oidc.GrantTypeClientCredentials)
- }
- tokenRequest, err := storage.ClientCredentialsTokenRequest(ctx, r.Client.GetID(), r.Data.Scope)
- if err != nil {
- return nil, err
- }
- resp, err := CreateClientCredentialsTokenResponse(ctx, tokenRequest, s.provider, r.Client)
- if err != nil {
- return nil, err
- }
- return NewResponse(resp), nil
-}
-
-func (s *LegacyServer) DeviceToken(ctx context.Context, r *ClientRequest[oidc.DeviceAccessTokenRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.DeviceToken")
- defer span.End()
-
- if !s.provider.GrantTypeDeviceCodeSupported() {
- return nil, unimplementedGrantError(oidc.GrantTypeDeviceCode)
- }
- // use a limited context timeout shorter as the default
- // poll interval of 5 seconds.
- ctx, cancel := context.WithTimeout(ctx, 4*time.Second)
- defer cancel()
-
- tokenRequest, err := CheckDeviceAuthorizationState(ctx, r.Client.GetID(), r.Data.DeviceCode, s.provider)
- if err != nil {
- return nil, err
- }
- resp, err := CreateDeviceTokenResponse(ctx, tokenRequest, s.provider, r.Client)
- if err != nil {
- return nil, err
- }
- return NewResponse(resp), nil
-}
-
-func (s *LegacyServer) authenticateResourceClient(ctx context.Context, cc *ClientCredentials) (string, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.authenticateResourceClient")
- defer span.End()
-
- if cc.ClientAssertion != "" {
- if jp, ok := s.provider.(ClientJWTProfile); ok {
- return ClientJWTAuth(ctx, oidc.ClientAssertionParams{ClientAssertion: cc.ClientAssertion}, jp)
- }
- return "", oidc.ErrInvalidClient().WithDescription("client_assertion not supported")
- }
- if err := s.provider.Storage().AuthorizeClientIDSecret(ctx, cc.ClientID, cc.ClientSecret); err != nil {
- return "", oidc.ErrUnauthorizedClient().WithParent(err)
- }
- return cc.ClientID, nil
-}
-
-func (s *LegacyServer) Introspect(ctx context.Context, r *Request[IntrospectionRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.Introspect")
- defer span.End()
-
- clientID, err := s.authenticateResourceClient(ctx, r.Data.ClientCredentials)
- if err != nil {
- return nil, err
- }
- response := new(oidc.IntrospectionResponse)
- tokenID, subject, ok := getTokenIDAndSubject(ctx, s.provider, r.Data.Token)
- if !ok {
- return NewResponse(response), nil
- }
- err = s.provider.Storage().SetIntrospectionFromToken(ctx, response, tokenID, subject, clientID)
- if err != nil {
- return NewResponse(response), nil
- }
- response.Active = true
- return NewResponse(response), nil
-}
-
-func (s *LegacyServer) UserInfo(ctx context.Context, r *Request[oidc.UserInfoRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.UserInfo")
- defer span.End()
-
- tokenID, subject, ok := getTokenIDAndSubject(ctx, s.provider, r.Data.AccessToken)
- if !ok {
- return nil, NewStatusError(oidc.ErrAccessDenied().WithDescription("access token invalid"), http.StatusUnauthorized)
- }
- info := new(oidc.UserInfo)
- err := s.provider.Storage().SetUserinfoFromToken(ctx, info, tokenID, subject, r.Header.Get("origin"))
- if err != nil {
- return nil, NewStatusError(err, http.StatusForbidden)
- }
- return NewResponse(info), nil
-}
-
-func (s *LegacyServer) Revocation(ctx context.Context, r *ClientRequest[oidc.RevocationRequest]) (*Response, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.Revocation")
- defer span.End()
-
- var subject string
- doDecrypt := true
- if r.Data.TokenTypeHint != "access_token" {
- userID, tokenID, err := s.provider.Storage().GetRefreshTokenInfo(ctx, r.Client.GetID(), r.Data.Token)
- if err != nil {
- // An invalid refresh token means that we'll try other things (leaving doDecrypt==true)
- if !errors.Is(err, ErrInvalidRefreshToken) {
- return nil, RevocationError(oidc.ErrServerError().WithParent(err))
- }
- } else {
- r.Data.Token = tokenID
- subject = userID
- doDecrypt = false
- }
- }
- if doDecrypt {
- tokenID, userID, ok := getTokenIDAndSubjectForRevocation(ctx, s.provider, r.Data.Token)
- if ok {
- r.Data.Token = tokenID
- subject = userID
- }
- }
- if err := s.provider.Storage().RevokeToken(ctx, r.Data.Token, subject, r.Client.GetID()); err != nil {
- return nil, RevocationError(err)
- }
- return NewResponse(nil), nil
-}
-
-func (s *LegacyServer) EndSession(ctx context.Context, r *Request[oidc.EndSessionRequest]) (*Redirect, error) {
- ctx, span := tracer.Start(ctx, "LegacyServer.EndSession")
- defer span.End()
-
- session, err := ValidateEndSessionRequest(ctx, r.Data, s.provider)
- if err != nil {
- return nil, err
- }
- redirect := session.RedirectURI
- if fromRequest, ok := s.provider.Storage().(CanTerminateSessionFromRequest); ok {
- redirect, err = fromRequest.TerminateSessionFromRequest(ctx, session)
- } else {
- err = s.provider.Storage().TerminateSession(ctx, session.UserID, session.ClientID)
- }
- if err != nil {
- return nil, err
- }
- return NewRedirect(redirect), nil
-}
diff --git a/pkg/op/server_test.go b/pkg/op/server_test.go
deleted file mode 100644
index 0cad8fd..0000000
--- a/pkg/op/server_test.go
+++ /dev/null
@@ -1,5 +0,0 @@
-package op
-
-// implementation check
-var _ Server = &UnimplementedServer{}
-var _ Server = &LegacyServer{}
diff --git a/pkg/op/session.go b/pkg/op/session.go
index ac663c9..737bb86 100644
--- a/pkg/op/session.go
+++ b/pkg/op/session.go
@@ -2,22 +2,19 @@ package op
import (
"context"
- "errors"
- "log/slog"
"net/http"
"net/url"
"path"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type SessionEnder interface {
Decoder() httphelper.Decoder
Storage() Storage
- IDTokenHintVerifier(context.Context) *IDTokenHintVerifier
+ IDTokenHintVerifier() IDTokenHintVerifier
DefaultLogoutRedirectURI() string
- Logger() *slog.Logger
}
func endSessionHandler(ender SessionEnder) func(http.ResponseWriter, *http.Request) {
@@ -27,10 +24,6 @@ func endSessionHandler(ender SessionEnder) func(http.ResponseWriter, *http.Reque
}
func EndSession(w http.ResponseWriter, r *http.Request, ender SessionEnder) {
- ctx, span := tracer.Start(r.Context(), "EndSession")
- defer span.End()
- r = r.WithContext(ctx)
-
req, err := ParseEndSessionRequest(r, ender.Decoder())
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
@@ -38,20 +31,15 @@ func EndSession(w http.ResponseWriter, r *http.Request, ender SessionEnder) {
}
session, err := ValidateEndSessionRequest(r.Context(), req, ender)
if err != nil {
- RequestError(w, r, err, ender.Logger())
+ RequestError(w, r, err)
return
}
- redirect := session.RedirectURI
- if fromRequest, ok := ender.Storage().(CanTerminateSessionFromRequest); ok {
- redirect, err = fromRequest.TerminateSessionFromRequest(r.Context(), session)
- } else {
- err = ender.Storage().TerminateSession(r.Context(), session.UserID, session.ClientID)
- }
+ err = ender.Storage().TerminateSession(r.Context(), session.UserID, session.ClientID)
if err != nil {
- RequestError(w, r, oidc.DefaultToServerError(err, "error terminating session"), ender.Logger())
+ RequestError(w, r, oidc.DefaultToServerError(err, "error terminating session"))
return
}
- http.Redirect(w, r, redirect, http.StatusFound)
+ http.Redirect(w, r, session.RedirectURI, http.StatusFound)
}
func ParseEndSessionRequest(r *http.Request, decoder httphelper.Decoder) (*oidc.EndSessionRequest, error) {
@@ -68,21 +56,15 @@ func ParseEndSessionRequest(r *http.Request, decoder httphelper.Decoder) (*oidc.
}
func ValidateEndSessionRequest(ctx context.Context, req *oidc.EndSessionRequest, ender SessionEnder) (*EndSessionRequest, error) {
- ctx, span := tracer.Start(ctx, "ValidateEndSessionRequest")
- defer span.End()
-
session := &EndSessionRequest{
RedirectURI: ender.DefaultLogoutRedirectURI(),
- LogoutHint: req.LogoutHint,
- UILocales: req.UILocales,
}
if req.IdTokenHint != "" {
- claims, err := VerifyIDTokenHint[*oidc.IDTokenClaims](ctx, req.IdTokenHint, ender.IDTokenHintVerifier(ctx))
- if err != nil && !errors.As(err, &IDTokenHintExpiredError{}) {
+ claims, err := VerifyIDTokenHint(ctx, req.IdTokenHint, ender.IDTokenHintVerifier())
+ if err != nil {
return nil, oidc.ErrInvalidRequest().WithDescription("id_token_hint invalid").WithParent(err)
}
session.UserID = claims.GetSubject()
- session.IDTokenHintClaims = claims
if req.ClientID != "" && req.ClientID != claims.GetAuthorizedParty() {
return nil, oidc.ErrInvalidRequest().WithDescription("client_id does not match azp of id_token_hint")
}
diff --git a/pkg/op/signer.go b/pkg/op/signer.go
index 5c3dd6a..828876e 100644
--- a/pkg/op/signer.go
+++ b/pkg/op/signer.go
@@ -1,36 +1,88 @@
package op
import (
+ "context"
"errors"
+ "sync"
- jose "github.com/go-jose/go-jose/v4"
+ "github.com/zitadel/logging"
+ "gopkg.in/square/go-jose.v2"
)
-var ErrSignerCreationFailed = errors.New("signer creation failed")
-
-type SigningKey interface {
+type Signer interface {
+ Health(ctx context.Context) error
+ Signer() jose.Signer
SignatureAlgorithm() jose.SignatureAlgorithm
- Key() any
- ID() string
}
-func SignerFromKey(key SigningKey) (jose.Signer, error) {
- signer, err := jose.NewSigner(jose.SigningKey{
- Algorithm: key.SignatureAlgorithm(),
- Key: &jose.JSONWebKey{
- Key: key.Key(),
- KeyID: key.ID(),
- },
- }, (&jose.SignerOptions{}).WithType("JWT"))
- if err != nil {
- return nil, ErrSignerCreationFailed // TODO: log / wrap error?
+type tokenSigner struct {
+ signer jose.Signer
+ storage AuthStorage
+ alg jose.SignatureAlgorithm
+ lock sync.RWMutex
+}
+
+func NewSigner(ctx context.Context, storage AuthStorage, keyCh <-chan jose.SigningKey) Signer {
+ s := &tokenSigner{
+ storage: storage,
}
- return signer, nil
+
+ select {
+ case <-ctx.Done():
+ return nil
+ case key := <-keyCh:
+ s.exchangeSigningKey(key)
+ }
+ go s.refreshSigningKey(ctx, keyCh)
+
+ return s
}
-type Key interface {
- ID() string
- Algorithm() jose.SignatureAlgorithm
- Use() string
- Key() any
+func (s *tokenSigner) Health(_ context.Context) error {
+ if s.signer == nil {
+ return errors.New("no signer")
+ }
+ if string(s.alg) == "" {
+ return errors.New("no signing algorithm")
+ }
+ return nil
+}
+
+func (s *tokenSigner) Signer() jose.Signer {
+ s.lock.RLock()
+ defer s.lock.RUnlock()
+ return s.signer
+}
+
+func (s *tokenSigner) refreshSigningKey(ctx context.Context, keyCh <-chan jose.SigningKey) {
+ for {
+ select {
+ case <-ctx.Done():
+ return
+ case key := <-keyCh:
+ s.exchangeSigningKey(key)
+ }
+ }
+}
+
+func (s *tokenSigner) exchangeSigningKey(key jose.SigningKey) {
+ s.lock.Lock()
+ defer s.lock.Unlock()
+ s.alg = key.Algorithm
+ if key.Algorithm == "" || key.Key == nil {
+ s.signer = nil
+ logging.Warn("signer has no key")
+ return
+ }
+ var err error
+ s.signer, err = jose.NewSigner(key, &jose.SignerOptions{})
+ if err != nil {
+ logging.New().WithError(err).Error("error creating signer")
+ return
+ }
+ logging.Info("signer exchanged signing key")
+}
+
+func (s *tokenSigner) SignatureAlgorithm() jose.SignatureAlgorithm {
+ return s.alg
}
diff --git a/pkg/op/storage.go b/pkg/op/storage.go
index 2dbd124..28fc6a3 100644
--- a/pkg/op/storage.go
+++ b/pkg/op/storage.go
@@ -5,10 +5,9 @@ import (
"errors"
"time"
- jose "github.com/go-jose/go-jose/v4"
- "golang.org/x/text/language"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type AuthStorage interface {
@@ -26,8 +25,6 @@ type AuthStorage interface {
//
// * *oidc.JWTTokenRequest from a JWT that is the assertion value of a JWT Profile
// Grant: https://datatracker.ietf.org/doc/html/rfc7523#section-2.1
- //
- // * TokenExchangeRequest as returned by ValidateTokenExchangeRequest
CreateAccessToken(context.Context, TokenRequest) (accessTokenID string, expiration time.Time, err error)
// The TokenRequest parameter of CreateAccessAndRefreshTokens can be any of:
@@ -39,8 +36,6 @@ type AuthStorage interface {
// * AuthRequest as by returned by the AuthRequestByID or AuthRequestByCode (above).
// Used for the authorization code flow which requested offline_access scope and
// registered the refresh_token grant type in advance
- //
- // * TokenExchangeRequest as returned by ValidateTokenExchangeRequest
CreateAccessAndRefreshTokens(ctx context.Context, request TokenRequest, currentRefreshToken string) (accessTokenID string, newRefreshTokenID string, expiration time.Time, err error)
TokenRequestByRefreshToken(ctx context.Context, refreshTokenID string) (RefreshTokenRequest, error)
@@ -49,108 +44,44 @@ type AuthStorage interface {
// RevokeToken should revoke a token. In the situation that the original request was to
// revoke an access token, then tokenOrTokenID will be a tokenID and userID will be set
// but if the original request was for a refresh token, then userID will be empty and
- // tokenOrTokenID will be the refresh token, not its ID. RevokeToken depends upon GetRefreshTokenInfo
- // to get information from refresh tokens that are not either ":" strings
- // nor JWTs.
+ // tokenOrTokenID will be the refresh token, not its ID.
RevokeToken(ctx context.Context, tokenOrTokenID string, userID string, clientID string) *oidc.Error
+ GetSigningKey(context.Context, chan<- jose.SigningKey)
+ GetKeySet(context.Context) (*jose.JSONWebKeySet, error)
+}
+
+// CanRefreshTokenInfo is an optional additional interface that Storage can support.
+// Supporting CanRefreshTokenInfo is required to be able to (revoke) a refresh token that
+// is neither an encrypted string of : nor a JWT.
+type CanRefreshTokenInfo interface {
// GetRefreshTokenInfo must return ErrInvalidRefreshToken when presented
// with a token that is not a refresh token.
GetRefreshTokenInfo(ctx context.Context, clientID string, token string) (userID string, tokenID string, err error)
-
- SigningKey(context.Context) (SigningKey, error)
- SignatureAlgorithms(context.Context) ([]jose.SignatureAlgorithm, error)
- KeySet(context.Context) ([]Key, error)
-}
-
-// CanTerminateSessionFromRequest is an optional additional interface that may be implemented by
-// implementors of Storage as an alternative to TerminateSession of the AuthStorage.
-// It passes the complete parsed EndSessionRequest to the implementation, which allows access to additional data.
-// It also allows to modify the uri, which will be used for redirection, (e.g. a UI where the user can consent to the logout)
-type CanTerminateSessionFromRequest interface {
- TerminateSessionFromRequest(ctx context.Context, endSessionRequest *EndSessionRequest) (string, error)
-}
-
-type ClientCredentialsStorage interface {
- ClientCredentials(ctx context.Context, clientID, clientSecret string) (Client, error)
- ClientCredentialsTokenRequest(ctx context.Context, clientID string, scopes []string) (TokenRequest, error)
-}
-
-type TokenExchangeStorage interface {
- // ValidateTokenExchangeRequest will be called to validate parsed (including tokens) Token Exchange Grant request.
- //
- // Important validations can include:
- // - permissions
- // - set requested token type to some default value if it is empty (rfc 8693 allows it) using SetRequestedTokenType method.
- // Depending on RequestedTokenType - the following tokens will be issued:
- // - RefreshTokenType - both access and refresh tokens
- // - AccessTokenType - only access token
- // - IDTokenType - only id token
- // - validation of subject's token type on possibility to be exchanged to the requested token type (according to your requirements)
- // - scopes (and update them using SetCurrentScopes method)
- // - set new subject if it differs from exchange subject (impersonation flow)
- //
- // Request will include subject's and/or actor's token claims if correspinding tokens are access/id_token issued by op
- // or third party tokens parsed by TokenExchangeTokensVerifierStorage interface methods.
- ValidateTokenExchangeRequest(ctx context.Context, request TokenExchangeRequest) error
-
- // CreateTokenExchangeRequest will be called after parsing and validating token exchange request.
- // Stored request is not accessed later by op - so it is up to implementer to decide
- // should this method actually store the request or not (common use case - store for it for audit purposes)
- CreateTokenExchangeRequest(ctx context.Context, request TokenExchangeRequest) error
-
- // GetPrivateClaimsFromTokenExchangeRequest will be called during access token creation.
- // Claims evaluation can be based on all validated request data available, including: scopes, resource, audience, etc.
- GetPrivateClaimsFromTokenExchangeRequest(ctx context.Context, request TokenExchangeRequest) (claims map[string]any, err error)
-
- // SetUserinfoFromTokenExchangeRequest will be called during id token creation.
- // Claims evaluation can be based on all validated request data available, including: scopes, resource, audience, etc.
- SetUserinfoFromTokenExchangeRequest(ctx context.Context, userinfo *oidc.UserInfo, request TokenExchangeRequest) error
-}
-
-// TokenExchangeTokensVerifierStorage is an optional interface used in token exchange process to verify tokens
-// issued by third-party applications. If interface is not implemented - only tokens issued by op will be exchanged.
-type TokenExchangeTokensVerifierStorage interface {
- VerifyExchangeSubjectToken(ctx context.Context, token string, tokenType oidc.TokenType) (tokenIDOrToken string, subject string, tokenClaims map[string]any, err error)
- VerifyExchangeActorToken(ctx context.Context, token string, tokenType oidc.TokenType) (tokenIDOrToken string, actor string, tokenClaims map[string]any, err error)
}
var ErrInvalidRefreshToken = errors.New("invalid_refresh_token")
+type ClientCredentialsStorage interface {
+ ClientCredentialsTokenRequest(ctx context.Context, clientID string, scopes []string) (TokenRequest, error)
+}
+
type OPStorage interface {
// GetClientByClientID loads a Client. The returned Client is never cached and is only used to
// handle the current request.
GetClientByClientID(ctx context.Context, clientID string) (Client, error)
AuthorizeClientIDSecret(ctx context.Context, clientID, clientSecret string) error
- // SetUserinfoFromScopes is deprecated and should have an empty implementation for now.
- // Implement SetUserinfoFromRequest instead.
- SetUserinfoFromScopes(ctx context.Context, userinfo *oidc.UserInfo, userID, clientID string, scopes []string) error
- SetUserinfoFromToken(ctx context.Context, userinfo *oidc.UserInfo, tokenID, subject, origin string) error
- SetIntrospectionFromToken(ctx context.Context, userinfo *oidc.IntrospectionResponse, tokenID, subject, clientID string) error
- GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (map[string]any, error)
- GetKeyByIDAndClientID(ctx context.Context, keyID, clientID string) (*jose.JSONWebKey, error)
+ SetUserinfoFromScopes(ctx context.Context, userinfo oidc.UserInfoSetter, userID, clientID string, scopes []string) error
+ SetUserinfoFromToken(ctx context.Context, userinfo oidc.UserInfoSetter, tokenID, subject, origin string) error
+ SetIntrospectionFromToken(ctx context.Context, userinfo oidc.IntrospectionResponse, tokenID, subject, clientID string) error
+ GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (map[string]interface{}, error)
+
+ // GetKeyByIDAndUserID is mis-named. It does not pass userID. Instead
+ // it passes the clientID.
+ GetKeyByIDAndUserID(ctx context.Context, keyID, clientID string) (*jose.JSONWebKey, error)
ValidateJWTProfileScopes(ctx context.Context, userID string, scopes []string) ([]string, error)
}
-// JWTProfileTokenStorage is an additional, optional storage to implement
-// implementing it, allows specifying the [AccessTokenType] of the access_token returned form the JWT Profile TokenRequest
-type JWTProfileTokenStorage interface {
- JWTProfileTokenType(ctx context.Context, request TokenRequest) (AccessTokenType, error)
-}
-
-// CanSetUserinfoFromRequest is an optional additional interface that may be implemented by
-// implementors of Storage. It allows additional data to be set in id_tokens based on the
-// request.
-type CanSetUserinfoFromRequest interface {
- SetUserinfoFromRequest(ctx context.Context, userinfo *oidc.UserInfo, request IDTokenRequest, scopes []string) error
-}
-
-// CanGetPrivateClaimsFromRequest is an optional additional interface that may be implemented by
-// implementors of Storage. It allows setting the jwt token claims based on the request.
-type CanGetPrivateClaimsFromRequest interface {
- GetPrivateClaimsFromRequest(ctx context.Context, request TokenRequest, restrictedScopes []string) (map[string]any, error)
-}
-
// Storage is a required parameter for NewOpenIDProvider(). In addition to the
// embedded interfaces below, if the passed Storage implements ClientCredentialsStorage
// then the grant type "client_credentials" will be supported. In that case, the access
@@ -167,36 +98,7 @@ type StorageNotFoundError interface {
}
type EndSessionRequest struct {
- UserID string
- ClientID string
- IDTokenHintClaims *oidc.IDTokenClaims
- RedirectURI string
- LogoutHint string
- UILocales []language.Tag
-}
-
-var ErrDuplicateUserCode = errors.New("user code already exists")
-
-type DeviceAuthorizationStorage interface {
- // StoreDeviceAuthorizationRequest stores a new device authorization request in the database.
- // User code will be used by the user to complete the login flow and must be unique.
- // ErrDuplicateUserCode signals the caller should try again with a new code.
- //
- // Note that user codes are low entropy keys and when many exist in the
- // database, the change for collisions increases. Therefore implementers
- // of this interface must make sure that user codes of expired authentication flows are purged,
- // after some time.
- StoreDeviceAuthorization(ctx context.Context, clientID, deviceCode, userCode string, expires time.Time, scopes []string) error
-
- // GetDeviceAuthorizatonState returns the current state of the device authorization flow in the database.
- // The method is polled untill the the authorization is eighter Completed, Expired or Denied.
- GetDeviceAuthorizatonState(ctx context.Context, clientID, deviceCode string) (*DeviceAuthorizationState, error)
-}
-
-func assertDeviceStorage(s Storage) (DeviceAuthorizationStorage, error) {
- storage, ok := s.(DeviceAuthorizationStorage)
- if !ok {
- return nil, oidc.ErrUnsupportedGrantType().WithDescription("device_code grant not supported")
- }
- return storage, nil
+ UserID string
+ ClientID string
+ RedirectURI string
}
diff --git a/pkg/op/token.go b/pkg/op/token.go
index 2e25d05..3a72261 100644
--- a/pkg/op/token.go
+++ b/pkg/op/token.go
@@ -2,14 +2,16 @@ package op
import (
"context"
- "slices"
"time"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/crypto"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/crypto"
+ "github.com/zitadel/oidc/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/strings"
)
type TokenCreator interface {
+ Issuer() string
+ Signer() Signer
Storage() Storage
Crypto() Crypto
}
@@ -20,17 +22,7 @@ type TokenRequest interface {
GetScopes() []string
}
-type AccessTokenClient interface {
- GetID() string
- ClockSkew() time.Duration
- RestrictAdditionalAccessTokenScopes() func(scopes []string) []string
- GrantTypes() []oidc.GrantType
-}
-
func CreateTokenResponse(ctx context.Context, request IDTokenRequest, client Client, creator TokenCreator, createAccessToken bool, code, refreshToken string) (*oidc.AccessTokenResponse, error) {
- ctx, span := tracer.Start(ctx, "CreateTokenResponse")
- defer span.End()
-
var accessToken, newRefreshToken string
var validity time.Duration
if createAccessToken {
@@ -40,7 +32,7 @@ func CreateTokenResponse(ctx context.Context, request IDTokenRequest, client Cli
return nil, err
}
}
- idToken, err := CreateIDToken(ctx, IssuerFromContext(ctx), request, client.IDTokenLifetime(), accessToken, code, creator.Storage(), client)
+ idToken, err := CreateIDToken(ctx, creator.Issuer(), request, client.IDTokenLifetime(), accessToken, code, creator.Storage(), creator.Signer(), client)
if err != nil {
return nil, err
}
@@ -51,10 +43,7 @@ func CreateTokenResponse(ctx context.Context, request IDTokenRequest, client Cli
if err != nil {
return nil, err
}
- // only implicit flow requires state to be returned.
- if code == "" {
- state = authRequest.GetState()
- }
+ state = authRequest.GetState()
}
exp := uint64(validity.Seconds())
@@ -65,14 +54,10 @@ func CreateTokenResponse(ctx context.Context, request IDTokenRequest, client Cli
TokenType: oidc.BearerToken,
ExpiresIn: exp,
State: state,
- Scope: request.GetScopes(),
}, nil
}
-func createTokens(ctx context.Context, tokenRequest TokenRequest, storage Storage, refreshToken string, client AccessTokenClient) (id, newRefreshToken string, exp time.Time, err error) {
- ctx, span := tracer.Start(ctx, "createTokens")
- defer span.End()
-
+func createTokens(ctx context.Context, tokenRequest TokenRequest, storage Storage, refreshToken string, client Client) (id, newRefreshToken string, exp time.Time, err error) {
if needsRefreshToken(tokenRequest, client) {
return storage.CreateAccessAndRefreshTokens(ctx, tokenRequest, refreshToken)
}
@@ -80,25 +65,18 @@ func createTokens(ctx context.Context, tokenRequest TokenRequest, storage Storag
return
}
-func needsRefreshToken(tokenRequest TokenRequest, client AccessTokenClient) bool {
+func needsRefreshToken(tokenRequest TokenRequest, client Client) bool {
switch req := tokenRequest.(type) {
case AuthRequest:
- return slices.Contains(req.GetScopes(), oidc.ScopeOfflineAccess) && req.GetResponseType() == oidc.ResponseTypeCode && ValidateGrantType(client, oidc.GrantTypeRefreshToken)
- case TokenExchangeRequest:
- return req.GetRequestedTokenType() == oidc.RefreshTokenType
+ return strings.Contains(req.GetScopes(), oidc.ScopeOfflineAccess) && req.GetResponseType() == oidc.ResponseTypeCode && ValidateGrantType(client, oidc.GrantTypeRefreshToken)
case RefreshTokenRequest:
return true
- case *DeviceAuthorizationState:
- return slices.Contains(req.GetScopes(), oidc.ScopeOfflineAccess) && ValidateGrantType(client, oidc.GrantTypeRefreshToken)
default:
return false
}
}
-func CreateAccessToken(ctx context.Context, tokenRequest TokenRequest, accessTokenType AccessTokenType, creator TokenCreator, client AccessTokenClient, refreshToken string) (accessToken, newRefreshToken string, validity time.Duration, err error) {
- ctx, span := tracer.Start(ctx, "CreateAccessToken")
- defer span.End()
-
+func CreateAccessToken(ctx context.Context, tokenRequest TokenRequest, accessTokenType AccessTokenType, creator TokenCreator, client Client, refreshToken string) (accessToken, newRefreshToken string, validity time.Duration, err error) {
id, newRefreshToken, exp, err := createTokens(ctx, tokenRequest, creator.Storage(), refreshToken, client)
if err != nil {
return "", "", 0, err
@@ -109,12 +87,10 @@ func CreateAccessToken(ctx context.Context, tokenRequest TokenRequest, accessTok
}
validity = exp.Add(clockSkew).Sub(time.Now().UTC())
if accessTokenType == AccessTokenTypeJWT {
- accessToken, err = CreateJWT(ctx, IssuerFromContext(ctx), tokenRequest, exp, id, client, creator.Storage())
+ accessToken, err = CreateJWT(ctx, creator.Issuer(), tokenRequest, exp, id, creator.Signer(), client, creator.Storage())
return
}
- _, span = tracer.Start(ctx, "CreateBearerToken")
accessToken, err = CreateBearerToken(id, tokenRequest.GetSubject(), creator.Crypto())
- span.End()
return
}
@@ -122,55 +98,17 @@ func CreateBearerToken(tokenID, subject string, crypto Crypto) (string, error) {
return crypto.Encrypt(tokenID + ":" + subject)
}
-type TokenActorRequest interface {
- GetActor() *oidc.ActorClaims
-}
-
-func CreateJWT(ctx context.Context, issuer string, tokenRequest TokenRequest, exp time.Time, id string, client AccessTokenClient, storage Storage) (string, error) {
- ctx, span := tracer.Start(ctx, "CreateJWT")
- defer span.End()
-
+func CreateJWT(ctx context.Context, issuer string, tokenRequest TokenRequest, exp time.Time, id string, signer Signer, client Client, storage Storage) (string, error) {
claims := oidc.NewAccessTokenClaims(issuer, tokenRequest.GetSubject(), tokenRequest.GetAudience(), exp, id, client.GetID(), client.ClockSkew())
if client != nil {
restrictedScopes := client.RestrictAdditionalAccessTokenScopes()(tokenRequest.GetScopes())
-
- var (
- privateClaims map[string]any
- err error
- )
-
- tokenExchangeRequest, okReq := tokenRequest.(TokenExchangeRequest)
- teStorage, okStorage := storage.(TokenExchangeStorage)
- if okReq && okStorage {
- privateClaims, err = teStorage.GetPrivateClaimsFromTokenExchangeRequest(
- ctx,
- tokenExchangeRequest,
- )
- } else {
- if fromRequest, ok := storage.(CanGetPrivateClaimsFromRequest); ok {
- privateClaims, err = fromRequest.GetPrivateClaimsFromRequest(ctx, tokenRequest, removeUserinfoScopes(restrictedScopes))
- } else {
- privateClaims, err = storage.GetPrivateClaimsFromScopes(ctx, tokenRequest.GetSubject(), client.GetID(), removeUserinfoScopes(restrictedScopes))
- }
- }
-
+ privateClaims, err := storage.GetPrivateClaimsFromScopes(ctx, tokenRequest.GetSubject(), client.GetID(), removeUserinfoScopes(restrictedScopes))
if err != nil {
return "", err
}
- claims.Claims = privateClaims
+ claims.SetPrivateClaims(privateClaims)
}
- if actorReq, ok := tokenRequest.(TokenActorRequest); ok {
- claims.Actor = actorReq.GetActor()
- }
- signingKey, err := storage.SigningKey(ctx)
- if err != nil {
- return "", err
- }
- signer, err := SignerFromKey(signingKey)
- if err != nil {
- return "", err
- }
- return crypto.Sign(claims, signer)
+ return crypto.Sign(claims, signer.Signer())
}
type IDTokenRequest interface {
@@ -182,10 +120,7 @@ type IDTokenRequest interface {
GetSubject() string
}
-func CreateIDToken(ctx context.Context, issuer string, request IDTokenRequest, validity time.Duration, accessToken, code string, storage Storage, client Client) (string, error) {
- ctx, span := tracer.Start(ctx, "CreateIDToken")
- defer span.End()
-
+func CreateIDToken(ctx context.Context, issuer string, request IDTokenRequest, validity time.Duration, accessToken, code string, storage Storage, signer Signer, client Client) (string, error) {
exp := time.Now().UTC().Add(client.ClockSkew()).Add(validity)
var acr, nonce string
if authRequest, ok := request.(AuthRequest); ok {
@@ -193,61 +128,34 @@ func CreateIDToken(ctx context.Context, issuer string, request IDTokenRequest, v
nonce = authRequest.GetNonce()
}
claims := oidc.NewIDTokenClaims(issuer, request.GetSubject(), request.GetAudience(), exp, request.GetAuthTime(), nonce, acr, request.GetAMR(), request.GetClientID(), client.ClockSkew())
- if actorReq, ok := request.(TokenActorRequest); ok {
- claims.Actor = actorReq.GetActor()
- }
-
scopes := client.RestrictAdditionalIdTokenScopes()(request.GetScopes())
- signingKey, err := storage.SigningKey(ctx)
- if err != nil {
- return "", err
- }
if accessToken != "" {
- atHash, err := oidc.ClaimHash(accessToken, signingKey.SignatureAlgorithm())
+ atHash, err := oidc.ClaimHash(accessToken, signer.SignatureAlgorithm())
if err != nil {
return "", err
}
- claims.AccessTokenHash = atHash
+ claims.SetAccessTokenHash(atHash)
if !client.IDTokenUserinfoClaimsAssertion() {
scopes = removeUserinfoScopes(scopes)
}
}
-
- tokenExchangeRequest, okReq := request.(TokenExchangeRequest)
- teStorage, okStorage := storage.(TokenExchangeStorage)
- if okReq && okStorage {
- userInfo := new(oidc.UserInfo)
- err := teStorage.SetUserinfoFromTokenExchangeRequest(ctx, userInfo, tokenExchangeRequest)
- if err != nil {
- return "", err
- }
- claims.SetUserInfo(userInfo)
- } else if len(scopes) > 0 {
- userInfo := new(oidc.UserInfo)
+ if len(scopes) > 0 {
+ userInfo := oidc.NewUserInfo()
err := storage.SetUserinfoFromScopes(ctx, userInfo, request.GetSubject(), request.GetClientID(), scopes)
if err != nil {
return "", err
}
- if fromRequest, ok := storage.(CanSetUserinfoFromRequest); ok {
- err := fromRequest.SetUserinfoFromRequest(ctx, userInfo, request, scopes)
- if err != nil {
- return "", err
- }
- }
- claims.SetUserInfo(userInfo)
+ claims.SetUserinfo(userInfo)
}
if code != "" {
- codeHash, err := oidc.ClaimHash(code, signingKey.SignatureAlgorithm())
+ codeHash, err := oidc.ClaimHash(code, signer.SignatureAlgorithm())
if err != nil {
return "", err
}
- claims.CodeHash = codeHash
+ claims.SetCodeHash(codeHash)
}
- signer, err := SignerFromKey(signingKey)
- if err != nil {
- return "", err
- }
- return crypto.Sign(claims, signer)
+
+ return crypto.Sign(claims, signer.Signer())
}
func removeUserinfoScopes(scopes []string) []string {
diff --git a/pkg/op/token_client_credentials.go b/pkg/op/token_client_credentials.go
index ddb2fbf..3787667 100644
--- a/pkg/op/token_client_credentials.go
+++ b/pkg/op/token_client_credentials.go
@@ -5,31 +5,27 @@ import (
"net/http"
"net/url"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
// ClientCredentialsExchange handles the OAuth 2.0 client_credentials grant, including
// parsing, validating, authorizing the client and finally returning a token
func ClientCredentialsExchange(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
- ctx, span := tracer.Start(r.Context(), "ClientCredentialsExchange")
- defer span.End()
- r = r.WithContext(ctx)
-
request, err := ParseClientCredentialsRequest(r, exchanger.Decoder())
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
}
validatedRequest, client, err := ValidateClientCredentialsRequest(r.Context(), request, exchanger)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
resp, err := CreateClientCredentialsTokenResponse(r.Context(), validatedRequest, exchanger, client)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
@@ -67,18 +63,15 @@ func ParseClientCredentialsRequest(r *http.Request, decoder httphelper.Decoder)
return request, nil
}
-// ValidateClientCredentialsRequest validates the client_credentials request parameters including authorization check of the client
-// and returns a TokenRequest and Client implementation to be used in the client_credentials response, resp. creation of the corresponding access_token.
+// ValidateClientCredentialsRequest validates the refresh_token request parameters including authorization check of the client
+// and returns the data representing the original auth request corresponding to the refresh_token
func ValidateClientCredentialsRequest(ctx context.Context, request *oidc.ClientCredentialsRequest, exchanger Exchanger) (TokenRequest, Client, error) {
- ctx, span := tracer.Start(ctx, "ValidateClientCredentialsRequest")
- defer span.End()
-
storage, ok := exchanger.Storage().(ClientCredentialsStorage)
if !ok {
return nil, nil, oidc.ErrUnsupportedGrantType().WithDescription("client_credentials grant not supported")
}
- client, err := AuthorizeClientCredentialsClient(ctx, request, storage)
+ client, err := AuthorizeClientCredentialsClient(ctx, request, exchanger)
if err != nil {
return nil, nil, err
}
@@ -91,11 +84,12 @@ func ValidateClientCredentialsRequest(ctx context.Context, request *oidc.ClientC
return tokenRequest, client, nil
}
-func AuthorizeClientCredentialsClient(ctx context.Context, request *oidc.ClientCredentialsRequest, storage ClientCredentialsStorage) (Client, error) {
- ctx, span := tracer.Start(ctx, "AuthorizeClientCredentialsClient")
- defer span.End()
+func AuthorizeClientCredentialsClient(ctx context.Context, request *oidc.ClientCredentialsRequest, exchanger Exchanger) (Client, error) {
+ if err := AuthorizeClientIDSecret(ctx, request.ClientID, request.ClientSecret, exchanger.Storage()); err != nil {
+ return nil, err
+ }
- client, err := storage.ClientCredentials(ctx, request.ClientID, request.ClientSecret)
+ client, err := exchanger.Storage().GetClientByClientID(ctx, request.ClientID)
if err != nil {
return nil, oidc.ErrInvalidClient().WithParent(err)
}
@@ -108,10 +102,7 @@ func AuthorizeClientCredentialsClient(ctx context.Context, request *oidc.ClientC
}
func CreateClientCredentialsTokenResponse(ctx context.Context, tokenRequest TokenRequest, creator TokenCreator, client Client) (*oidc.AccessTokenResponse, error) {
- ctx, span := tracer.Start(ctx, "CreateClientCredentialsTokenResponse")
- defer span.End()
-
- accessToken, _, validity, err := CreateAccessToken(ctx, tokenRequest, client.AccessTokenType(), creator, client, "")
+ accessToken, _, validity, err := CreateAccessToken(ctx, tokenRequest, AccessTokenTypeJWT, creator, client, "")
if err != nil {
return nil, err
}
@@ -120,6 +111,5 @@ func CreateClientCredentialsTokenResponse(ctx context.Context, tokenRequest Toke
AccessToken: accessToken,
TokenType: oidc.BearerToken,
ExpiresIn: uint64(validity.Seconds()),
- Scope: tokenRequest.GetScopes(),
}, nil
}
diff --git a/pkg/op/token_code.go b/pkg/op/token_code.go
index 155aa43..ec48233 100644
--- a/pkg/op/token_code.go
+++ b/pkg/op/token_code.go
@@ -4,33 +4,29 @@ import (
"context"
"net/http"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
// CodeExchange handles the OAuth 2.0 authorization_code grant, including
// parsing, validating, authorizing the client and finally exchanging the code for tokens
func CodeExchange(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
- ctx, span := tracer.Start(r.Context(), "CodeExchange")
- defer span.End()
- r = r.WithContext(ctx)
-
tokenReq, err := ParseAccessTokenRequest(r, exchanger.Decoder())
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
}
if tokenReq.Code == "" {
- RequestError(w, r, oidc.ErrInvalidRequest().WithDescription("code missing"), exchanger.Logger())
+ RequestError(w, r, oidc.ErrInvalidRequest().WithDescription("code missing"))
return
}
authReq, client, err := ValidateAccessTokenRequest(r.Context(), tokenReq, exchanger)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
resp, err := CreateTokenResponse(r.Context(), authReq, client, exchanger, true, tokenReq.Code, "")
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
httphelper.MarshalJSON(w, resp)
@@ -49,9 +45,6 @@ func ParseAccessTokenRequest(r *http.Request, decoder httphelper.Decoder) (*oidc
// ValidateAccessTokenRequest validates the token request parameters including authorization check of the client
// and returns the previous created auth request corresponding to the auth code
func ValidateAccessTokenRequest(ctx context.Context, tokenReq *oidc.AccessTokenRequest, exchanger Exchanger) (AuthRequest, Client, error) {
- ctx, span := tracer.Start(ctx, "ValidateAccessTokenRequest")
- defer span.End()
-
authReq, client, err := AuthorizeCodeClient(ctx, tokenReq, exchanger)
if err != nil {
return nil, nil, err
@@ -71,9 +64,6 @@ func ValidateAccessTokenRequest(ctx context.Context, tokenReq *oidc.AccessTokenR
// AuthorizeCodeClient checks the authorization of the client and that the used method was the one previously registered.
// It than returns the auth request corresponding to the auth code
func AuthorizeCodeClient(ctx context.Context, tokenReq *oidc.AccessTokenRequest, exchanger Exchanger) (request AuthRequest, client Client, err error) {
- ctx, span := tracer.Start(ctx, "AuthorizeCodeClient")
- defer span.End()
-
if tokenReq.ClientAssertionType == oidc.ClientAssertionTypeJWTAssertion {
jwtExchanger, ok := exchanger.(JWTAuthorizationGrantExchanger)
if !ok || !exchanger.AuthMethodPrivateKeyJWTSupported() {
@@ -98,7 +88,7 @@ func AuthorizeCodeClient(ctx context.Context, tokenReq *oidc.AccessTokenRequest,
if err != nil {
return nil, nil, err
}
- err = AuthorizeCodeChallenge(tokenReq.CodeVerifier, request.GetCodeChallenge())
+ err = AuthorizeCodeChallenge(tokenReq, request.GetCodeChallenge())
return request, client, err
}
if client.AuthMethod() == oidc.AuthMethodPost && !exchanger.AuthMethodPostSupported() {
@@ -114,9 +104,6 @@ func AuthorizeCodeClient(ctx context.Context, tokenReq *oidc.AccessTokenRequest,
// AuthRequestByCode returns the AuthRequest previously created from Storage corresponding to the auth code or an error
func AuthRequestByCode(ctx context.Context, storage Storage, code string) (AuthRequest, error) {
- ctx, span := tracer.Start(ctx, "AuthRequestByCode")
- defer span.End()
-
authReq, err := storage.AuthRequestByCode(ctx, code)
if err != nil {
return nil, oidc.ErrInvalidGrant().WithDescription("invalid code").WithParent(err)
diff --git a/pkg/op/token_exchange.go b/pkg/op/token_exchange.go
index 00af485..7bb6e42 100644
--- a/pkg/op/token_exchange.go
+++ b/pkg/op/token_exchange.go
@@ -1,432 +1,11 @@
package op
import (
- "context"
+ "errors"
"net/http"
- "net/url"
- "strings"
- "time"
-
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
)
-type TokenExchangeRequest interface {
- GetAMR() []string
- GetAudience() []string
- GetResourses() []string
- GetAuthTime() time.Time
- GetClientID() string
- GetScopes() []string
- GetSubject() string
- GetRequestedTokenType() oidc.TokenType
-
- GetExchangeSubject() string
- GetExchangeSubjectTokenType() oidc.TokenType
- GetExchangeSubjectTokenIDOrToken() string
- GetExchangeSubjectTokenClaims() map[string]any
-
- GetExchangeActor() string
- GetExchangeActorTokenType() oidc.TokenType
- GetExchangeActorTokenIDOrToken() string
- GetExchangeActorTokenClaims() map[string]any
-
- SetCurrentScopes(scopes []string)
- SetRequestedTokenType(tt oidc.TokenType)
- SetSubject(subject string)
-}
-
-type tokenExchangeRequest struct {
- exchangeSubjectTokenIDOrToken string
- exchangeSubjectTokenType oidc.TokenType
- exchangeSubject string
- exchangeSubjectTokenClaims map[string]any
-
- exchangeActorTokenIDOrToken string
- exchangeActorTokenType oidc.TokenType
- exchangeActor string
- exchangeActorTokenClaims map[string]any
-
- resource []string
- audience oidc.Audience
- scopes oidc.SpaceDelimitedArray
- requestedTokenType oidc.TokenType
- clientID string
- authTime time.Time
- subject string
-}
-
-func (r *tokenExchangeRequest) GetAMR() []string {
- return []string{}
-}
-
-func (r *tokenExchangeRequest) GetAudience() []string {
- return r.audience
-}
-
-func (r *tokenExchangeRequest) GetResourses() []string {
- return r.resource
-}
-
-func (r *tokenExchangeRequest) GetAuthTime() time.Time {
- return r.authTime
-}
-
-func (r *tokenExchangeRequest) GetClientID() string {
- return r.clientID
-}
-
-func (r *tokenExchangeRequest) GetScopes() []string {
- return r.scopes
-}
-
-func (r *tokenExchangeRequest) GetRequestedTokenType() oidc.TokenType {
- return r.requestedTokenType
-}
-
-func (r *tokenExchangeRequest) GetExchangeSubject() string {
- return r.exchangeSubject
-}
-
-func (r *tokenExchangeRequest) GetExchangeSubjectTokenType() oidc.TokenType {
- return r.exchangeSubjectTokenType
-}
-
-func (r *tokenExchangeRequest) GetExchangeSubjectTokenIDOrToken() string {
- return r.exchangeSubjectTokenIDOrToken
-}
-
-func (r *tokenExchangeRequest) GetExchangeSubjectTokenClaims() map[string]any {
- return r.exchangeSubjectTokenClaims
-}
-
-func (r *tokenExchangeRequest) GetExchangeActor() string {
- return r.exchangeActor
-}
-
-func (r *tokenExchangeRequest) GetExchangeActorTokenType() oidc.TokenType {
- return r.exchangeActorTokenType
-}
-
-func (r *tokenExchangeRequest) GetExchangeActorTokenIDOrToken() string {
- return r.exchangeActorTokenIDOrToken
-}
-
-func (r *tokenExchangeRequest) GetExchangeActorTokenClaims() map[string]any {
- return r.exchangeActorTokenClaims
-}
-
-func (r *tokenExchangeRequest) GetSubject() string {
- return r.subject
-}
-
-func (r *tokenExchangeRequest) SetCurrentScopes(scopes []string) {
- r.scopes = scopes
-}
-
-func (r *tokenExchangeRequest) SetRequestedTokenType(tt oidc.TokenType) {
- r.requestedTokenType = tt
-}
-
-func (r *tokenExchangeRequest) SetSubject(subject string) {
- r.subject = subject
-}
-
-// TokenExchange handles the OAuth 2.0 token exchange grant ("urn:ietf:params:oauth:grant-type:token-exchange")
+// TokenExchange will handle the OAuth 2.0 token exchange grant ("urn:ietf:params:oauth:grant-type:token-exchange")
func TokenExchange(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
- ctx, span := tracer.Start(r.Context(), "TokenExchange")
- defer span.End()
- r = r.WithContext(ctx)
-
- tokenExchangeReq, clientID, clientSecret, err := ParseTokenExchangeRequest(r, exchanger.Decoder())
- if err != nil {
- RequestError(w, r, err, exchanger.Logger())
- }
-
- tokenExchangeRequest, client, err := ValidateTokenExchangeRequest(r.Context(), tokenExchangeReq, clientID, clientSecret, exchanger)
- if err != nil {
- RequestError(w, r, err, exchanger.Logger())
- return
- }
- resp, err := CreateTokenExchangeResponse(r.Context(), tokenExchangeRequest, client, exchanger)
- if err != nil {
- RequestError(w, r, err, exchanger.Logger())
- return
- }
- httphelper.MarshalJSON(w, resp)
-}
-
-// ParseTokenExchangeRequest parses the http request into oidc.TokenExchangeRequest
-func ParseTokenExchangeRequest(r *http.Request, decoder httphelper.Decoder) (_ *oidc.TokenExchangeRequest, clientID, clientSecret string, err error) {
- err = r.ParseForm()
- if err != nil {
- return nil, "", "", oidc.ErrInvalidRequest().WithDescription("error parsing form").WithParent(err)
- }
-
- request := new(oidc.TokenExchangeRequest)
- err = decoder.Decode(request, r.Form)
- if err != nil {
- return nil, "", "", oidc.ErrInvalidRequest().WithDescription("error decoding form").WithParent(err)
- }
-
- var ok bool
- if clientID, clientSecret, ok = r.BasicAuth(); ok {
- clientID, err = url.QueryUnescape(clientID)
- if err != nil {
- return nil, "", "", oidc.ErrInvalidClient().WithDescription("invalid basic auth header").WithParent(err)
- }
-
- clientSecret, err = url.QueryUnescape(clientSecret)
- if err != nil {
- return nil, "", "", oidc.ErrInvalidClient().WithDescription("invalid basic auth header").WithParent(err)
- }
- }
-
- return request, clientID, clientSecret, nil
-}
-
-// ValidateTokenExchangeRequest validates the token exchange request parameters including authorization check of the client,
-// subject_token and actor_token
-func ValidateTokenExchangeRequest(
- ctx context.Context,
- oidcTokenExchangeRequest *oidc.TokenExchangeRequest,
- clientID, clientSecret string,
- exchanger Exchanger,
-) (TokenExchangeRequest, Client, error) {
- ctx, span := tracer.Start(ctx, "ValidateTokenExchangeRequest")
- defer span.End()
-
- if oidcTokenExchangeRequest.SubjectToken == "" {
- return nil, nil, oidc.ErrInvalidRequest().WithDescription("subject_token missing")
- }
-
- if oidcTokenExchangeRequest.SubjectTokenType == "" {
- return nil, nil, oidc.ErrInvalidRequest().WithDescription("subject_token_type missing")
- }
-
- client, err := AuthorizeTokenExchangeClient(ctx, clientID, clientSecret, exchanger)
- if err != nil {
- return nil, nil, err
- }
-
- if oidcTokenExchangeRequest.RequestedTokenType != "" && !oidcTokenExchangeRequest.RequestedTokenType.IsSupported() {
- return nil, nil, oidc.ErrInvalidRequest().WithDescription("requested_token_type is not supported")
- }
-
- if !oidcTokenExchangeRequest.SubjectTokenType.IsSupported() {
- return nil, nil, oidc.ErrInvalidRequest().WithDescription("subject_token_type is not supported")
- }
-
- if oidcTokenExchangeRequest.ActorTokenType != "" && !oidcTokenExchangeRequest.ActorTokenType.IsSupported() {
- return nil, nil, oidc.ErrInvalidRequest().WithDescription("actor_token_type is not supported")
- }
-
- req, err := CreateTokenExchangeRequest(ctx, oidcTokenExchangeRequest, client, exchanger)
- if err != nil {
- return nil, nil, err
- }
- return req, client, nil
-}
-
-func CreateTokenExchangeRequest(
- ctx context.Context,
- oidcTokenExchangeRequest *oidc.TokenExchangeRequest,
- client Client,
- exchanger Exchanger,
-) (TokenExchangeRequest, error) {
- ctx, span := tracer.Start(ctx, "CreateTokenExchangeRequest")
- defer span.End()
-
- teStorage, ok := exchanger.Storage().(TokenExchangeStorage)
- if !ok {
- return nil, unimplementedGrantError(oidc.GrantTypeTokenExchange)
- }
-
- exchangeSubjectTokenIDOrToken, exchangeSubject, exchangeSubjectTokenClaims, ok := GetTokenIDAndSubjectFromToken(ctx, exchanger,
- oidcTokenExchangeRequest.SubjectToken, oidcTokenExchangeRequest.SubjectTokenType, false)
- if !ok {
- return nil, oidc.ErrInvalidRequest().WithDescription("subject_token is invalid")
- }
-
- var (
- exchangeActorTokenIDOrToken, exchangeActor string
- exchangeActorTokenClaims map[string]any
- )
- if oidcTokenExchangeRequest.ActorToken != "" {
- exchangeActorTokenIDOrToken, exchangeActor, exchangeActorTokenClaims, ok = GetTokenIDAndSubjectFromToken(ctx, exchanger,
- oidcTokenExchangeRequest.ActorToken, oidcTokenExchangeRequest.ActorTokenType, true)
- if !ok {
- return nil, oidc.ErrInvalidRequest().WithDescription("actor_token is invalid")
- }
- }
-
- req := &tokenExchangeRequest{
- exchangeSubjectTokenIDOrToken: exchangeSubjectTokenIDOrToken,
- exchangeSubjectTokenType: oidcTokenExchangeRequest.SubjectTokenType,
- exchangeSubject: exchangeSubject,
- exchangeSubjectTokenClaims: exchangeSubjectTokenClaims,
-
- exchangeActorTokenIDOrToken: exchangeActorTokenIDOrToken,
- exchangeActorTokenType: oidcTokenExchangeRequest.ActorTokenType,
- exchangeActor: exchangeActor,
- exchangeActorTokenClaims: exchangeActorTokenClaims,
-
- subject: exchangeSubject,
- resource: oidcTokenExchangeRequest.Resource,
- audience: oidcTokenExchangeRequest.Audience,
- scopes: oidcTokenExchangeRequest.Scopes,
- requestedTokenType: oidcTokenExchangeRequest.RequestedTokenType,
- clientID: client.GetID(),
- authTime: time.Now(),
- }
-
- err := teStorage.ValidateTokenExchangeRequest(ctx, req)
- if err != nil {
- return nil, err
- }
-
- err = teStorage.CreateTokenExchangeRequest(ctx, req)
- if err != nil {
- return nil, err
- }
-
- return req, nil
-}
-
-func GetTokenIDAndSubjectFromToken(
- ctx context.Context,
- exchanger Exchanger,
- token string,
- tokenType oidc.TokenType,
- isActor bool,
-) (tokenIDOrToken, subject string, claims map[string]any, ok bool) {
- ctx, span := tracer.Start(ctx, "GetTokenIDAndSubjectFromToken")
- defer span.End()
-
- switch tokenType {
- case oidc.AccessTokenType:
- var accessTokenClaims *oidc.AccessTokenClaims
- tokenIDOrToken, subject, accessTokenClaims, ok = getTokenIDAndClaims(ctx, exchanger, token)
- if !ok {
- break
- }
- claims = accessTokenClaims.Claims
- case oidc.RefreshTokenType:
- refreshTokenRequest, err := exchanger.Storage().TokenRequestByRefreshToken(ctx, token)
- if err != nil {
- break
- }
-
- tokenIDOrToken, subject, ok = token, refreshTokenRequest.GetSubject(), true
- case oidc.IDTokenType:
- idTokenClaims, err := VerifyIDTokenHint[*oidc.IDTokenClaims](ctx, token, exchanger.IDTokenHintVerifier(ctx))
- if err != nil {
- break
- }
-
- tokenIDOrToken, subject, claims, ok = token, idTokenClaims.Subject, idTokenClaims.Claims, true
- }
-
- if !ok {
- if verifier, ok := exchanger.Storage().(TokenExchangeTokensVerifierStorage); ok {
- var err error
- if isActor {
- tokenIDOrToken, subject, claims, err = verifier.VerifyExchangeActorToken(ctx, token, tokenType)
- } else {
- tokenIDOrToken, subject, claims, err = verifier.VerifyExchangeSubjectToken(ctx, token, tokenType)
- }
- if err != nil {
- return "", "", nil, false
- }
-
- return tokenIDOrToken, subject, claims, true
- }
-
- return "", "", nil, false
- }
-
- return tokenIDOrToken, subject, claims, true
-}
-
-// AuthorizeTokenExchangeClient authorizes a client by validating the client_id and client_secret
-func AuthorizeTokenExchangeClient(ctx context.Context, clientID, clientSecret string, exchanger Exchanger) (client Client, err error) {
- ctx, span := tracer.Start(ctx, "AuthorizeTokenExchangeClient")
- defer span.End()
-
- if err := AuthorizeClientIDSecret(ctx, clientID, clientSecret, exchanger.Storage()); err != nil {
- return nil, err
- }
-
- client, err = exchanger.Storage().GetClientByClientID(ctx, clientID)
- if err != nil {
- return nil, oidc.ErrInvalidClient().WithParent(err)
- }
-
- return client, nil
-}
-
-func CreateTokenExchangeResponse(
- ctx context.Context,
- tokenExchangeRequest TokenExchangeRequest,
- client Client,
- creator TokenCreator,
-) (_ *oidc.TokenExchangeResponse, err error) {
- ctx, span := tracer.Start(ctx, "CreateTokenExchangeResponse")
- defer span.End()
-
- var (
- token, refreshToken, tokenType string
- validity time.Duration
- )
-
- switch tokenExchangeRequest.GetRequestedTokenType() {
- case oidc.AccessTokenType, oidc.RefreshTokenType:
- token, refreshToken, validity, err = CreateAccessToken(ctx, tokenExchangeRequest, client.AccessTokenType(), creator, client, "")
- if err != nil {
- return nil, err
- }
-
- tokenType = oidc.BearerToken
- case oidc.IDTokenType:
- token, err = CreateIDToken(ctx, IssuerFromContext(ctx), tokenExchangeRequest, client.IDTokenLifetime(), "", "", creator.Storage(), client)
- if err != nil {
- return nil, err
- }
-
- // not applicable (see https://datatracker.ietf.org/doc/html/rfc8693#section-2-2-1-2-6)
- tokenType = "N_A"
- default:
- // oidc.JWTTokenType and other custom token types are not supported for issuing.
- // In the future it can be considered to have custom tokens generation logic injected via op configuration
- // or via expanding Storage interface
- oidc.ErrInvalidRequest().WithDescription("requested_token_type is invalid")
- }
-
- exp := uint64(validity.Seconds())
- return &oidc.TokenExchangeResponse{
- AccessToken: token,
- IssuedTokenType: tokenExchangeRequest.GetRequestedTokenType(),
- TokenType: tokenType,
- ExpiresIn: exp,
- RefreshToken: refreshToken,
- Scopes: tokenExchangeRequest.GetScopes(),
- }, nil
-}
-
-func getTokenIDAndClaims(ctx context.Context, userinfoProvider UserinfoProvider, accessToken string) (string, string, *oidc.AccessTokenClaims, bool) {
- tokenIDSubject, err := userinfoProvider.Crypto().Decrypt(accessToken)
- if err == nil {
- splitToken := strings.Split(tokenIDSubject, ":")
- if len(splitToken) != 2 {
- return "", "", nil, false
- }
-
- return splitToken[0], splitToken[1], nil, true
- }
- accessTokenClaims, err := VerifyAccessToken[*oidc.AccessTokenClaims](ctx, accessToken, userinfoProvider.AccessTokenVerifier(ctx))
- if err != nil {
- return "", "", nil, false
- }
-
- return accessTokenClaims.JWTID, accessTokenClaims.Subject, accessTokenClaims, true
+ RequestError(w, r, errors.New("unimplemented"))
}
diff --git a/pkg/op/token_intospection.go b/pkg/op/token_intospection.go
index bb6a5a0..f402c8b 100644
--- a/pkg/op/token_intospection.go
+++ b/pkg/op/token_intospection.go
@@ -1,24 +1,24 @@
package op
import (
- "context"
"errors"
"net/http"
+ "net/url"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type Introspector interface {
Decoder() httphelper.Decoder
Crypto() Crypto
Storage() Storage
- AccessTokenVerifier(context.Context) *AccessTokenVerifier
+ AccessTokenVerifier() AccessTokenVerifier
}
type IntrospectorJWTProfile interface {
Introspector
- JWTProfileVerifier(context.Context) JWTProfileVerifier
+ JWTProfileVerifier() JWTProfileVerifier
}
func introspectionHandler(introspector Introspector) func(http.ResponseWriter, *http.Request) {
@@ -28,11 +28,7 @@ func introspectionHandler(introspector Introspector) func(http.ResponseWriter, *
}
func Introspect(w http.ResponseWriter, r *http.Request, introspector Introspector) {
- ctx, span := tracer.Start(r.Context(), "Introspect")
- defer span.End()
- r = r.WithContext(ctx)
-
- response := new(oidc.IntrospectionResponse)
+ response := oidc.NewIntrospectionResponse()
token, clientID, err := ParseTokenIntrospectionRequest(r, introspector)
if err != nil {
http.Error(w, err.Error(), http.StatusUnauthorized)
@@ -48,29 +44,43 @@ func Introspect(w http.ResponseWriter, r *http.Request, introspector Introspecto
httphelper.MarshalJSON(w, response)
return
}
- response.Active = true
+ response.SetActive(true)
httphelper.MarshalJSON(w, response)
}
func ParseTokenIntrospectionRequest(r *http.Request, introspector Introspector) (token, clientID string, err error) {
- clientID, authenticated, err := ClientIDFromRequest(r, introspector)
+ err = r.ParseForm()
if err != nil {
- return "", "", err
+ return "", "", errors.New("unable to parse request")
}
- if !authenticated {
- return "", "", oidc.ErrInvalidClient().WithParent(ErrNoClientCredentials)
- }
-
- req := new(oidc.IntrospectionRequest)
+ req := new(struct {
+ oidc.IntrospectionRequest
+ oidc.ClientAssertionParams
+ })
err = introspector.Decoder().Decode(req, r.Form)
if err != nil {
return "", "", errors.New("unable to parse request")
}
-
- return req.Token, clientID, nil
-}
-
-type IntrospectionRequest struct {
- *ClientCredentials
- *oidc.IntrospectionRequest
+ if introspectorJWTProfile, ok := introspector.(IntrospectorJWTProfile); ok && req.ClientAssertion != "" {
+ profile, err := VerifyJWTAssertion(r.Context(), req.ClientAssertion, introspectorJWTProfile.JWTProfileVerifier())
+ if err == nil {
+ return req.Token, profile.Issuer, nil
+ }
+ }
+ clientID, clientSecret, ok := r.BasicAuth()
+ if ok {
+ clientID, err = url.QueryUnescape(clientID)
+ if err != nil {
+ return "", "", errors.New("invalid basic auth header")
+ }
+ clientSecret, err = url.QueryUnescape(clientSecret)
+ if err != nil {
+ return "", "", errors.New("invalid basic auth header")
+ }
+ if err := introspector.Storage().AuthorizeClientIDSecret(r.Context(), clientID, clientSecret); err != nil {
+ return "", "", err
+ }
+ return req.Token, clientID, nil
+ }
+ return "", "", errors.New("invalid authorization")
}
diff --git a/pkg/op/token_jwt_profile.go b/pkg/op/token_jwt_profile.go
index defb937..eb21517 100644
--- a/pkg/op/token_jwt_profile.go
+++ b/pkg/op/token_jwt_profile.go
@@ -5,40 +5,36 @@ import (
"net/http"
"time"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type JWTAuthorizationGrantExchanger interface {
Exchanger
- JWTProfileVerifier(context.Context) *JWTProfileVerifier
+ JWTProfileVerifier() JWTProfileVerifier
}
// JWTProfile handles the OAuth 2.0 JWT Profile Authorization Grant https://tools.ietf.org/html/rfc7523#section-2.1
func JWTProfile(w http.ResponseWriter, r *http.Request, exchanger JWTAuthorizationGrantExchanger) {
- ctx, span := tracer.Start(r.Context(), "JWTProfile")
- defer span.End()
- r = r.WithContext(ctx)
-
profileRequest, err := ParseJWTProfileGrantRequest(r, exchanger.Decoder())
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
}
- tokenRequest, err := VerifyJWTAssertion(r.Context(), profileRequest.Assertion, exchanger.JWTProfileVerifier(r.Context()))
+ tokenRequest, err := VerifyJWTAssertion(r.Context(), profileRequest.Assertion, exchanger.JWTProfileVerifier())
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
tokenRequest.Scopes, err = exchanger.Storage().ValidateJWTProfileScopes(r.Context(), tokenRequest.Issuer, profileRequest.Scope)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
resp, err := CreateJWTTokenResponse(r.Context(), tokenRequest, exchanger)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
httphelper.MarshalJSON(w, resp)
@@ -57,69 +53,27 @@ func ParseJWTProfileGrantRequest(r *http.Request, decoder httphelper.Decoder) (*
return tokenReq, nil
}
-// CreateJWTTokenResponse creates an access_token response for a JWT Profile Grant request
-// by default the access_token is an opaque string, but can be specified by implementing the JWTProfileTokenStorage interface
+// CreateJWTTokenResponse creates
func CreateJWTTokenResponse(ctx context.Context, tokenRequest TokenRequest, creator TokenCreator) (*oidc.AccessTokenResponse, error) {
- ctx, span := tracer.Start(ctx, "CreateJWTTokenResponse")
- defer span.End()
-
- // return an opaque token as default to not break current implementations
- tokenType := AccessTokenTypeBearer
-
- // the current CreateAccessToken function, esp. CreateJWT requires an implementation of an AccessTokenClient
- client := &jwtProfileClient{
- id: tokenRequest.GetSubject(),
- }
-
- // by implementing the JWTProfileTokenStorage the storage can specify the AccessTokenType to be returned
- tokenStorage, ok := creator.Storage().(JWTProfileTokenStorage)
- if ok {
- var err error
- tokenType, err = tokenStorage.JWTProfileTokenType(ctx, tokenRequest)
- if err != nil {
- return nil, err
- }
- }
-
- accessToken, _, validity, err := CreateAccessToken(ctx, tokenRequest, tokenType, creator, client, "")
+ id, exp, err := creator.Storage().CreateAccessToken(ctx, tokenRequest)
if err != nil {
return nil, err
}
+ accessToken, err := CreateBearerToken(id, tokenRequest.GetSubject(), creator.Crypto())
+ if err != nil {
+ return nil, err
+ }
+
return &oidc.AccessTokenResponse{
AccessToken: accessToken,
TokenType: oidc.BearerToken,
- ExpiresIn: uint64(validity.Seconds()),
- Scope: tokenRequest.GetScopes(),
+ ExpiresIn: uint64(exp.Sub(time.Now().UTC()).Seconds()),
}, nil
}
// ParseJWTProfileRequest has been renamed to ParseJWTProfileGrantRequest
//
-// deprecated: use ParseJWTProfileGrantRequest
+//deprecated: use ParseJWTProfileGrantRequest
func ParseJWTProfileRequest(r *http.Request, decoder httphelper.Decoder) (*oidc.JWTProfileGrantRequest, error) {
return ParseJWTProfileGrantRequest(r, decoder)
}
-
-type jwtProfileClient struct {
- id string
-}
-
-func (j *jwtProfileClient) GetID() string {
- return j.id
-}
-
-func (j *jwtProfileClient) ClockSkew() time.Duration {
- return 0
-}
-
-func (j *jwtProfileClient) RestrictAdditionalAccessTokenScopes() func(scopes []string) []string {
- return func(scopes []string) []string {
- return scopes
- }
-}
-
-func (j *jwtProfileClient) GrantTypes() []oidc.GrantType {
- return []oidc.GrantType{
- oidc.GrantTypeBearer,
- }
-}
diff --git a/pkg/op/token_refresh.go b/pkg/op/token_refresh.go
index a87e883..7251eeb 100644
--- a/pkg/op/token_refresh.go
+++ b/pkg/op/token_refresh.go
@@ -4,11 +4,11 @@ import (
"context"
"errors"
"net/http"
- "slices"
"time"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/strings"
)
type RefreshTokenRequest interface {
@@ -24,22 +24,18 @@ type RefreshTokenRequest interface {
// RefreshTokenExchange handles the OAuth 2.0 refresh_token grant, including
// parsing, validating, authorizing the client and finally exchanging the refresh_token for new tokens
func RefreshTokenExchange(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
- ctx, span := tracer.Start(r.Context(), "RefreshTokenExchange")
- defer span.End()
- r = r.WithContext(ctx)
-
tokenReq, err := ParseRefreshTokenRequest(r, exchanger.Decoder())
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
}
validatedRequest, client, err := ValidateRefreshTokenRequest(r.Context(), tokenReq, exchanger)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
resp, err := CreateTokenResponse(r.Context(), validatedRequest, client, exchanger, true, "", tokenReq.RefreshToken)
if err != nil {
- RequestError(w, r, err, exchanger.Logger())
+ RequestError(w, r, err)
return
}
httphelper.MarshalJSON(w, resp)
@@ -58,9 +54,6 @@ func ParseRefreshTokenRequest(r *http.Request, decoder httphelper.Decoder) (*oid
// ValidateRefreshTokenRequest validates the refresh_token request parameters including authorization check of the client
// and returns the data representing the original auth request corresponding to the refresh_token
func ValidateRefreshTokenRequest(ctx context.Context, tokenReq *oidc.RefreshTokenRequest, exchanger Exchanger) (RefreshTokenRequest, Client, error) {
- ctx, span := tracer.Start(ctx, "ValidateRefreshTokenRequest")
- defer span.End()
-
if tokenReq.RefreshToken == "" {
return nil, nil, oidc.ErrInvalidRequest().WithDescription("refresh_token missing")
}
@@ -85,7 +78,7 @@ func ValidateRefreshTokenScopes(requestedScopes []string, authRequest RefreshTok
return nil
}
for _, scope := range requestedScopes {
- if !slices.Contains(authRequest.GetScopes(), scope) {
+ if !strings.Contains(authRequest.GetScopes(), scope) {
return oidc.ErrInvalidScope()
}
}
@@ -96,9 +89,6 @@ func ValidateRefreshTokenScopes(requestedScopes []string, authRequest RefreshTok
// AuthorizeRefreshClient checks the authorization of the client and that the used method was the one previously registered.
// It than returns the data representing the original auth request corresponding to the refresh_token
func AuthorizeRefreshClient(ctx context.Context, tokenReq *oidc.RefreshTokenRequest, exchanger Exchanger) (request RefreshTokenRequest, client Client, err error) {
- ctx, span := tracer.Start(ctx, "AuthorizeRefreshClient")
- defer span.End()
-
if tokenReq.ClientAssertionType == oidc.ClientAssertionTypeJWTAssertion {
jwtExchanger, ok := exchanger.(JWTAuthorizationGrantExchanger)
if !ok || !exchanger.AuthMethodPrivateKeyJWTSupported() {
@@ -141,9 +131,6 @@ func AuthorizeRefreshClient(ctx context.Context, tokenReq *oidc.RefreshTokenRequ
// RefreshTokenRequestByRefreshToken returns the RefreshTokenRequest (data representing the original auth request)
// corresponding to the refresh_token from Storage or an error
func RefreshTokenRequestByRefreshToken(ctx context.Context, storage Storage, refreshToken string) (RefreshTokenRequest, error) {
- ctx, span := tracer.Start(ctx, "RefreshTokenRequestByRefreshToken")
- defer span.End()
-
request, err := storage.TokenRequestByRefreshToken(ctx, refreshToken)
if err != nil {
return nil, oidc.ErrInvalidGrant().WithParent(err)
diff --git a/pkg/op/token_request.go b/pkg/op/token_request.go
index 3f5af7a..6ccd489 100644
--- a/pkg/op/token_request.go
+++ b/pkg/op/token_request.go
@@ -2,17 +2,18 @@ package op
import (
"context"
- "log/slog"
"net/http"
"net/url"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type Exchanger interface {
+ Issuer() string
Storage() Storage
Decoder() httphelper.Decoder
+ Signer() Signer
Crypto() Crypto
AuthMethodPostSupported() bool
AuthMethodPrivateKeyJWTSupported() bool
@@ -20,27 +21,16 @@ type Exchanger interface {
GrantTypeTokenExchangeSupported() bool
GrantTypeJWTAuthorizationSupported() bool
GrantTypeClientCredentialsSupported() bool
- GrantTypeDeviceCodeSupported() bool
- AccessTokenVerifier(context.Context) *AccessTokenVerifier
- IDTokenHintVerifier(context.Context) *IDTokenHintVerifier
- Logger() *slog.Logger
}
func tokenHandler(exchanger Exchanger) func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
- ctx, span := tracer.Start(r.Context(), "tokenHandler")
- defer span.End()
-
- Exchange(w, r.WithContext(ctx), exchanger)
+ Exchange(w, r, exchanger)
}
}
// Exchange performs a token exchange appropriate for the grant type
func Exchange(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
- ctx, span := tracer.Start(r.Context(), "Exchange")
- r = r.WithContext(ctx)
- defer span.End()
-
grantType := r.FormValue("grant_type")
switch grantType {
case string(oidc.GrantTypeCode):
@@ -66,16 +56,11 @@ func Exchange(w http.ResponseWriter, r *http.Request, exchanger Exchanger) {
ClientCredentialsExchange(w, r, exchanger)
return
}
- case string(oidc.GrantTypeDeviceCode):
- if exchanger.GrantTypeDeviceCodeSupported() {
- DeviceAccessToken(w, r, exchanger)
- return
- }
case "":
- RequestError(w, r, oidc.ErrInvalidRequest().WithDescription("grant_type missing"), exchanger.Logger())
+ RequestError(w, r, oidc.ErrInvalidRequest().WithDescription("grant_type missing"))
return
}
- RequestError(w, r, oidc.ErrUnsupportedGrantType().WithDescription("%s not supported", grantType), exchanger.Logger())
+ RequestError(w, r, oidc.ErrUnsupportedGrantType().WithDescription("%s not supported", grantType))
}
// AuthenticatedTokenRequest is a helper interface for ParseAuthenticatedTokenRequest
@@ -88,10 +73,6 @@ type AuthenticatedTokenRequest interface {
// ParseAuthenticatedTokenRequest parses the client_id and client_secret from the HTTP request from either
// HTTP Basic Auth header or form body and sets them into the provided authenticatedTokenRequest interface
func ParseAuthenticatedTokenRequest(r *http.Request, decoder httphelper.Decoder, request AuthenticatedTokenRequest) error {
- ctx, span := tracer.Start(r.Context(), "ParseAuthenticatedTokenRequest")
- defer span.End()
- r = r.WithContext(ctx)
-
err := r.ParseForm()
if err != nil {
return oidc.ErrInvalidRequest().WithDescription("error parsing form").WithParent(err)
@@ -119,9 +100,6 @@ func ParseAuthenticatedTokenRequest(r *http.Request, decoder httphelper.Decoder,
// AuthorizeClientIDSecret authorizes a client by validating the client_id and client_secret (Basic Auth and POST)
func AuthorizeClientIDSecret(ctx context.Context, clientID, clientSecret string, storage Storage) error {
- ctx, span := tracer.Start(ctx, "AuthorizeClientIDSecret")
- defer span.End()
-
err := storage.AuthorizeClientIDSecret(ctx, clientID, clientSecret)
if err != nil {
return oidc.ErrInvalidClient().WithDescription("invalid client_id / client_secret").WithParent(err)
@@ -131,20 +109,12 @@ func AuthorizeClientIDSecret(ctx context.Context, clientID, clientSecret string,
// AuthorizeCodeChallenge authorizes a client by validating the code_verifier against the previously sent
// code_challenge of the auth request (PKCE)
-func AuthorizeCodeChallenge(codeVerifier string, challenge *oidc.CodeChallenge) error {
- if challenge == nil {
- if codeVerifier != "" {
- return oidc.ErrInvalidRequest().WithDescription("code_verifier unexpectedly provided")
- }
-
- return nil
+func AuthorizeCodeChallenge(tokenReq *oidc.AccessTokenRequest, challenge *oidc.CodeChallenge) error {
+ if tokenReq.CodeVerifier == "" {
+ return oidc.ErrInvalidRequest().WithDescription("code_challenge required")
}
-
- if codeVerifier == "" {
- return oidc.ErrInvalidRequest().WithDescription("code_verifier required")
- }
- if !oidc.VerifyCodeChallenge(challenge, codeVerifier) {
- return oidc.ErrInvalidGrant().WithDescription("invalid code_verifier")
+ if !oidc.VerifyCodeChallenge(challenge, tokenReq.CodeVerifier) {
+ return oidc.ErrInvalidGrant().WithDescription("invalid code challenge")
}
return nil
}
@@ -152,10 +122,7 @@ func AuthorizeCodeChallenge(codeVerifier string, challenge *oidc.CodeChallenge)
// AuthorizePrivateJWTKey authorizes a client by validating the client_assertion's signature with a previously
// registered public key (JWT Profile)
func AuthorizePrivateJWTKey(ctx context.Context, clientAssertion string, exchanger JWTAuthorizationGrantExchanger) (Client, error) {
- ctx, span := tracer.Start(ctx, "AuthorizePrivateJWTKey")
- defer span.End()
-
- jwtReq, err := VerifyJWTAssertion(ctx, clientAssertion, exchanger.JWTProfileVerifier(ctx))
+ jwtReq, err := VerifyJWTAssertion(ctx, clientAssertion, exchanger.JWTProfileVerifier())
if err != nil {
return nil, err
}
@@ -169,8 +136,8 @@ func AuthorizePrivateJWTKey(ctx context.Context, clientAssertion string, exchang
return client, nil
}
-// ValidateGrantType ensures that the requested grant_type is allowed by the client
-func ValidateGrantType(client interface{ GrantTypes() []oidc.GrantType }, grantType oidc.GrantType) bool {
+// ValidateGrantType ensures that the requested grant_type is allowed by the Client
+func ValidateGrantType(client Client, grantType oidc.GrantType) bool {
if client == nil {
return false
}
diff --git a/pkg/op/token_request_test.go b/pkg/op/token_request_test.go
deleted file mode 100644
index d226af6..0000000
--- a/pkg/op/token_request_test.go
+++ /dev/null
@@ -1,75 +0,0 @@
-package op_test
-
-import (
- "testing"
-
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "github.com/stretchr/testify/assert"
-)
-
-func TestAuthorizeCodeChallenge(t *testing.T) {
- tests := []struct {
- name string
- codeVerifier string
- codeChallenge *oidc.CodeChallenge
- want func(t *testing.T, err error)
- }{
- {
- name: "missing both code_verifier and code_challenge",
- codeVerifier: "",
- codeChallenge: nil,
- want: func(t *testing.T, err error) {
- assert.Nil(t, err)
- },
- },
- {
- name: "valid code_verifier",
- codeVerifier: "Hello World!",
- codeChallenge: &oidc.CodeChallenge{
- Challenge: "f4OxZX_x_FO5LcGBSKHWXfwtSx-j1ncoSt3SABJtkGk",
- Method: oidc.CodeChallengeMethodS256,
- },
- want: func(t *testing.T, err error) {
- assert.Nil(t, err)
- },
- },
- {
- name: "invalid code_verifier",
- codeVerifier: "Hi World!",
- codeChallenge: &oidc.CodeChallenge{
- Challenge: "f4OxZX_x_FO5LcGBSKHWXfwtSx-j1ncoSt3SABJtkGk",
- Method: oidc.CodeChallengeMethodS256,
- },
- want: func(t *testing.T, err error) {
- assert.ErrorContains(t, err, "invalid code_verifier")
- },
- },
- {
- name: "code_verifier provided without code_challenge",
- codeVerifier: "code_verifier",
- codeChallenge: nil,
- want: func(t *testing.T, err error) {
- assert.ErrorContains(t, err, "code_verifier unexpectedly provided")
- },
- },
- {
- name: "empty code_verifier",
- codeVerifier: "",
- codeChallenge: &oidc.CodeChallenge{
- Challenge: "f4OxZX_x_FO5LcGBSKHWXfwtSx-j1ncoSt3SABJtkGk",
- Method: oidc.CodeChallengeMethodS256,
- },
- want: func(t *testing.T, err error) {
- assert.ErrorContains(t, err, "code_verifier required")
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- err := op.AuthorizeCodeChallenge(tt.codeVerifier, tt.codeChallenge)
-
- tt.want(t, err)
- })
- }
-}
diff --git a/pkg/op/token_revocation.go b/pkg/op/token_revocation.go
index 049ee15..9dd0295 100644
--- a/pkg/op/token_revocation.go
+++ b/pkg/op/token_revocation.go
@@ -7,22 +7,22 @@ import (
"net/url"
"strings"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type Revoker interface {
Decoder() httphelper.Decoder
Crypto() Crypto
Storage() Storage
- AccessTokenVerifier(context.Context) *AccessTokenVerifier
+ AccessTokenVerifier() AccessTokenVerifier
AuthMethodPrivateKeyJWTSupported() bool
AuthMethodPostSupported() bool
}
type RevokerJWTProfile interface {
Revoker
- JWTProfileVerifier(context.Context) *JWTProfileVerifier
+ JWTProfileVerifier() JWTProfileVerifier
}
func revocationHandler(revoker Revoker) func(http.ResponseWriter, *http.Request) {
@@ -32,10 +32,6 @@ func revocationHandler(revoker Revoker) func(http.ResponseWriter, *http.Request)
}
func Revoke(w http.ResponseWriter, r *http.Request, revoker Revoker) {
- ctx, span := tracer.Start(r.Context(), "Revoke")
- r = r.WithContext(ctx)
- defer span.End()
-
token, tokenTypeHint, clientID, err := ParseTokenRevocationRequest(r, revoker)
if err != nil {
RevocationRequestError(w, r, err)
@@ -43,8 +39,8 @@ func Revoke(w http.ResponseWriter, r *http.Request, revoker Revoker) {
}
var subject string
doDecrypt := true
- if tokenTypeHint != "access_token" {
- userID, tokenID, err := revoker.Storage().GetRefreshTokenInfo(r.Context(), clientID, token)
+ if canRefreshInfo, ok := revoker.Storage().(CanRefreshTokenInfo); ok && tokenTypeHint != "access_token" {
+ userID, tokenID, err := canRefreshInfo.GetRefreshTokenInfo(r.Context(), clientID, token)
if err != nil {
// An invalid refresh token means that we'll try other things (leaving doDecrypt==true)
if !errors.Is(err, ErrInvalidRefreshToken) {
@@ -72,10 +68,6 @@ func Revoke(w http.ResponseWriter, r *http.Request, revoker Revoker) {
}
func ParseTokenRevocationRequest(r *http.Request, revoker Revoker) (token, tokenTypeHint, clientID string, err error) {
- ctx, span := tracer.Start(r.Context(), "ParseTokenRevocationRequest")
- r = r.WithContext(ctx)
- defer span.End()
-
err = r.ParseForm()
if err != nil {
return "", "", "", oidc.ErrInvalidRequest().WithDescription("unable to parse request").WithParent(err)
@@ -95,7 +87,7 @@ func ParseTokenRevocationRequest(r *http.Request, revoker Revoker) (token, token
if !ok || !revoker.AuthMethodPrivateKeyJWTSupported() {
return "", "", "", oidc.ErrInvalidClient().WithDescription("auth_method private_key_jwt not supported")
}
- profile, err := VerifyJWTAssertion(r.Context(), req.ClientAssertion, revokerJWTProfile.JWTProfileVerifier(r.Context()))
+ profile, err := VerifyJWTAssertion(r.Context(), req.ClientAssertion, revokerJWTProfile.JWTProfileVerifier())
if err == nil {
return req.Token, req.TokenTypeHint, profile.Issuer, nil
}
@@ -139,11 +131,6 @@ func ParseTokenRevocationRequest(r *http.Request, revoker Revoker) (token, token
}
func RevocationRequestError(w http.ResponseWriter, r *http.Request, err error) {
- statusErr := RevocationError(err)
- httphelper.MarshalJSONWithStatus(w, statusErr.parent, statusErr.statusCode)
-}
-
-func RevocationError(err error) StatusError {
e := oidc.DefaultToServerError(err, err.Error())
status := http.StatusBadRequest
switch e.ErrorType {
@@ -152,13 +139,10 @@ func RevocationError(err error) StatusError {
case oidc.ServerError:
status = 500
}
- return NewStatusError(e, status)
+ httphelper.MarshalJSONWithStatus(w, e, status)
}
func getTokenIDAndSubjectForRevocation(ctx context.Context, userinfoProvider UserinfoProvider, accessToken string) (string, string, bool) {
- ctx, span := tracer.Start(ctx, "getTokenIDAndSubjectForRevocation")
- defer span.End()
-
tokenIDSubject, err := userinfoProvider.Crypto().Decrypt(accessToken)
if err == nil {
splitToken := strings.Split(tokenIDSubject, ":")
@@ -167,9 +151,9 @@ func getTokenIDAndSubjectForRevocation(ctx context.Context, userinfoProvider Use
}
return splitToken[0], splitToken[1], true
}
- accessTokenClaims, err := VerifyAccessToken[*oidc.AccessTokenClaims](ctx, accessToken, userinfoProvider.AccessTokenVerifier(ctx))
+ accessTokenClaims, err := VerifyAccessToken(ctx, accessToken, userinfoProvider.AccessTokenVerifier())
if err != nil {
return "", "", false
}
- return accessTokenClaims.JWTID, accessTokenClaims.Subject, true
+ return accessTokenClaims.GetTokenID(), accessTokenClaims.GetSubject(), true
}
diff --git a/pkg/op/userinfo.go b/pkg/op/userinfo.go
index ff75e72..4bd03e2 100644
--- a/pkg/op/userinfo.go
+++ b/pkg/op/userinfo.go
@@ -6,15 +6,15 @@ import (
"net/http"
"strings"
- httphelper "git.christmann.info/LARA/zitadel-oidc/v3/pkg/http"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ httphelper "github.com/zitadel/oidc/pkg/http"
+ "github.com/zitadel/oidc/pkg/oidc"
)
type UserinfoProvider interface {
Decoder() httphelper.Decoder
Crypto() Crypto
Storage() Storage
- AccessTokenVerifier(context.Context) *AccessTokenVerifier
+ AccessTokenVerifier() AccessTokenVerifier
}
func userinfoHandler(userinfoProvider UserinfoProvider) func(http.ResponseWriter, *http.Request) {
@@ -24,10 +24,6 @@ func userinfoHandler(userinfoProvider UserinfoProvider) func(http.ResponseWriter
}
func Userinfo(w http.ResponseWriter, r *http.Request, userinfoProvider UserinfoProvider) {
- ctx, span := tracer.Start(r.Context(), "Userinfo")
- r = r.WithContext(ctx)
- defer span.End()
-
accessToken, err := ParseUserinfoRequest(r, userinfoProvider.Decoder())
if err != nil {
http.Error(w, "access token missing", http.StatusUnauthorized)
@@ -38,7 +34,7 @@ func Userinfo(w http.ResponseWriter, r *http.Request, userinfoProvider UserinfoP
http.Error(w, "access token invalid", http.StatusUnauthorized)
return
}
- info := new(oidc.UserInfo)
+ info := oidc.NewUserInfo()
err = userinfoProvider.Storage().SetUserinfoFromToken(r.Context(), info, tokenID, subject, r.Header.Get("origin"))
if err != nil {
httphelper.MarshalJSONWithStatus(w, err, http.StatusForbidden)
@@ -48,10 +44,6 @@ func Userinfo(w http.ResponseWriter, r *http.Request, userinfoProvider UserinfoP
}
func ParseUserinfoRequest(r *http.Request, decoder httphelper.Decoder) (string, error) {
- ctx, span := tracer.Start(r.Context(), "ParseUserinfoRequest")
- r = r.WithContext(ctx)
- defer span.End()
-
accessToken, err := getAccessToken(r)
if err == nil {
return accessToken, nil
@@ -69,10 +61,6 @@ func ParseUserinfoRequest(r *http.Request, decoder httphelper.Decoder) (string,
}
func getAccessToken(r *http.Request) (string, error) {
- ctx, span := tracer.Start(r.Context(), "getAccessToken")
- r = r.WithContext(ctx)
- defer span.End()
-
authHeader := r.Header.Get("authorization")
if authHeader == "" {
return "", errors.New("no auth header")
@@ -85,9 +73,6 @@ func getAccessToken(r *http.Request) (string, error) {
}
func getTokenIDAndSubject(ctx context.Context, userinfoProvider UserinfoProvider, accessToken string) (string, string, bool) {
- ctx, span := tracer.Start(ctx, "getTokenIDAndSubject")
- defer span.End()
-
tokenIDSubject, err := userinfoProvider.Crypto().Decrypt(accessToken)
if err == nil {
splitToken := strings.Split(tokenIDSubject, ":")
@@ -96,9 +81,9 @@ func getTokenIDAndSubject(ctx context.Context, userinfoProvider UserinfoProvider
}
return splitToken[0], splitToken[1], true
}
- accessTokenClaims, err := VerifyAccessToken[*oidc.AccessTokenClaims](ctx, accessToken, userinfoProvider.AccessTokenVerifier(ctx))
+ accessTokenClaims, err := VerifyAccessToken(ctx, accessToken, userinfoProvider.AccessTokenVerifier())
if err != nil {
return "", "", false
}
- return accessTokenClaims.JWTID, accessTokenClaims.Subject, true
+ return accessTokenClaims.GetTokenID(), accessTokenClaims.GetSubject(), true
}
diff --git a/pkg/op/verifier_access_token.go b/pkg/op/verifier_access_token.go
index 585ca54..1729c23 100644
--- a/pkg/op/verifier_access_token.go
+++ b/pkg/op/verifier_access_token.go
@@ -2,25 +2,64 @@ package op
import (
"context"
+ "time"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/oidc"
)
-type AccessTokenVerifier oidc.Verifier
+type AccessTokenVerifier interface {
+ oidc.Verifier
+ SupportedSignAlgs() []string
+ KeySet() oidc.KeySet
+}
-type AccessTokenVerifierOpt func(*AccessTokenVerifier)
+type accessTokenVerifier struct {
+ issuer string
+ maxAgeIAT time.Duration
+ offset time.Duration
+ supportedSignAlgs []string
+ maxAge time.Duration
+ acr oidc.ACRVerifier
+ keySet oidc.KeySet
+}
+
+// Issuer implements oidc.Verifier interface
+func (i *accessTokenVerifier) Issuer() string {
+ return i.issuer
+}
+
+// MaxAgeIAT implements oidc.Verifier interface
+func (i *accessTokenVerifier) MaxAgeIAT() time.Duration {
+ return i.maxAgeIAT
+}
+
+// Offset implements oidc.Verifier interface
+func (i *accessTokenVerifier) Offset() time.Duration {
+ return i.offset
+}
+
+// SupportedSignAlgs implements AccessTokenVerifier interface
+func (i *accessTokenVerifier) SupportedSignAlgs() []string {
+ return i.supportedSignAlgs
+}
+
+// KeySet implements AccessTokenVerifier interface
+func (i *accessTokenVerifier) KeySet() oidc.KeySet {
+ return i.keySet
+}
+
+type AccessTokenVerifierOpt func(*accessTokenVerifier)
func WithSupportedAccessTokenSigningAlgorithms(algs ...string) AccessTokenVerifierOpt {
- return func(verifier *AccessTokenVerifier) {
- verifier.SupportedSignAlgs = algs
+ return func(verifier *accessTokenVerifier) {
+ verifier.supportedSignAlgs = algs
}
}
-// NewAccessTokenVerifier returns a AccessTokenVerifier suitable for access token verification.
-func NewAccessTokenVerifier(issuer string, keySet oidc.KeySet, opts ...AccessTokenVerifierOpt) *AccessTokenVerifier {
- verifier := &AccessTokenVerifier{
- Issuer: issuer,
- KeySet: keySet,
+func NewAccessTokenVerifier(issuer string, keySet oidc.KeySet, opts ...AccessTokenVerifierOpt) AccessTokenVerifier {
+ verifier := &accessTokenVerifier{
+ issuer: issuer,
+ keySet: keySet,
}
for _, opt := range opts {
opt(verifier)
@@ -28,32 +67,29 @@ func NewAccessTokenVerifier(issuer string, keySet oidc.KeySet, opts ...AccessTok
return verifier
}
-// VerifyAccessToken validates the access token (issuer, signature and expiration).
-func VerifyAccessToken[C oidc.Claims](ctx context.Context, token string, v *AccessTokenVerifier) (claims C, err error) {
- ctx, span := tracer.Start(ctx, "VerifyAccessToken")
- defer span.End()
-
- var nilClaims C
+// VerifyAccessToken validates the access token (issuer, signature and expiration)
+func VerifyAccessToken(ctx context.Context, token string, v AccessTokenVerifier) (oidc.AccessTokenClaims, error) {
+ claims := oidc.EmptyAccessTokenClaims()
decrypted, err := oidc.DecryptToken(token)
if err != nil {
- return nilClaims, err
+ return nil, err
}
- payload, err := oidc.ParseToken(decrypted, &claims)
+ payload, err := oidc.ParseToken(decrypted, claims)
if err != nil {
- return nilClaims, err
+ return nil, err
}
- if err := oidc.CheckIssuer(claims, v.Issuer); err != nil {
- return nilClaims, err
+ if err := oidc.CheckIssuer(claims, v.Issuer()); err != nil {
+ return nil, err
}
- if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs, v.KeySet); err != nil {
- return nilClaims, err
+ if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs(), v.KeySet()); err != nil {
+ return nil, err
}
- if err = oidc.CheckExpiration(claims, v.Offset); err != nil {
- return nilClaims, err
+ if err = oidc.CheckExpiration(claims, v.Offset()); err != nil {
+ return nil, err
}
return claims, nil
diff --git a/pkg/op/verifier_access_token_example_test.go b/pkg/op/verifier_access_token_example_test.go
deleted file mode 100644
index b97a7fd..0000000
--- a/pkg/op/verifier_access_token_example_test.go
+++ /dev/null
@@ -1,70 +0,0 @@
-package op_test
-
-import (
- "context"
- "fmt"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
-)
-
-// MyCustomClaims extends the TokenClaims base,
-// so it implements the oidc.Claims interface.
-// Instead of carrying a map, we add needed fields// to the struct for type safe access.
-type MyCustomClaims struct {
- oidc.TokenClaims
- NotBefore oidc.Time `json:"nbf,omitempty"`
- CodeHash string `json:"c_hash,omitempty"`
- SessionID string `json:"sid,omitempty"`
- Scopes []string `json:"scope,omitempty"`
- AccessTokenUseNumber int `json:"at_use_nbr,omitempty"`
- Foo string `json:"foo,omitempty"`
- Bar *Nested `json:"bar,omitempty"`
-}
-
-// Nested struct types are also possible.
-type Nested struct {
- Count int `json:"count,omitempty"`
- Tags []string `json:"tags,omitempty"`
-}
-
-/*
-accessToken carries the following claims. foo and bar are custom claims
-
- {
- "aud": [
- "unit",
- "test"
- ],
- "bar": {
- "count": 22,
- "tags": [
- "some",
- "tags"
- ]
- },
- "exp": 4802234675,
- "foo": "Hello, World!",
- "iat": 1678097014,
- "iss": "local.com",
- "jti": "9876",
- "nbf": 1678097014,
- "sub": "tim@local.com"
- }
-*/
-const accessToken = `eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJhdWQiOlsidW5pdCIsInRlc3QiXSwiYmFyIjp7ImNvdW50IjoyMiwidGFncyI6WyJzb21lIiwidGFncyJdfSwiZXhwIjo0ODAyMjM0Njc1LCJmb28iOiJIZWxsbywgV29ybGQhIiwiaWF0IjoxNjc4MDk3MDE0LCJpc3MiOiJsb2NhbC5jb20iLCJqdGkiOiI5ODc2IiwibmJmIjoxNjc4MDk3MDE0LCJzdWIiOiJ0aW1AbG9jYWwuY29tIn0.OUgk-B7OXjYlYFj-nogqSDJiQE19tPrbzqUHEAjcEiJkaWo6-IpGVfDiGKm-TxjXQsNScxpaY0Pg3XIh1xK6TgtfYtoLQm-5RYw_mXgb9xqZB2VgPs6nNEYFUDM513MOU0EBc0QMyqAEGzW-HiSPAb4ugCvkLtM1yo11Xyy6vksAdZNs_mJDT4X3vFXnr0jk0ugnAW6fTN3_voC0F_9HQUAkmd750OIxkAHxAMvEPQcpbLHenVvX_Q0QMrzClVrxehn5TVMfmkYYg7ocr876Bq9xQGPNHAcrwvVIJqdg5uMUA38L3HC2BEueG6furZGvc7-qDWAT1VR9liM5ieKpPg`
-
-func ExampleVerifyAccessToken_customClaims() {
- v := op.NewAccessTokenVerifier("local.com", tu.KeySet{})
-
- // VerifyAccessToken can be called with the *MyCustomClaims.
- claims, err := op.VerifyAccessToken[*MyCustomClaims](context.TODO(), accessToken, v)
- if err != nil {
- panic(err)
- }
-
- // Here we have typesafe access to the custom claims
- fmt.Println(claims.Foo, claims.Bar.Count, claims.Bar.Tags)
- // Output: Hello, World! 22 [some tags]
-}
diff --git a/pkg/op/verifier_access_token_test.go b/pkg/op/verifier_access_token_test.go
deleted file mode 100644
index 5845f9f..0000000
--- a/pkg/op/verifier_access_token_test.go
+++ /dev/null
@@ -1,126 +0,0 @@
-package op
-
-import (
- "context"
- "testing"
- "time"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestNewAccessTokenVerifier(t *testing.T) {
- type args struct {
- issuer string
- keySet oidc.KeySet
- opts []AccessTokenVerifierOpt
- }
- tests := []struct {
- name string
- args args
- want *AccessTokenVerifier
- }{
- {
- name: "simple",
- args: args{
- issuer: tu.ValidIssuer,
- keySet: tu.KeySet{},
- },
- want: &AccessTokenVerifier{
- Issuer: tu.ValidIssuer,
- KeySet: tu.KeySet{},
- },
- },
- {
- name: "with signature algorithm",
- args: args{
- issuer: tu.ValidIssuer,
- keySet: tu.KeySet{},
- opts: []AccessTokenVerifierOpt{
- WithSupportedAccessTokenSigningAlgorithms("ABC", "DEF"),
- },
- },
- want: &AccessTokenVerifier{
- Issuer: tu.ValidIssuer,
- KeySet: tu.KeySet{},
- SupportedSignAlgs: []string{"ABC", "DEF"},
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := NewAccessTokenVerifier(tt.args.issuer, tt.args.keySet, tt.args.opts...)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func TestVerifyAccessToken(t *testing.T) {
- verifier := &AccessTokenVerifier{
- Issuer: tu.ValidIssuer,
- MaxAgeIAT: 2 * time.Minute,
- Offset: time.Second,
- SupportedSignAlgs: []string{string(tu.SignatureAlgorithm)},
- KeySet: tu.KeySet{},
- }
-
- tests := []struct {
- name string
- tokenClaims func() (string, *oidc.AccessTokenClaims)
- wantErr bool
- }{
- {
- name: "success",
- tokenClaims: tu.ValidAccessToken,
- },
- {
- name: "parse err",
- tokenClaims: func() (string, *oidc.AccessTokenClaims) { return "~~~~", nil },
- wantErr: true,
- },
- {
- name: "invalid signature",
- tokenClaims: func() (string, *oidc.AccessTokenClaims) { return tu.InvalidSignatureToken, nil },
- wantErr: true,
- },
- {
- name: "wrong issuer",
- tokenClaims: func() (string, *oidc.AccessTokenClaims) {
- return tu.NewAccessToken(
- "foo", tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidJWTID, tu.ValidClientID,
- tu.ValidSkew,
- )
- },
- wantErr: true,
- },
- {
- name: "expired",
- tokenClaims: func() (string, *oidc.AccessTokenClaims) {
- return tu.NewAccessToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration.Add(-time.Hour), tu.ValidJWTID, tu.ValidClientID,
- tu.ValidSkew,
- )
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- token, want := tt.tokenClaims()
-
- got, err := VerifyAccessToken[*oidc.AccessTokenClaims](context.Background(), token, verifier)
- if tt.wantErr {
- assert.Error(t, err)
- assert.Nil(t, got)
- return
- }
- require.NoError(t, err)
- require.NotNil(t, got)
- assert.Equal(t, got, want)
- })
- }
-}
diff --git a/pkg/op/verifier_id_token_hint.go b/pkg/op/verifier_id_token_hint.go
index 02610aa..d36bbd8 100644
--- a/pkg/op/verifier_id_token_hint.go
+++ b/pkg/op/verifier_id_token_hint.go
@@ -2,25 +2,69 @@ package op
import (
"context"
- "errors"
+ "time"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/oidc"
)
-type IDTokenHintVerifier oidc.Verifier
+type IDTokenHintVerifier interface {
+ oidc.Verifier
+ SupportedSignAlgs() []string
+ KeySet() oidc.KeySet
+ ACR() oidc.ACRVerifier
+ MaxAge() time.Duration
+}
-type IDTokenHintVerifierOpt func(*IDTokenHintVerifier)
+type idTokenHintVerifier struct {
+ issuer string
+ maxAgeIAT time.Duration
+ offset time.Duration
+ supportedSignAlgs []string
+ maxAge time.Duration
+ acr oidc.ACRVerifier
+ keySet oidc.KeySet
+}
+
+func (i *idTokenHintVerifier) Issuer() string {
+ return i.issuer
+}
+
+func (i *idTokenHintVerifier) MaxAgeIAT() time.Duration {
+ return i.maxAgeIAT
+}
+
+func (i *idTokenHintVerifier) Offset() time.Duration {
+ return i.offset
+}
+
+func (i *idTokenHintVerifier) SupportedSignAlgs() []string {
+ return i.supportedSignAlgs
+}
+
+func (i *idTokenHintVerifier) KeySet() oidc.KeySet {
+ return i.keySet
+}
+
+func (i *idTokenHintVerifier) ACR() oidc.ACRVerifier {
+ return i.acr
+}
+
+func (i *idTokenHintVerifier) MaxAge() time.Duration {
+ return i.maxAge
+}
+
+type IDTokenHintVerifierOpt func(*idTokenHintVerifier)
func WithSupportedIDTokenHintSigningAlgorithms(algs ...string) IDTokenHintVerifierOpt {
- return func(verifier *IDTokenHintVerifier) {
- verifier.SupportedSignAlgs = algs
+ return func(verifier *idTokenHintVerifier) {
+ verifier.supportedSignAlgs = algs
}
}
-func NewIDTokenHintVerifier(issuer string, keySet oidc.KeySet, opts ...IDTokenHintVerifierOpt) *IDTokenHintVerifier {
- verifier := &IDTokenHintVerifier{
- Issuer: issuer,
- KeySet: keySet,
+func NewIDTokenHintVerifier(issuer string, keySet oidc.KeySet, opts ...IDTokenHintVerifierOpt) IDTokenHintVerifier {
+ verifier := &idTokenHintVerifier{
+ issuer: issuer,
+ keySet: keySet,
}
for _, opt := range opts {
opt(verifier)
@@ -28,60 +72,42 @@ func NewIDTokenHintVerifier(issuer string, keySet oidc.KeySet, opts ...IDTokenHi
return verifier
}
-type IDTokenHintExpiredError struct {
- error
-}
-
-func (e IDTokenHintExpiredError) Unwrap() error {
- return e.error
-}
-
-func (e IDTokenHintExpiredError) Is(err error) bool {
- return errors.Is(err, e.error)
-}
-
// VerifyIDTokenHint validates the id token according to
-// https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation.
-// In case of an expired token both the Claims and first encountered expiry related error
-// is returned of type [IDTokenHintExpiredError]. In that case the caller can choose to still
-// trust the token for cases like logout, as signature and other verifications succeeded.
-func VerifyIDTokenHint[C oidc.Claims](ctx context.Context, token string, v *IDTokenHintVerifier) (claims C, err error) {
- ctx, span := tracer.Start(ctx, "VerifyIDTokenHint")
- defer span.End()
-
- var nilClaims C
+//https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
+func VerifyIDTokenHint(ctx context.Context, token string, v IDTokenHintVerifier) (oidc.IDTokenClaims, error) {
+ claims := oidc.EmptyIDTokenClaims()
decrypted, err := oidc.DecryptToken(token)
if err != nil {
- return nilClaims, err
+ return nil, err
}
- payload, err := oidc.ParseToken(decrypted, &claims)
+ payload, err := oidc.ParseToken(decrypted, claims)
if err != nil {
- return nilClaims, err
+ return nil, err
}
- if err := oidc.CheckIssuer(claims, v.Issuer); err != nil {
- return nilClaims, err
+ if err := oidc.CheckIssuer(claims, v.Issuer()); err != nil {
+ return nil, err
}
- if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs, v.KeySet); err != nil {
- return nilClaims, err
+ if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs(), v.KeySet()); err != nil {
+ return nil, err
}
- if err = oidc.CheckAuthorizationContextClassReference(claims, v.ACR); err != nil {
- return nilClaims, err
+ if err = oidc.CheckExpiration(claims, v.Offset()); err != nil {
+ return nil, err
}
- if err = oidc.CheckExpiration(claims, v.Offset); err != nil {
- return claims, IDTokenHintExpiredError{err}
+ if err = oidc.CheckIssuedAt(claims, v.MaxAgeIAT(), v.Offset()); err != nil {
+ return nil, err
}
- if err = oidc.CheckIssuedAt(claims, v.MaxAgeIAT, v.Offset); err != nil {
- return claims, IDTokenHintExpiredError{err}
+ if err = oidc.CheckAuthorizationContextClassReference(claims, v.ACR()); err != nil {
+ return nil, err
}
- if err = oidc.CheckAuthTime(claims, v.MaxAge); err != nil {
- return claims, IDTokenHintExpiredError{err}
+ if err = oidc.CheckAuthTime(claims, v.MaxAge()); err != nil {
+ return nil, err
}
return claims, nil
}
diff --git a/pkg/op/verifier_id_token_hint_test.go b/pkg/op/verifier_id_token_hint_test.go
deleted file mode 100644
index 347e33c..0000000
--- a/pkg/op/verifier_id_token_hint_test.go
+++ /dev/null
@@ -1,172 +0,0 @@
-package op
-
-import (
- "context"
- "errors"
- "testing"
- "time"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestNewIDTokenHintVerifier(t *testing.T) {
- type args struct {
- issuer string
- keySet oidc.KeySet
- opts []IDTokenHintVerifierOpt
- }
- tests := []struct {
- name string
- args args
- want *IDTokenHintVerifier
- }{
- {
- name: "simple",
- args: args{
- issuer: tu.ValidIssuer,
- keySet: tu.KeySet{},
- },
- want: &IDTokenHintVerifier{
- Issuer: tu.ValidIssuer,
- KeySet: tu.KeySet{},
- },
- },
- {
- name: "with signature algorithm",
- args: args{
- issuer: tu.ValidIssuer,
- keySet: tu.KeySet{},
- opts: []IDTokenHintVerifierOpt{
- WithSupportedIDTokenHintSigningAlgorithms("ABC", "DEF"),
- },
- },
- want: &IDTokenHintVerifier{
- Issuer: tu.ValidIssuer,
- KeySet: tu.KeySet{},
- SupportedSignAlgs: []string{"ABC", "DEF"},
- },
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := NewIDTokenHintVerifier(tt.args.issuer, tt.args.keySet, tt.args.opts...)
- assert.Equal(t, tt.want, got)
- })
- }
-}
-
-func Test_IDTokenHintExpiredError(t *testing.T) {
- var err error = IDTokenHintExpiredError{oidc.ErrExpired}
- assert.True(t, errors.Unwrap(err) == oidc.ErrExpired)
- assert.ErrorIs(t, err, oidc.ErrExpired)
- assert.ErrorAs(t, err, &IDTokenHintExpiredError{})
-}
-
-func TestVerifyIDTokenHint(t *testing.T) {
- verifier := &IDTokenHintVerifier{
- Issuer: tu.ValidIssuer,
- MaxAgeIAT: 2 * time.Minute,
- Offset: time.Second,
- SupportedSignAlgs: []string{string(tu.SignatureAlgorithm)},
- MaxAge: 2 * time.Minute,
- ACR: tu.ACRVerify,
- KeySet: tu.KeySet{},
- }
-
- tests := []struct {
- name string
- tokenClaims func() (string, *oidc.IDTokenClaims)
- wantClaims bool
- wantErr error
- }{
- {
- name: "success",
- tokenClaims: tu.ValidIDToken,
- wantClaims: true,
- },
- {
- name: "parse err",
- tokenClaims: func() (string, *oidc.IDTokenClaims) { return "~~~~", nil },
- wantErr: oidc.ErrParse,
- },
- {
- name: "invalid signature",
- tokenClaims: func() (string, *oidc.IDTokenClaims) { return tu.InvalidSignatureToken, nil },
- wantErr: oidc.ErrSignatureUnsupportedAlg,
- },
- {
- name: "wrong issuer",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- "foo", tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: oidc.ErrIssuerInvalid,
- },
- {
- name: "wrong acr",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- "else", tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantErr: oidc.ErrAcrInvalid,
- },
- {
- name: "expired",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration.Add(-time.Hour), tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantClaims: true,
- wantErr: IDTokenHintExpiredError{oidc.ErrExpired},
- },
- {
- name: "IAT too old",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime, tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, time.Hour, "",
- )
- },
- wantClaims: true,
- wantErr: IDTokenHintExpiredError{oidc.ErrIatToOld},
- },
- {
- name: "expired auth",
- tokenClaims: func() (string, *oidc.IDTokenClaims) {
- return tu.NewIDToken(
- tu.ValidIssuer, tu.ValidSubject, tu.ValidAudience,
- tu.ValidExpiration, tu.ValidAuthTime.Add(-time.Hour), tu.ValidNonce,
- tu.ValidACR, tu.ValidAMR, tu.ValidClientID, tu.ValidSkew, "",
- )
- },
- wantClaims: true,
- wantErr: IDTokenHintExpiredError{oidc.ErrAuthTimeToOld},
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- token, want := tt.tokenClaims()
-
- got, err := VerifyIDTokenHint[*oidc.IDTokenClaims](context.Background(), token, verifier)
- require.ErrorIs(t, err, tt.wantErr)
- if tt.wantClaims {
- assert.Equal(t, got, want, "claims")
- return
- }
- assert.Nil(t, got, "claims")
- })
- }
-}
diff --git a/pkg/op/verifier_jwt_profile.go b/pkg/op/verifier_jwt_profile.go
index 85bfb14..0215e84 100644
--- a/pkg/op/verifier_jwt_profile.go
+++ b/pkg/op/verifier_jwt_profile.go
@@ -6,41 +6,33 @@ import (
"fmt"
"time"
- jose "github.com/go-jose/go-jose/v4"
+ "gopkg.in/square/go-jose.v2"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
+ "github.com/zitadel/oidc/pkg/oidc"
)
-// JWTProfileVerfiier extends oidc.Verifier with
-// a jwtProfileKeyStorage and a function to check
-// the subject in a token.
-type JWTProfileVerifier struct {
+type JWTProfileVerifier interface {
oidc.Verifier
- Storage JWTProfileKeyStorage
- keySet oidc.KeySet
- CheckSubject func(request *oidc.JWTTokenRequest) error
+ Storage() jwtProfileKeyStorage
+ CheckSubject(request *oidc.JWTTokenRequest) error
+}
+
+type jwtProfileVerifier struct {
+ storage jwtProfileKeyStorage
+ subjectCheck func(request *oidc.JWTTokenRequest) error
+ issuer string
+ maxAgeIAT time.Duration
+ offset time.Duration
}
// NewJWTProfileVerifier creates a oidc.Verifier for JWT Profile assertions (authorization grant and client authentication)
-func NewJWTProfileVerifier(storage JWTProfileKeyStorage, issuer string, maxAgeIAT, offset time.Duration, opts ...JWTProfileVerifierOption) *JWTProfileVerifier {
- return newJWTProfileVerifier(storage, nil, issuer, maxAgeIAT, offset, opts...)
-}
-
-// NewJWTProfileVerifierKeySet creates a oidc.Verifier for JWT Profile assertions (authorization grant and client authentication)
-func NewJWTProfileVerifierKeySet(keySet oidc.KeySet, issuer string, maxAgeIAT, offset time.Duration, opts ...JWTProfileVerifierOption) *JWTProfileVerifier {
- return newJWTProfileVerifier(nil, keySet, issuer, maxAgeIAT, offset, opts...)
-}
-
-func newJWTProfileVerifier(storage JWTProfileKeyStorage, keySet oidc.KeySet, issuer string, maxAgeIAT, offset time.Duration, opts ...JWTProfileVerifierOption) *JWTProfileVerifier {
- j := &JWTProfileVerifier{
- Verifier: oidc.Verifier{
- Issuer: issuer,
- MaxAgeIAT: maxAgeIAT,
- Offset: offset,
- },
- Storage: storage,
- keySet: keySet,
- CheckSubject: SubjectIsIssuer,
+func NewJWTProfileVerifier(storage jwtProfileKeyStorage, issuer string, maxAgeIAT, offset time.Duration, opts ...JWTProfileVerifierOption) JWTProfileVerifier {
+ j := &jwtProfileVerifier{
+ storage: storage,
+ subjectCheck: SubjectIsIssuer,
+ issuer: issuer,
+ maxAgeIAT: maxAgeIAT,
+ offset: offset,
}
for _, opt := range opts {
@@ -50,38 +42,53 @@ func newJWTProfileVerifier(storage JWTProfileKeyStorage, keySet oidc.KeySet, iss
return j
}
-type JWTProfileVerifierOption func(*JWTProfileVerifier)
+type JWTProfileVerifierOption func(*jwtProfileVerifier)
-// SubjectCheck sets a custom function to check the subject.
-// Defaults to SubjectIsIssuer()
func SubjectCheck(check func(request *oidc.JWTTokenRequest) error) JWTProfileVerifierOption {
- return func(verifier *JWTProfileVerifier) {
- verifier.CheckSubject = check
+ return func(verifier *jwtProfileVerifier) {
+ verifier.subjectCheck = check
}
}
+func (v *jwtProfileVerifier) Issuer() string {
+ return v.issuer
+}
+
+func (v *jwtProfileVerifier) Storage() jwtProfileKeyStorage {
+ return v.storage
+}
+
+func (v *jwtProfileVerifier) MaxAgeIAT() time.Duration {
+ return v.maxAgeIAT
+}
+
+func (v *jwtProfileVerifier) Offset() time.Duration {
+ return v.offset
+}
+
+func (v *jwtProfileVerifier) CheckSubject(request *oidc.JWTTokenRequest) error {
+ return v.subjectCheck(request)
+}
+
// VerifyJWTAssertion verifies the assertion string from JWT Profile (authorization grant and client authentication)
//
// checks audience, exp, iat, signature and that issuer and sub are the same
-func VerifyJWTAssertion(ctx context.Context, assertion string, v *JWTProfileVerifier) (*oidc.JWTTokenRequest, error) {
- ctx, span := tracer.Start(ctx, "VerifyJWTAssertion")
- defer span.End()
-
+func VerifyJWTAssertion(ctx context.Context, assertion string, v JWTProfileVerifier) (*oidc.JWTTokenRequest, error) {
request := new(oidc.JWTTokenRequest)
payload, err := oidc.ParseToken(assertion, request)
if err != nil {
return nil, err
}
- if err = oidc.CheckAudience(request, v.Issuer); err != nil {
+ if err = oidc.CheckAudience(request, v.Issuer()); err != nil {
return nil, err
}
- if err = oidc.CheckExpiration(request, v.Offset); err != nil {
+ if err = oidc.CheckExpiration(request, v.Offset()); err != nil {
return nil, err
}
- if err = oidc.CheckIssuedAt(request, v.MaxAgeIAT, v.Offset); err != nil {
+ if err = oidc.CheckIssuedAt(request, v.MaxAgeIAT(), v.Offset()); err != nil {
return nil, err
}
@@ -89,21 +96,17 @@ func VerifyJWTAssertion(ctx context.Context, assertion string, v *JWTProfileVeri
return nil, err
}
- keySet := v.keySet
- if keySet == nil {
- keySet = &jwtProfileKeySet{storage: v.Storage, clientID: request.Issuer}
- }
+ keySet := &jwtProfileKeySet{storage: v.Storage(), clientID: request.Issuer}
if err = oidc.CheckSignature(ctx, assertion, payload, request, nil, keySet); err != nil {
return nil, err
}
return request, nil
}
-type JWTProfileKeyStorage interface {
- GetKeyByIDAndClientID(ctx context.Context, keyID, userID string) (*jose.JSONWebKey, error)
+type jwtProfileKeyStorage interface {
+ GetKeyByIDAndUserID(ctx context.Context, keyID, userID string) (*jose.JSONWebKey, error)
}
-// SubjectIsIssuer
func SubjectIsIssuer(request *oidc.JWTTokenRequest) error {
if request.Issuer != request.Subject {
return errors.New("delegation not allowed, issuer and sub must be identical")
@@ -112,17 +115,14 @@ func SubjectIsIssuer(request *oidc.JWTTokenRequest) error {
}
type jwtProfileKeySet struct {
- storage JWTProfileKeyStorage
+ storage jwtProfileKeyStorage
clientID string
}
// VerifySignature implements oidc.KeySet by getting the public key from Storage implementation
func (k *jwtProfileKeySet) VerifySignature(ctx context.Context, jws *jose.JSONWebSignature) (payload []byte, err error) {
- ctx, span := tracer.Start(ctx, "VerifySignature")
- defer span.End()
-
keyID, _ := oidc.GetKeyIDAndAlg(jws)
- key, err := k.storage.GetKeyByIDAndClientID(ctx, keyID, k.clientID)
+ key, err := k.storage.GetKeyByIDAndUserID(ctx, keyID, k.clientID)
if err != nil {
return nil, fmt.Errorf("error fetching keys: %w", err)
}
diff --git a/pkg/op/verifier_jwt_profile_test.go b/pkg/op/verifier_jwt_profile_test.go
deleted file mode 100644
index 2068678..0000000
--- a/pkg/op/verifier_jwt_profile_test.go
+++ /dev/null
@@ -1,117 +0,0 @@
-package op_test
-
-import (
- "context"
- "testing"
- "time"
-
- tu "git.christmann.info/LARA/zitadel-oidc/v3/internal/testutil"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/oidc"
- "git.christmann.info/LARA/zitadel-oidc/v3/pkg/op"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestNewJWTProfileVerifier(t *testing.T) {
- want := &op.JWTProfileVerifier{
- Verifier: oidc.Verifier{
- Issuer: tu.ValidIssuer,
- MaxAgeIAT: time.Minute,
- Offset: time.Second,
- },
- Storage: tu.JWTProfileKeyStorage{},
- }
- got := op.NewJWTProfileVerifier(tu.JWTProfileKeyStorage{}, tu.ValidIssuer, time.Minute, time.Second, op.SubjectCheck(func(request *oidc.JWTTokenRequest) error {
- return oidc.ErrSubjectMissing
- }))
- assert.Equal(t, want.Verifier, got.Verifier)
- assert.Equal(t, want.Storage, got.Storage)
- assert.ErrorIs(t, got.CheckSubject(nil), oidc.ErrSubjectMissing)
-}
-
-func TestVerifyJWTAssertion(t *testing.T) {
- errCtx, cancel := context.WithCancel(context.Background())
- cancel()
-
- verifier := op.NewJWTProfileVerifier(tu.JWTProfileKeyStorage{}, tu.ValidIssuer, time.Minute, 0)
- tests := []struct {
- name string
- ctx context.Context
- newToken func() (string, *oidc.JWTTokenRequest)
- wantErr bool
- }{
- {
- name: "parse error",
- ctx: context.Background(),
- newToken: func() (string, *oidc.JWTTokenRequest) { return "!", nil },
- wantErr: true,
- },
- {
- name: "wrong audience",
- ctx: context.Background(),
- newToken: func() (string, *oidc.JWTTokenRequest) {
- return tu.NewJWTProfileAssertion(
- tu.ValidClientID, tu.ValidClientID, []string{"wrong"},
- time.Now(), tu.ValidExpiration,
- )
- },
- wantErr: true,
- },
- {
- name: "expired",
- ctx: context.Background(),
- newToken: func() (string, *oidc.JWTTokenRequest) {
- return tu.NewJWTProfileAssertion(
- tu.ValidClientID, tu.ValidClientID, []string{tu.ValidIssuer},
- time.Now(), time.Now().Add(-time.Hour),
- )
- },
- wantErr: true,
- },
- {
- name: "invalid iat",
- ctx: context.Background(),
- newToken: func() (string, *oidc.JWTTokenRequest) {
- return tu.NewJWTProfileAssertion(
- tu.ValidClientID, tu.ValidClientID, []string{tu.ValidIssuer},
- time.Now().Add(time.Hour), tu.ValidExpiration,
- )
- },
- wantErr: true,
- },
- {
- name: "invalid subject",
- ctx: context.Background(),
- newToken: func() (string, *oidc.JWTTokenRequest) {
- return tu.NewJWTProfileAssertion(
- tu.ValidClientID, "wrong", []string{tu.ValidIssuer},
- time.Now(), tu.ValidExpiration,
- )
- },
- wantErr: true,
- },
- {
- name: "check signature fail",
- ctx: errCtx,
- newToken: tu.ValidJWTProfileAssertion,
- wantErr: true,
- },
- {
- name: "ok",
- ctx: context.Background(),
- newToken: tu.ValidJWTProfileAssertion,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assertion, want := tt.newToken()
- got, err := op.VerifyJWTAssertion(tt.ctx, assertion, verifier)
- if tt.wantErr {
- assert.Error(t, err)
- return
- }
- require.NoError(t, err)
- assert.Equal(t, want, got)
- })
- }
-}
diff --git a/pkg/strings/strings.go b/pkg/strings/strings.go
index b8f43a1..af48cf3 100644
--- a/pkg/strings/strings.go
+++ b/pkg/strings/strings.go
@@ -1,9 +1,10 @@
package strings
-import "slices"
-
-// Deprecated: Use standard library [slices.Contains] instead.
func Contains(list []string, needle string) bool {
- // TODO(v4): remove package.
- return slices.Contains(list, needle)
+ for _, item := range list {
+ if item == needle {
+ return true
+ }
+ }
+ return false
}