summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/oidc_protocol.idl
blob: 4835ccdf93e5ca807d33f15c6d60913c2b726eed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Copyright (C) 2022-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
    cpp_namespace: "mongo::auth"
    cpp_includes: []

imports:
    - "mongo/db/basic_types.idl"

structs:
    OIDCMechanismClientStep1:
        description: Client's opening request in saslStart or
                     hello.speculativeAuthenticate
        strict: false
        fields:
            n:
                description: "Principal name of client"
                cpp_name: principalName
                type: string
                optional: true

    OIDCMechanismServerStep1:
        description: "Server's reply to clientStep1"
        strict: false
        fields:
            issuer:
                description: >-
                    URL which describes the Authorization Server. This identifier should be
                    the iss of provided access tokens, and be viable for RFC8414
                    metadata discovery and RFC9207 identification.
                type: string
            clientId:
                description: "Unique client ID for this OIDC client"
                type: string
            requestScopes:
                description: "Additional scopes to request from IDP"
                type: array<string>
                optional: true
    OIDCMechanismClientStep2:
        description: "Client's request with signed token"
        strict: false
        fields:
            jwt:
                description: "Compact serialized JWT with signature"
                cpp_name: JWT
                type: string