forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTS29503_Nudm_UEAU.yaml
284 lines (253 loc) · 8.05 KB
/
TS29503_Nudm_UEAU.yaml
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
openapi: 3.0.0
info:
version: '1.PreR15.1.0'
title: 'UDM UEAU'
description: 'UDM UE Authentication Service'
servers:
- url: '{apiRoot}/nudm-ueau/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.
security:
- oAuth2ClientCredentials: []
- {}
paths:
/{supiOrSuci}/security-information/generate-auth-data:
post:
summary: Generate authentication data for the UE
operationId: GenerateAuthData
tags:
- Generate Auth Data
parameters:
- name: supiOrSuci
in: path
description: SUPI or SUCI of the user
required: true
schema:
$ref: '#/components/schemas/SupiOrSuci'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationInfoRequest'
required: true
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationInfoResult'
'400':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/404'
'500':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/500'
'501':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/501'
'503':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/503'
default:
description: Unexpected error
/{supi}/auth-events:
post:
summary: Create a new confirmation event
operationId: ConfirmAuth
tags:
- Confirm Auth
parameters:
- name: supi
in: path
description: SUPI of the user
required: true
schema:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/Supi'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthEvent'
required: true
responses:
'201':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/AuthEvent'
'400':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/400'
'404':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/404'
'500':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/responses/503'
default:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes: {}
schemas:
# COMPLEX TYPES:
AuthenticationInfoRequest:
type: object
required:
- servingNetworkName
- ausfInstanceId
properties:
supportedFeatures:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
servingNetworkName:
$ref: '#/components/schemas/ServingNetworkName'
resynchronizationInfo:
$ref: '#/components/schemas/ResynchronizationInfo'
ausfInstanceId:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
AuthenticationInfoResult:
type: object
required:
- authType
properties:
authType:
$ref: '#/components/schemas/AuthType'
supportedFeatures:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
authenticationVector:
$ref: '#/components/schemas/AuthenticationVector'
supi:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/Supi'
AuthenticationVector:
oneOf:
- $ref: '#/components/schemas/AvEapAkaPrime'
- $ref: '#/components/schemas/Av5GHeAka'
discriminator:
propertyName: avType
mapping:
5G_HE_AKA: '#/components/schemas/Av5GHeAka'
EAP_AKA_PRIME: '#/components/schemas/AvEapAkaPrime'
AvEapAkaPrime:
type: object
required:
- avType
- rand
- xres
- autn
- ckPrime
- ikPrime
properties:
avType:
$ref: '#/components/schemas/AvType'
rand:
$ref: '#/components/schemas/Rand'
xres:
$ref: '#/components/schemas/Xres'
autn:
$ref: '#/components/schemas/Autn'
ckPrime:
$ref: '#/components/schemas/CkPrime'
ikPrime:
$ref: '#/components/schemas/IkPrime'
Av5GHeAka:
type: object
required:
- avType
- rand
- xresStar
- autn
- kausf
properties:
avType:
$ref: '#/components/schemas/AvType'
rand:
$ref: '#/components/schemas/Rand'
xresStar:
$ref: '#/components/schemas/XresStar'
autn:
$ref: '#/components/schemas/Autn'
kausf:
$ref: '#/components/schemas/Kausf'
ResynchronizationInfo:
type: object
required:
- rand
- auts
properties:
rand:
$ref: '#/components/schemas/Rand'
auts:
$ref: '#/components/schemas/Auts'
AuthEvent:
type: object
required:
- nfInstanceId
- success
- timeStamp
- authType
properties:
nfInstanceId:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
success:
$ref: '#/components/schemas/Success'
timeStamp:
$ref: 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/TS29571_CommonData.yaml#/components/schemas/DateTime'
authType:
$ref: '#/components/schemas/AuthType'
# SIMPLE TYPES:
Autn:
type: string
pattern: '^[A-Fa-f0-9]{32}$'
Auts:
type: string
pattern: '^[A-Fa-f0-9]{28}$'
CkPrime:
type: string
pattern: '^[A-Fa-f0-9]{32}$'
IkPrime:
type: string
pattern: '^[A-Fa-f0-9]{32}$'
Kausf:
type: string
pattern: '^[A-Fa-f0-9]{64}$'
Rand:
type: string
pattern: '^[A-Fa-f0-9]{32}$'
Xres:
type: string
pattern: '^[A-Fa-f0-9]{8,32}$'
XresStar:
type: string
pattern: '^[A-Fa-f0-9]{32}$'
SupiOrSuci:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+| suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.+|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$'
ServingNetworkName:
type: string
pattern: '^5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[.]org$'
Success:
type: boolean
# ENUMS:
AuthType:
anyOf:
- type: string
enum:
- 5G_AKA
- EAP_AKA_PRIME
- EAP_TLS
- type: string
AvType:
anyOf:
- type: string
enum:
- 5G_HE_AKA
- EAP_AKA_PRIME
- type: string