-
Notifications
You must be signed in to change notification settings - Fork 207
/
resource_okta_app_oauth.go
933 lines (894 loc) · 30.4 KB
/
resource_okta_app_oauth.go
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
package okta
import (
"context"
"encoding/json"
"errors"
"fmt"
"time"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/okta/terraform-provider-okta/sdk"
"github.com/okta/terraform-provider-okta/sdk/query"
)
type (
applicationMap struct {
RequiredGrantTypes []string
ValidGrantTypes []string
}
)
const (
authorizationCode = "authorization_code"
interactionCode = "interaction_code"
implicit = "implicit"
password = "password"
refreshToken = "refresh_token"
clientCredentials = "client_credentials"
tokenExchange = "urn:ietf:params:oauth:grant-type:token-exchange"
saml2Bearer = "urn:ietf:params:oauth:grant-type:saml2-bearer"
deviceCode = "urn:ietf:params:oauth:grant-type:device_code"
)
// Building out structure for the conditional validation logic. It looks like customizing the diff
// is the best way to implement this logic, as it needs to introspect.
// NOTE: opened a ticket to Okta to fix their docs, they are off.
// https://developer.okta.com/docs/api/resources/apps#credentials-settings-details
var appRequirementsByType = map[string]*applicationMap{
"web": {
RequiredGrantTypes: []string{
authorizationCode,
},
ValidGrantTypes: []string{
authorizationCode,
implicit,
refreshToken,
clientCredentials,
saml2Bearer,
tokenExchange,
deviceCode,
interactionCode,
},
},
"native": {
RequiredGrantTypes: []string{
authorizationCode,
},
ValidGrantTypes: []string{
authorizationCode,
implicit,
refreshToken,
password,
saml2Bearer,
tokenExchange,
deviceCode,
interactionCode,
},
},
"browser": {
ValidGrantTypes: []string{
implicit,
authorizationCode,
refreshToken,
saml2Bearer,
tokenExchange,
deviceCode,
interactionCode,
},
},
"service": {
ValidGrantTypes: []string{
clientCredentials,
implicit,
saml2Bearer,
tokenExchange,
deviceCode,
interactionCode,
},
RequiredGrantTypes: []string{
clientCredentials,
},
},
}
func resourceAppOAuth() *schema.Resource {
return &schema.Resource{
CreateContext: resourceAppOAuthCreate,
ReadContext: resourceAppOAuthRead,
UpdateContext: resourceAppOAuthUpdate,
DeleteContext: resourceAppOAuthDelete,
Importer: &schema.ResourceImporter{
StateContext: appImporter,
},
CustomizeDiff: func(_ context.Context, d *schema.ResourceDiff, v interface{}) error {
// Force new if omit_secret goes from true to false
if d.Id() != "" {
oldValue, newValue := d.GetChange("omit_secret")
if oldValue.(bool) && !newValue.(bool) {
return d.ForceNew("omit_secret")
}
}
return nil
},
// For those familiar with Terraform schemas be sure to check the base application schema and/or
// the examples in the documentation
Schema: buildAppSchema(map[string]*schema.Schema{
"type": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: "The type of client application.",
},
"client_id": {
Type: schema.TypeString,
// This field is Optional + Computed because okta automatically sets the
// client_id value if none is specified during creation.
// If the client_id is set after creation, the resource will be recreated only if its different from
// the computed client_id.
Optional: true,
ForceNew: true,
Computed: true,
Description: "OAuth client ID. If set during creation, app is created with this id.",
},
"omit_secret": {
Type: schema.TypeBool,
Optional: true,
// No ForceNew to avoid recreating when going from false => true
Description: "This tells the provider not to persist the application's secret to state. If this is ever changes from true => false your app will be recreated.",
Default: false,
},
"client_secret": {
Type: schema.TypeString,
Computed: true,
Sensitive: true,
Description: "OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.",
},
"client_basic_secret": {
Type: schema.TypeString,
Optional: true,
Sensitive: true,
Description: "OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.",
},
"token_endpoint_auth_method": {
Type: schema.TypeString,
Optional: true,
Default: "client_secret_basic",
Description: "Requested authentication method for the token endpoint.",
},
// API docs say that auto_key_rotation will alwas be set true if it
// is missing on input therefore we can declare it's default to be
// true in the schema.
"auto_key_rotation": {
Type: schema.TypeBool,
Optional: true,
Default: true,
Description: "Requested key rotation mode.",
},
"client_uri": {
Type: schema.TypeString,
Optional: true,
Description: "URI to a web page providing information about the client.",
},
"logo_uri": {
Type: schema.TypeString,
Optional: true,
Description: "URI that references a logo for the client.",
},
"login_uri": {
Type: schema.TypeString,
Optional: true,
Description: "URI that initiates login.",
},
"login_mode": {
Type: schema.TypeString,
Optional: true,
Description: "The type of Idp-Initiated login that the client supports, if any",
Default: "DISABLED",
},
"login_scopes": {
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Schema{
Type: schema.TypeString,
},
Description: "List of scopes to use for the request",
},
"pkce_required": {
Type: schema.TypeBool,
Optional: true,
Description: "Require Proof Key for Code Exchange (PKCE) for additional verification key rotation mode. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object",
DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
// when pkce_required is not set in the HCL
if old == "true" && new == "false" {
return true
}
return false
},
},
"redirect_uris": {
Type: schema.TypeList,
Elem: &schema.Schema{Type: schema.TypeString},
Optional: true,
Description: "List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.",
},
"wildcard_redirect": {
Type: schema.TypeString,
Optional: true,
Description: "*Early Access Property*. Indicates if the client is allowed to use wildcard matching of redirect_uris",
Default: "DISABLED",
},
"post_logout_redirect_uris": {
Type: schema.TypeSet,
Elem: &schema.Schema{Type: schema.TypeString},
Optional: true,
Description: "List of URIs for redirection after logout. Note: see okta_app_oauth_post_logout_redirect_uri for appending to this list in a decentralized way.",
},
"response_types": {
Type: schema.TypeSet,
Elem: &schema.Schema{
Type: schema.TypeString,
},
Optional: true,
Description: "List of OAuth 2.0 response type strings.",
},
"grant_types": {
Type: schema.TypeSet,
Elem: &schema.Schema{
Type: schema.TypeString,
},
Optional: true,
Description: "List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.",
},
"tos_uri": {
Type: schema.TypeString,
Optional: true,
Description: "URI to web page providing client tos (terms of service).",
},
"policy_uri": {
Type: schema.TypeString,
Optional: true,
Description: "URI to web page providing client policy document.",
},
"consent_method": {
Type: schema.TypeString,
Optional: true,
Default: "TRUSTED",
Description: "*Early Access Property*. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED",
},
"issuer_mode": {
Type: schema.TypeString,
Optional: true,
Default: "ORG_URL",
Description: "*Early Access Property*. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.",
},
"refresh_token_rotation": {
Type: schema.TypeString,
Optional: true,
Default: "STATIC",
Description: "*Early Access Property* Refresh token rotation behavior, required with grant types refresh_token",
},
"refresh_token_leeway": {
Type: schema.TypeInt,
Optional: true,
Default: 0,
Description: "*Early Access Property* Grace period for token rotation, required with grant types refresh_token",
},
"auto_submit_toolbar": {
Type: schema.TypeBool,
Optional: true,
Default: false,
Description: "Display auto submit toolbar",
},
"hide_ios": {
Type: schema.TypeBool,
Optional: true,
Default: true,
Description: "Do not display application icon on mobile app",
},
"hide_web": {
Type: schema.TypeBool,
Optional: true,
Default: true,
Description: "Do not display application icon to users",
},
"profile": {
Type: schema.TypeString,
ValidateDiagFunc: stringIsJSON,
StateFunc: normalizeDataJSON,
Optional: true,
Description: "Custom JSON that represents an OAuth application's profile",
DiffSuppressFunc: noChangeInObjectFromUnmarshaledJSON,
},
"jwks": {
Type: schema.TypeList,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"kid": {
Type: schema.TypeString,
Required: true,
Description: "Key ID",
},
"kty": {
Type: schema.TypeString,
Required: true,
Description: "Key type",
},
"e": {
Type: schema.TypeString,
Optional: true,
Description: "RSA Exponent",
},
"n": {
Type: schema.TypeString,
Optional: true,
Description: "RSA Modulus",
},
"x": {
Type: schema.TypeString,
Optional: true,
Description: "X coordinate of the elliptic curve point",
},
"y": {
Type: schema.TypeString,
Optional: true,
Description: "Y coordinate of the elliptic curve point",
},
},
},
},
"implicit_assignment": {
Type: schema.TypeBool,
Optional: true,
Description: "*Early Access Property*. Enable Federation Broker Mode.",
},
"groups_claim": {
Type: schema.TypeSet,
MaxItems: 1,
Description: "Groups claim for an OpenID Connect client application (argument is ignored when API auth is done with OAuth 2.0 credentials)",
Optional: true,
Elem: groupsClaimResource,
},
"app_settings_json": {
Type: schema.TypeString,
Optional: true,
Description: "Application settings in JSON format",
ValidateDiagFunc: stringIsJSON,
StateFunc: normalizeDataJSON,
DiffSuppressFunc: noChangeInObjectFromUnmarshaledJSON,
},
"authentication_policy": {
Type: schema.TypeString,
Optional: true,
Description: "Id of this apps authentication policy",
},
"jwks_uri": {
Type: schema.TypeString,
Optional: true,
Description: "URL reference to JWKS",
},
}),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(1 * time.Hour),
Read: schema.DefaultTimeout(1 * time.Hour),
Update: schema.DefaultTimeout(1 * time.Hour),
},
}
}
var groupsClaimResource = &schema.Resource{
Schema: map[string]*schema.Schema{
"type": {
Description: "Groups claim type.",
Type: schema.TypeString,
Required: true,
},
"filter_type": {
Description: "Groups claim filter. Can only be set if type is FILTER.",
Type: schema.TypeString,
Optional: true,
},
"name": {
Description: "Name of the claim that will be used in the token.",
Type: schema.TypeString,
Required: true,
},
"value": {
Description: "Value of the claim. Can be an Okta Expression Language statement that evaluates at the time the token is minted.",
Type: schema.TypeString,
Required: true,
},
"issuer_mode": {
Type: schema.TypeString,
Computed: true,
Description: "Issuer mode inherited from OAuth App",
},
},
}
func resourceAppOAuthCreate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
client := getOktaClientFromMetadata(m)
if err := validateGrantTypes(d); err != nil {
return diag.Errorf("failed to create OAuth application: %v", err)
}
if err := validateAppOAuth(d, m); err != nil {
return diag.Errorf("failed to create OAuth application: %v", err)
}
app := buildAppOAuth(d)
activate := d.Get("status").(string) == statusActive
params := &query.Params{Activate: &activate}
_, _, err := client.Application.CreateApplication(ctx, app, params)
if err != nil {
return diag.Errorf("failed to create OAuth application: %v", err)
}
d.SetId(app.Id)
if !d.Get("omit_secret").(bool) {
_ = d.Set("client_secret", app.Credentials.OauthClient.ClientSecret)
}
err = handleAppLogo(ctx, d, m, app.Id, app.Links)
if err != nil {
return diag.Errorf("failed to upload logo for OAuth application: %v", err)
}
err = setAppOauthGroupsClaim(ctx, d, m)
if err != nil {
return diag.Errorf("failed to update groups claim for an OAuth application: %v", err)
}
err = createOrUpdateAuthenticationPolicy(ctx, d, m, app.Id)
if err != nil {
return diag.Errorf("failed to set authentication policy for an OAuth application: %v", err)
}
return resourceAppOAuthRead(ctx, d, m)
}
func setAppOauthGroupsClaim(ctx context.Context, d *schema.ResourceData, m interface{}) error {
c := m.(*Config)
if c.IsOAuth20Auth() {
logger(m).Warn("setting groups_claim disabled with OAuth 2.0 API authentication")
return nil
}
raw, ok := d.GetOk("groups_claim")
if !ok {
return nil
}
groupsClaim := raw.(*schema.Set).List()[0].(map[string]interface{})
gc := &sdk.AppOauthGroupClaim{
Name: groupsClaim["name"].(string),
Value: groupsClaim["value"].(string),
}
if d.Get("issuer_mode") != nil {
gc.IssuerMode = d.Get("issuer_mode").(string)
}
gct := groupsClaim["type"].(string)
if gct == "FILTER" {
gc.ValueType = "GROUPS"
gc.GroupFilterType = groupsClaim["filter_type"].(string)
} else {
gc.ValueType = gct
}
_, err := getAPISupplementFromMetadata(m).UpdateAppOauthGroupsClaim(ctx, d.Id(), gc)
return err
}
func updateAppOauthGroupsClaim(ctx context.Context, d *schema.ResourceData, m interface{}) error {
c := m.(*Config)
if c.IsOAuth20Auth() {
logger(m).Warn("updating groups_claim disabled with OAuth 2.0 API authentication")
return nil
}
raw, ok := d.GetOk("groups_claim")
if !ok {
return nil
}
if len(raw.(*schema.Set).List()) == 0 {
gc := &sdk.AppOauthGroupClaim{
IssuerMode: d.Get("issuer_mode").(string),
}
_, err := getAPISupplementFromMetadata(m).UpdateAppOauthGroupsClaim(ctx, d.Id(), gc)
return err
}
return setAppOauthGroupsClaim(ctx, d, m)
}
func resourceAppOAuthRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
app := sdk.NewOpenIdConnectApplication()
err := fetchApp(ctx, d, m, app)
if err != nil {
return diag.Errorf("failed to get OAuth application: %v", err)
}
if app.Id == "" {
d.SetId("")
return nil
}
setAuthenticationPolicy(d, app.Links)
var rawProfile string
if app.Profile != nil {
p, _ := json.Marshal(app.Profile)
rawProfile = string(p)
}
if app.Credentials.UserNameTemplate != nil {
_ = d.Set("user_name_template", app.Credentials.UserNameTemplate.Template)
_ = d.Set("user_name_template_type", app.Credentials.UserNameTemplate.Type)
_ = d.Set("user_name_template_suffix", app.Credentials.UserNameTemplate.Suffix)
_ = d.Set("user_name_template_push_status", app.Credentials.UserNameTemplate.PushStatus)
}
appRead(d, app.Name, app.Status, app.SignOnMode, app.Label, app.Accessibility, app.Visibility, app.Settings.Notes)
_ = d.Set("profile", rawProfile)
// Not setting client_secret, it is only provided on create and update for auth methods that require it
if app.Credentials.OauthClient != nil {
_ = d.Set("client_id", app.Credentials.OauthClient.ClientId)
_ = d.Set("token_endpoint_auth_method", app.Credentials.OauthClient.TokenEndpointAuthMethod)
_ = d.Set("auto_key_rotation", app.Credentials.OauthClient.AutoKeyRotation)
_ = d.Set("pkce_required", app.Credentials.OauthClient.PkceRequired)
}
err = setAppSettings(d, app.Settings.App)
if err != nil {
return diag.Errorf("failed to set OAuth application settings: %v", err)
}
_ = d.Set("logo_url", linksValue(app.Links, "logo", "href"))
if app.Settings.ImplicitAssignment != nil {
_ = d.Set("implicit_assignment", *app.Settings.ImplicitAssignment)
} else {
_ = d.Set("implicit_assignment", false)
}
// If this is ever changed omit it.
if d.Get("omit_secret").(bool) {
_ = d.Set("client_secret", "")
}
c := m.(*Config)
if c.IsOAuth20Auth() {
logger(m).Warn("reading groups_claim disabled with OAuth 2.0 API authentication")
} else {
gc, err := flattenGroupsClaim(ctx, d, m)
if err != nil {
return diag.FromErr(err)
}
_ = d.Set("groups_claim", gc)
}
return setOAuthClientSettings(d, app.Settings.OauthClient)
}
func flattenGroupsClaim(ctx context.Context, d *schema.ResourceData, m interface{}) (*schema.Set, error) {
gc, resp, err := getAPISupplementFromMetadata(m).GetAppOauthGroupsClaim(ctx, d.Id())
if err := suppressErrorOn404(resp, err); err != nil {
return nil, fmt.Errorf("failed to get groups claim for OAuth application: %w", err)
}
if gc == nil || gc.Name == "" {
return nil, nil
}
elem := map[string]interface{}{
"name": gc.Name,
"value": gc.Value,
"type": gc.ValueType,
}
if gc.ValueType == "GROUPS" {
elem["type"] = "FILTER"
elem["filter_type"] = gc.GroupFilterType
elem["issuer_mode"] = gc.IssuerMode
}
return schema.NewSet(schema.HashResource(groupsClaimResource), []interface{}{elem}), nil
}
func setOAuthClientSettings(d *schema.ResourceData, oauthClient *sdk.OpenIdConnectApplicationSettingsClient) diag.Diagnostics {
if oauthClient == nil {
return nil
}
_ = d.Set("type", oauthClient.ApplicationType)
_ = d.Set("client_uri", oauthClient.ClientUri)
_ = d.Set("logo_uri", oauthClient.LogoUri)
_ = d.Set("tos_uri", oauthClient.TosUri)
_ = d.Set("policy_uri", oauthClient.PolicyUri)
_ = d.Set("login_uri", oauthClient.InitiateLoginUri)
_ = d.Set("jwks_uri", oauthClient.JwksUri)
if oauthClient.WildcardRedirect != "" {
_ = d.Set("wildcard_redirect", oauthClient.WildcardRedirect)
}
if oauthClient.ConsentMethod != "" { // Early Access Property, might be empty
_ = d.Set("consent_method", oauthClient.ConsentMethod)
}
if oauthClient.IssuerMode != "" {
_ = d.Set("issuer_mode", oauthClient.IssuerMode)
}
if oauthClient.RefreshToken != nil {
_ = d.Set("refresh_token_rotation", oauthClient.RefreshToken.RotationType)
if oauthClient.RefreshToken.LeewayPtr != nil {
_ = d.Set("refresh_token_leeway", *oauthClient.RefreshToken.LeewayPtr)
}
}
if oauthClient.Jwks != nil {
jwks := oauthClient.Jwks.Keys
arr := make([]map[string]interface{}, len(jwks))
for i, jwk := range jwks {
if jwk.Kty == "RSA" && jwk.E != "" && jwk.N != "" {
arr[i] = map[string]interface{}{
"kty": jwk.Kty,
"kid": jwk.Kid,
"e": jwk.E,
"n": jwk.N,
}
}
if jwk.Kty == "EC" && jwk.X != "" && jwk.Y != "" {
arr[i] = map[string]interface{}{
"kty": jwk.Kty,
"kid": jwk.Kid,
"x": jwk.X,
"y": jwk.Y,
}
}
}
err := setNonPrimitives(d, map[string]interface{}{"jwks": arr})
if err != nil {
return diag.Errorf("failed to set OAuth application properties: %v", err)
}
}
respTypes := make([]string, len(oauthClient.ResponseTypes))
for i := range oauthClient.ResponseTypes {
respTypes[i] = string(*oauthClient.ResponseTypes[i])
}
grantTypes := make([]string, len(oauthClient.GrantTypes))
for i := range oauthClient.GrantTypes {
grantTypes[i] = string(*oauthClient.GrantTypes[i])
}
aggMap := map[string]interface{}{
"redirect_uris": oauthClient.RedirectUris,
"response_types": convertStringSliceToSet(respTypes),
"grant_types": convertStringSliceToSet(grantTypes),
"post_logout_redirect_uris": convertStringSliceToSet(oauthClient.PostLogoutRedirectUris),
}
if oauthClient.IdpInitiatedLogin != nil {
_ = d.Set("login_mode", oauthClient.IdpInitiatedLogin.Mode)
aggMap["login_scopes"] = convertStringSliceToSet(oauthClient.IdpInitiatedLogin.DefaultScope)
}
err := setNonPrimitives(d, aggMap)
if err != nil {
return diag.Errorf("failed to set OAuth application properties: %v", err)
}
return nil
}
func resourceAppOAuthUpdate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
additionalChanges, err := appUpdateStatus(ctx, d, m)
if err != nil {
return diag.FromErr(err)
}
if !additionalChanges {
return nil
}
client := getOktaClientFromMetadata(m)
if err := validateGrantTypes(d); err != nil {
return diag.Errorf("failed to update OAuth application: %v", err)
}
if err := validateAppOAuth(d, m); err != nil {
return diag.Errorf("failed to create OAuth application: %v", err)
}
app := buildAppOAuth(d)
_, _, err = client.Application.UpdateApplication(ctx, d.Id(), app)
if err != nil {
return diag.Errorf("failed to update OAuth application: %v", err)
}
if !d.Get("omit_secret").(bool) {
_ = d.Set("client_secret", app.Credentials.OauthClient.ClientSecret)
}
if d.HasChange("logo") {
err = handleAppLogo(ctx, d, m, app.Id, app.Links)
if err != nil {
o, _ := d.GetChange("logo")
_ = d.Set("logo", o)
return diag.Errorf("failed to upload logo for OAuth application: %v", err)
}
}
err = updateAppOauthGroupsClaim(ctx, d, m)
if err != nil {
return diag.Errorf("failed to update groups claim for an OAuth application: %v", err)
}
err = createOrUpdateAuthenticationPolicy(ctx, d, m, app.Id)
if err != nil {
return diag.Errorf("failed to set authentication policy an OAuth application: %v", err)
}
return resourceAppOAuthRead(ctx, d, m)
}
func resourceAppOAuthDelete(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
err := deleteApplication(ctx, d, m)
if err != nil {
return diag.Errorf("failed to delete OAuth application: %v", err)
}
return nil
}
func buildAppOAuth(d *schema.ResourceData) *sdk.OpenIdConnectApplication {
// Abstracts away name and SignOnMode which are constant for this app type.
app := sdk.NewOpenIdConnectApplication()
appType := d.Get("type").(string)
grantTypes := convertInterfaceToStringSet(d.Get("grant_types"))
responseTypes := convertInterfaceToStringSetNullable(d.Get("response_types"))
// If grant_types are not set, we default to the bare minimum.
if len(grantTypes) < 1 {
appMap, ok := appRequirementsByType[appType]
if ok {
if appMap.RequiredGrantTypes == nil {
grantTypes = appMap.ValidGrantTypes
} else {
grantTypes = appMap.RequiredGrantTypes
}
}
}
// Letting users override response types as well, but we properly default them when missing.
if len(responseTypes) < 1 {
responseTypes = []string{}
if containsOne(grantTypes, implicit, clientCredentials) {
responseTypes = append(responseTypes, "token")
}
if containsOne(grantTypes, password, authorizationCode, refreshToken) {
responseTypes = append(responseTypes, "code")
}
}
app.Label = d.Get("label").(string)
authMethod := d.Get("token_endpoint_auth_method").(string)
app.Credentials = &sdk.OAuthApplicationCredentials{
OauthClient: &sdk.ApplicationCredentialsOAuthClient{
AutoKeyRotation: boolPtr(d.Get("auto_key_rotation").(bool)),
ClientId: d.Get("client_id").(string),
TokenEndpointAuthMethod: authMethod,
ClientSecret: d.Get("client_secret").(string),
},
UserNameTemplate: buildUserNameTemplate(d),
}
var pkceRequired *bool
pkceVal := d.GetRawConfig().GetAttr("pkce_required")
// only explicitly set pkce_required to true for browser and native apps
// when it isn't set in the HCL
if pkceVal.IsNull() && (appType == "native" || appType == "browser") {
pkceRequired = boolPtr(true)
} else {
switch {
case pkceVal.True():
pkceRequired = boolPtr(true)
case pkceVal.False():
pkceRequired = boolPtr(false)
}
}
app.Credentials.OauthClient.PkceRequired = pkceRequired
if sec, ok := d.GetOk("client_basic_secret"); ok {
app.Credentials.OauthClient.ClientSecret = sec.(string)
}
oktaRespTypes := make([]*sdk.OAuthResponseType, len(responseTypes))
for i := range responseTypes {
rt := sdk.OAuthResponseType(responseTypes[i])
oktaRespTypes[i] = &rt
}
oktaGrantTypes := make([]*sdk.OAuthGrantType, len(grantTypes))
for i := range grantTypes {
gt := sdk.OAuthGrantType(grantTypes[i])
oktaGrantTypes[i] = >
}
app.Settings = &sdk.OpenIdConnectApplicationSettings{
ImplicitAssignment: boolPtr(d.Get("implicit_assignment").(bool)),
OauthClient: &sdk.OpenIdConnectApplicationSettingsClient{
ApplicationType: appType,
ClientUri: d.Get("client_uri").(string),
ConsentMethod: d.Get("consent_method").(string),
GrantTypes: oktaGrantTypes,
InitiateLoginUri: d.Get("login_uri").(string),
LogoUri: d.Get("logo_uri").(string),
PolicyUri: d.Get("policy_uri").(string),
RedirectUris: convertInterfaceToStringArr(d.Get("redirect_uris")),
PostLogoutRedirectUris: convertInterfaceToStringSetNullable(d.Get("post_logout_redirect_uris")),
ResponseTypes: oktaRespTypes,
TosUri: d.Get("tos_uri").(string),
IssuerMode: d.Get("issuer_mode").(string),
IdpInitiatedLogin: &sdk.OpenIdConnectApplicationIdpInitiatedLogin{
DefaultScope: convertInterfaceToStringSet(d.Get("login_scopes")),
Mode: d.Get("login_mode").(string),
},
WildcardRedirect: d.Get("wildcard_redirect").(string),
JwksUri: d.Get("jwks_uri").(string),
},
Notes: buildAppNotes(d),
App: buildAppSettings(d),
}
jwks := d.Get("jwks").([]interface{})
if len(jwks) > 0 {
keys := make([]*sdk.JsonWebKey, len(jwks))
for i := range jwks {
key := &sdk.JsonWebKey{
Kid: d.Get(fmt.Sprintf("jwks.%d.kid", i)).(string),
Kty: d.Get(fmt.Sprintf("jwks.%d.kty", i)).(string),
}
if e, ok := d.Get(fmt.Sprintf("jwks.%d.e", i)).(string); ok {
key.E = e
key.N = d.Get(fmt.Sprintf("jwks.%d.n", i)).(string)
}
if x, ok := d.Get(fmt.Sprintf("jwks.%d.x", i)).(string); ok {
key.X = x
key.Y = d.Get(fmt.Sprintf("jwks.%d.y", i)).(string)
}
keys[i] = key
}
app.Settings.OauthClient.Jwks = &sdk.OpenIdConnectApplicationSettingsClientKeys{Keys: keys}
}
refresh := &sdk.OpenIdConnectApplicationSettingsRefreshToken{}
var hasRefresh bool
for _, grant_type := range grantTypes {
if grant_type == refreshToken {
hasRefresh = true
break
}
}
if rotate, ok := d.GetOk("refresh_token_rotation"); ok {
refresh.RotationType = rotate.(string)
}
leeway, ok := d.GetOk("refresh_token_leeway")
if ok {
refresh.LeewayPtr = int64Ptr(leeway.(int))
} else {
refresh.LeewayPtr = int64Ptr(0)
}
if hasRefresh {
app.Settings.OauthClient.RefreshToken = refresh
}
// TODO: need to put a warning
// if !hasRefresh && refresh != nil {
// return nil, errors.New("does not have refresh grant type but refresh_token_rotation and refresh_token_leeway exist in payload")
// }
// TODO unset refresh_token_rotation, refresh_token_leeway
app.Visibility = buildAppVisibility(d)
app.Accessibility = buildAppAccessibility(d)
if rawAttrs, ok := d.GetOk("profile"); ok {
var attrs map[string]interface{}
str := rawAttrs.(string)
_ = json.Unmarshal([]byte(str), &attrs)
app.Profile = attrs
}
return app
}
func validateGrantTypes(d *schema.ResourceData) error {
grantTypeList := convertInterfaceToStringSet(d.Get("grant_types"))
appType := d.Get("type").(string)
appMap, ok := appRequirementsByType[appType]
if !ok {
return nil
}
// There is some conditional validation around grant types depending on application type.
return conditionalValidator("grant_types", appType, appMap.RequiredGrantTypes, appMap.ValidGrantTypes, grantTypeList)
}
func validateAppOAuth(d *schema.ResourceData, m interface{}) error {
raw, ok := d.GetOk("groups_claim")
if ok {
c := m.(*Config)
if c.IsOAuth20Auth() {
logger(m).Warn("groups_claim arguments are disabled with OAuth 2.0 API authentication")
} else {
groupsClaim := raw.(*schema.Set).List()[0].(map[string]interface{})
if groupsClaim["type"].(string) == "EXPRESSION" && groupsClaim["filter_type"].(string) != "" {
return errors.New("'filter_type' in 'groups_claim' can only be set when 'type' is set to 'FILTER'")
}
if groupsClaim["type"].(string) == "FILTER" && groupsClaim["filter_type"].(string) == "" {
return errors.New("'filter_type' in 'groups_claim' is required when 'type' is set to 'FILTER'")
}
if groupsClaim["name"].(string) == "" || groupsClaim["value"].(string) == "" {
return errors.New("'name' 'value' and in 'groups_claim' should not be empty")
}
}
}
_, jwks := d.GetOk("jwks")
_, jwks_uri := d.GetOk("jwks_uri")
if !(jwks || jwks_uri) && d.Get("token_endpoint_auth_method").(string) == "private_key_jwt" {
return errors.New("'jwks' or 'jwks_uri' is required when 'token_endpoint_auth_method' is 'private_key_jwt'")
}
if d.Get("login_mode").(string) != "DISABLED" {
if d.Get("login_uri").(string) == "" {
return errors.New("you have to set up 'login_uri' to configure any 'login_mode' besides 'DISABLED'")
}
if d.Get("login_mode").(string) == "OKTA" && len(convertInterfaceToStringSet(d.Get("login_scopes"))) < 1 {
return errors.New("you have to set up non-empty 'login_scopes' when 'login_mode' is 'OKTA'")
}
}
grantTypes := convertInterfaceToStringSet(d.Get("grant_types"))
hasImplicit := false
for _, v := range grantTypes {
if v == "implicit" {
hasImplicit = true
break
}
}
if !hasImplicit {
return nil
}
hasTokenOrTokenID := false
for _, v := range convertInterfaceToStringSetNullable(d.Get("response_types")) {
if v == "token" || v == "id_token" {
hasTokenOrTokenID = true
break
}
}
if !hasTokenOrTokenID {
return errors.New("'response_types' must contain at least one of ['token', 'id_token'] when 'grant_types' contains 'implicit'")
}
return nil
}