feat(console): OAuth provider template (#5377)

implements oauth template for console
Co-authored-by: Elio Bischof <[email protected]>

console/src/app/modules/idp-table/idp-table.component.html

@@ -46,6 +46,10 @@
               <mat-icon class="idp-icon" svgIcon="mdi_openid" alt="oidc" />
               Generic OIDC
             </div>
+            <div class="idp-table-provider-type" *ngSwitchCase="ProviderType.PROVIDER_TYPE_OAUTH">
+              <img class="idp-logo" src="../../../assets/images/idp/oauth.svg" alt="oauth" />
+              Generic OAuth
+            </div>
             <div class="idp-table-provider-type" *ngSwitchCase="ProviderType.PROVIDER_TYPE_JWT">
               <mat-icon class="idp-icon" svgIcon="mdi_jwt" alt="jwt" />
               Generic JWT

console/src/app/modules/idp-table/idp-table.component.ts

@@ -228,6 +228,8 @@ export class IdpTableComponent implements OnInit {
       switch (row.type) {
         case ProviderType.PROVIDER_TYPE_OIDC:
           return [row.owner === IDPOwnerType.IDP_OWNER_TYPE_SYSTEM ? '/instance' : '/org', 'provider', 'oidc', row.id];
+        case ProviderType.PROVIDER_TYPE_OAUTH:
+          return [row.owner === IDPOwnerType.IDP_OWNER_TYPE_SYSTEM ? '/instance' : '/org', 'provider', 'oauth', row.id];
         case ProviderType.PROVIDER_TYPE_JWT:
           return [row.owner === IDPOwnerType.IDP_OWNER_TYPE_SYSTEM ? '/instance' : '/org', 'provider', 'jwt', row.id];
         case ProviderType.PROVIDER_TYPE_GOOGLE:

console/src/app/modules/policies/idp-settings/idp-settings.component.html

@@ -68,6 +68,23 @@
     </div>
   </a>
 
+  <a
+    class="item card"
+    [routerLink]="
+      serviceType === PolicyComponentServiceType.ADMIN
+        ? ['/instance', 'provider', 'oauth', 'create']
+        : serviceType === PolicyComponentServiceType.MGMT
+        ? ['/org', 'provider', 'oauth', 'create']
+        : []
+    "
+  >
+    <img class="idp-logo" src="../../../assets/images/idp/oauth.svg" alt="oauth" />
+
+    <div class="text-container">
+      <span class="title">Generic OAuth</span>
+    </div>
+  </a>
+
   <a
     class="item card"
     [routerLink]="

console/src/app/modules/providers/provider-oauth/provider-oauth-routing.module.ts

@@ -0,0 +1,18 @@
+import { NgModule } from '@angular/core';
+import { RouterModule, Routes } from '@angular/router';
+
+import { ProviderOAuthComponent } from './provider-oauth.component';
+
+const routes: Routes = [
+  {
+    path: '',
+    component: ProviderOAuthComponent,
+    data: { animation: 'DetailPage' },
+  },
+];
+
+@NgModule({
+  imports: [RouterModule.forChild(routes)],
+  exports: [RouterModule],
+})
+export class ProviderOAuthRoutingModule {}

console/src/app/modules/providers/provider-oauth/provider-oauth.component.html

@@ -0,0 +1,111 @@
+<cnsl-create-layout
+  title="{{ id ? ('IDP.DETAIL.TITLE' | translate) : ('IDP.CREATE.TITLE' | translate) }}"
+  (closed)="close()"
+>
+  <div class="oauth-create-content">
+    <div class="title-row">
+      <img class="idp-logo" src="../../../assets/images/idp/oauth.svg" alt="oauth" />
+
+      <h1>{{ 'IDP.CREATE.OAUTH.TITLE' | translate }}</h1>
+      <mat-spinner diameter="25" *ngIf="loading" color="primary"></mat-spinner>
+    </div>
+
+    <p class="desc cnsl-secondary-text">{{ 'IDP.CREATE.OAUTH.DESCRIPTION' | translate }}</p>
+
+    <form [formGroup]="form" (ngSubmit)="submitForm()">
+      <cnsl-form-field class="formfield">
+        <cnsl-label>{{ 'IDP.NAME' | translate }}</cnsl-label>
+        <input cnslInput formControlName="name" />
+      </cnsl-form-field>
+
+      <cnsl-form-field class="formfield">
+        <cnsl-label>{{ 'IDP.AUTHORIZATIONENDPOINT' | translate }}</cnsl-label>
+        <input cnslInput formControlName="authorizationEndpoint" />
+      </cnsl-form-field>
+
+      <cnsl-form-field class="formfield">
+        <cnsl-label>{{ 'IDP.TOKENENDPOINT' | translate }}</cnsl-label>
+        <input cnslInput formControlName="tokenEndpoint" />
+      </cnsl-form-field>
+
+      <cnsl-form-field class="formfield">
+        <cnsl-label>{{ 'IDP.USERENDPOINT' | translate }}</cnsl-label>
+        <input cnslInput formControlName="userEndpoint" />
+      </cnsl-form-field>
+
+      <cnsl-form-field class="formfield">
+        <cnsl-label>{{ 'IDP.IDATTRIBUTE' | translate }}</cnsl-label>
+        <input cnslInput formControlName="idAttribute" />
+      </cnsl-form-field>
+
+      <div class="oauth-content">
+        <cnsl-form-field class="formfield">
+          <cnsl-label>{{ 'IDP.CLIENTID' | translate }}</cnsl-label>
+          <input cnslInput formControlName="clientId" />
+        </cnsl-form-field>
+
+        <mat-checkbox *ngIf="provider" [(ngModel)]="updateClientSecret" [ngModelOptions]="{ standalone: true }">{{
+          'IDP.UPDATECLIENTSECRET' | translate
+        }}</mat-checkbox>
+        <cnsl-form-field *ngIf="!provider || (provider && updateClientSecret)" class="formfield">
+          <cnsl-label>{{ 'IDP.CLIENTSECRET' | translate }}</cnsl-label>
+          <input cnslInput formControlName="clientSecret" />
+        </cnsl-form-field>
+
+        <div class="optional-h-wrapper">
+          <h2>{{ 'IDP.OPTIONAL' | translate }}</h2>
+          <button (click)="showOptional = !showOptional" type="button" mat-icon-button>
+            <mat-icon *ngIf="showOptional">keyboard_arrow_up</mat-icon
+            ><mat-icon *ngIf="!showOptional">keyboard_arrow_down</mat-icon>
+          </button>
+        </div>
+        <div *ngIf="showOptional">
+          <div class="idp-scopes">
+            <div class="flex-line">
+              <cnsl-form-field class="formfield">
+                <cnsl-label>{{ 'IDP.SCOPESLIST' | translate }}</cnsl-label>
+
+                <input
+                  cnslInput
+                  [matChipInputFor]="chipScopesList"
+                  [matChipInputSeparatorKeyCodes]="separatorKeysCodes"
+                  [matChipInputAddOnBlur]="true"
+                  (matChipInputTokenEnd)="addScope($event)"
+                />
+              </cnsl-form-field>
+              <button class="scope-add-button" (click)="addScope($any($event))" mat-icon-button>
+                <mat-icon>add</mat-icon>
+              </button>
+            </div>
+
+            <cnsl-form-field class="formfield">
+              <mat-chip-list #chipScopesList aria-label="scope selection">
+                <mat-chip
+                  class="chip"
+                  *ngFor="let scope of scopesList?.value"
+                  selectable="false"
+                  removable
+                  (removed)="removeScope(scope)"
+                >
+                  {{ scope }} <mat-icon matChipRemove>cancel</mat-icon>
+                </mat-chip>
+              </mat-chip-list>
+            </cnsl-form-field>
+          </div>
+
+          <cnsl-provider-options
+            [initialOptions]="provider?.config?.options"
+            (optionsChanged)="options = $event"
+          ></cnsl-provider-options>
+        </div>
+      </div>
+
+      <div class="oauth-create-actions">
+        <button color="primary" mat-raised-button class="continue-button" [disabled]="form.invalid" type="submit">
+          <span *ngIf="id">{{ 'ACTIONS.SAVE' | translate }}</span>
+          <span *ngIf="!id">{{ 'ACTIONS.CREATE' | translate }}</span>
+        </button>
+      </div>
+    </form>
+  </div>
+</cnsl-create-layout>

console/src/app/modules/providers/provider-oauth/provider-oauth.component.scss

@@ -0,0 +1,84 @@
+.desc {
+  font-size: 14px;
+}
+
+.oauth-create-content {
+  .title-row {
+    display: flex;
+    align-items: center;
+
+    .idp-logo {
+      height: 36px;
+      width: 36px;
+      margin-right: 1rem;
+      flex-shrink: 0;
+    }
+
+    h1 {
+      margin: 0 1rem 0 0;
+    }
+  }
+
+  .formfield {
+    display: block;
+    max-width: 400px;
+
+    .mat-chip-input {
+      width: 100%;
+      margin: 0;
+    }
+
+    .chip {
+      border-radius: 0.5rem;
+      height: 40px;
+    }
+
+    @media only screen and (max-width: 450px) {
+      max-width: none;
+    }
+  }
+
+  .oauth-content {
+    .desc {
+      margin-bottom: 1rem;
+    }
+
+    .idp-scopes {
+      padding-bottom: 0.5rem;
+
+      .flex-line {
+        display: flex;
+        align-items: flex-start;
+        max-width: 400px;
+
+        .formfield {
+          flex: 1;
+        }
+
+        .scope-add-button {
+          margin-top: 1.75rem;
+        }
+      }
+    }
+  }
+}
+
+.oauth-create-actions {
+  display: flex;
+  margin-top: 1rem;
+
+  button[mat-raised-button] {
+    border-radius: 0.5rem;
+    margin-right: 1rem;
+    padding: 0.5rem 4rem;
+  }
+}
+
+.optional-h-wrapper {
+  display: flex;
+  align-items: center;
+
+  h2 {
+    margin-right: 0.25rem;
+  }
+}

console/src/app/modules/providers/provider-oauth/provider-oauth.component.spec.ts

@@ -0,0 +1,24 @@
+import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
+
+import { ProviderOAuthComponent } from './provider-oauth.component';
+
+describe('ProviderOAuthComponent', () => {
+  let component: ProviderOAuthComponent;
+  let fixture: ComponentFixture<ProviderOAuthComponent>;
+
+  beforeEach(waitForAsync(() => {
+    TestBed.configureTestingModule({
+      declarations: [ProviderOAuthComponent],
+    }).compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(ProviderOAuthComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

console/src/app/modules/providers/provider-oauth/provider-oauth.component.ts

@@ -0,0 +1,298 @@
+import { COMMA, ENTER, SPACE } from '@angular/cdk/keycodes';
+import { Location } from '@angular/common';
+import { Component, Injector, Type } from '@angular/core';
+import { AbstractControl, UntypedFormControl, UntypedFormGroup, Validators } from '@angular/forms';
+import { MatLegacyChipInputEvent as MatChipInputEvent } from '@angular/material/legacy-chips';
+import { ActivatedRoute, Router } from '@angular/router';
+import { take } from 'rxjs';
+import {
+  AddGenericOAuthProviderRequest as AdminAddGenericOAuthProviderRequest,
+  GetProviderByIDRequest as AdminGetProviderByIDRequest,
+  UpdateGenericOAuthProviderRequest as AdminUpdateGenericOAuthProviderRequest,
+} from 'src/app/proto/generated/zitadel/admin_pb';
+import { Options, Provider } from 'src/app/proto/generated/zitadel/idp_pb';
+import {
+  AddGenericOAuthProviderRequest as MgmtAddGenericOAuthProviderRequest,
+  GetProviderByIDRequest as MgmtGetProviderByIDRequest,
+  UpdateGenericOAuthProviderRequest as MgmtUpdateGenericOAuthProviderRequest,
+} from 'src/app/proto/generated/zitadel/management_pb';
+import { AdminService } from 'src/app/services/admin.service';
+import { Breadcrumb, BreadcrumbService, BreadcrumbType } from 'src/app/services/breadcrumb.service';
+import { ManagementService } from 'src/app/services/mgmt.service';
+import { ToastService } from 'src/app/services/toast.service';
+
+import { PolicyComponentServiceType } from '../../policies/policy-component-types.enum';
+
+@Component({
+  selector: 'cnsl-provider-oauth',
+  templateUrl: './provider-oauth.component.html',
+  styleUrls: ['./provider-oauth.component.scss'],
+})
+export class ProviderOAuthComponent {
+  public showOptional: boolean = false;
+  public options: Options = new Options();
+
+  public id: string | null = '';
+  public updateClientSecret: boolean = false;
+  public serviceType: PolicyComponentServiceType = PolicyComponentServiceType.MGMT;
+  private service!: ManagementService | AdminService;
+  public readonly separatorKeysCodes: number[] = [ENTER, COMMA, SPACE];
+  public form!: UntypedFormGroup;
+
+  public loading: boolean = false;
+
+  public provider?: Provider.AsObject;
+
+  constructor(
+    private router: Router,
+    private route: ActivatedRoute,
+    private toast: ToastService,
+    private injector: Injector,
+    private _location: Location,
+    breadcrumbService: BreadcrumbService,
+  ) {
+    this.form = new UntypedFormGroup({
+      name: new UntypedFormControl('', [Validators.required]),
+      clientId: new UntypedFormControl('', [Validators.required]),
+      clientSecret: new UntypedFormControl('', [Validators.required]),
+      authorizationEndpoint: new UntypedFormControl('', [Validators.required]),
+      tokenEndpoint: new UntypedFormControl('', [Validators.required]),
+      userEndpoint: new UntypedFormControl('', [Validators.required]),
+      idAttribute: new UntypedFormControl('', [Validators.required]),
+      scopesList: new UntypedFormControl(['openid', 'profile', 'email'], []),
+    });
+
+    this.route.data.pipe(take(1)).subscribe((data) => {
+      this.serviceType = data.serviceType;
+
+      switch (this.serviceType) {
+        case PolicyComponentServiceType.MGMT:
+          this.service = this.injector.get(ManagementService as Type<ManagementService>);
+
+          const bread: Breadcrumb = {
+            type: BreadcrumbType.ORG,
+            routerLink: ['/org'],
+          };
+
+          breadcrumbService.setBreadcrumb([bread]);
+          break;
+        case PolicyComponentServiceType.ADMIN:
+          this.service = this.injector.get(AdminService as Type<AdminService>);
+
+          const iamBread = new Breadcrumb({
+            type: BreadcrumbType.ORG,
+            name: 'Instance',
+            routerLink: ['/instance'],
+          });
+          breadcrumbService.setBreadcrumb([iamBread]);
+          break;
+      }
+
+      this.id = this.route.snapshot.paramMap.get('id');
+      if (this.id) {
+        this.clientSecret?.setValidators([]);
+        this.getData(this.id);
+      }
+    });
+  }
+
+  private getData(id: string): void {
+    this.loading = true;
+    const req =
+      this.serviceType === PolicyComponentServiceType.ADMIN
+        ? new AdminGetProviderByIDRequest()
+        : new MgmtGetProviderByIDRequest();
+    req.setId(id);
+    this.service
+      .getProviderByID(req)
+      .then((resp) => {
+        this.provider = resp.idp;
+        this.loading = false;
+        if (this.provider?.config?.oauth) {
+          this.form.patchValue(this.provider.config.oauth);
+          this.name?.setValue(this.provider.name);
+        }
+      })
+      .catch((error) => {
+        this.toast.showError(error);
+        this.loading = false;
+      });
+  }
+
+  public submitForm(): void {
+    this.provider ? this.updateGenericOAuthProvider() : this.addGenericOAuthProvider();
+  }
+
+  public addGenericOAuthProvider(): void {
+    if (this.serviceType === PolicyComponentServiceType.MGMT) {
+      const req = new MgmtAddGenericOAuthProviderRequest();
+
+      req.setName(this.name?.value);
+      req.setAuthorizationEndpoint(this.authorizationEndpoint?.value);
+      req.setIdAttribute(this.idAttribute?.value);
+      req.setTokenEndpoint(this.tokenEndpoint?.value);
+      req.setUserEndpoint(this.userEndpoint?.value);
+      req.setClientId(this.clientId?.value);
+      req.setClientSecret(this.clientSecret?.value);
+      req.setScopesList(this.scopesList?.value);
+
+      this.loading = true;
+      (this.service as ManagementService)
+        .addGenericOAuthProvider(req)
+        .then((idp) => {
+          setTimeout(() => {
+            this.loading = false;
+            this.router.navigate(['/org-settings'], { queryParams: { id: 'idp' } });
+          }, 2000);
+        })
+        .catch((error) => {
+          this.toast.showError(error);
+          this.loading = false;
+        });
+    } else if (PolicyComponentServiceType.ADMIN) {
+      const req = new AdminAddGenericOAuthProviderRequest();
+      req.setName(this.name?.value);
+      req.setAuthorizationEndpoint(this.authorizationEndpoint?.value);
+      req.setIdAttribute(this.idAttribute?.value);
+      req.setTokenEndpoint(this.tokenEndpoint?.value);
+      req.setUserEndpoint(this.userEndpoint?.value);
+      req.setClientId(this.clientId?.value);
+      req.setClientSecret(this.clientSecret?.value);
+      req.setScopesList(this.scopesList?.value);
+
+      this.loading = true;
+      (this.service as AdminService)
+        .addGenericOAuthProvider(req)
+        .then((idp) => {
+          setTimeout(() => {
+            this.loading = false;
+            this.router.navigate(['/settings'], { queryParams: { id: 'idp' } });
+          }, 2000);
+        })
+        .catch((error) => {
+          this.toast.showError(error);
+          this.loading = false;
+        });
+    }
+  }
+
+  public updateGenericOAuthProvider(): void {
+    if (this.provider) {
+      if (this.serviceType === PolicyComponentServiceType.MGMT) {
+        const req = new MgmtUpdateGenericOAuthProviderRequest();
+        req.setId(this.provider.id);
+        req.setName(this.name?.value);
+        req.setAuthorizationEndpoint(this.authorizationEndpoint?.value);
+        req.setIdAttribute(this.idAttribute?.value);
+        req.setTokenEndpoint(this.tokenEndpoint?.value);
+        req.setUserEndpoint(this.userEndpoint?.value);
+        req.setClientId(this.clientId?.value);
+        req.setClientSecret(this.clientSecret?.value);
+        req.setScopesList(this.scopesList?.value);
+
+        this.loading = true;
+        (this.service as ManagementService)
+          .updateGenericOAuthProvider(req)
+          .then((idp) => {
+            setTimeout(() => {
+              this.loading = false;
+              this.router.navigate(['/org-settings'], { queryParams: { id: 'idp' } });
+            }, 2000);
+          })
+          .catch((error) => {
+            this.toast.showError(error);
+            this.loading = false;
+          });
+      } else if (PolicyComponentServiceType.ADMIN) {
+        const req = new AdminUpdateGenericOAuthProviderRequest();
+        req.setId(this.provider.id);
+        req.setName(this.name?.value);
+        req.setAuthorizationEndpoint(this.authorizationEndpoint?.value);
+        req.setIdAttribute(this.idAttribute?.value);
+        req.setTokenEndpoint(this.tokenEndpoint?.value);
+        req.setUserEndpoint(this.userEndpoint?.value);
+        req.setClientId(this.clientId?.value);
+        req.setClientSecret(this.clientSecret?.value);
+        req.setScopesList(this.scopesList?.value);
+
+        this.loading = true;
+        (this.service as AdminService)
+          .updateGenericOAuthProvider(req)
+          .then((idp) => {
+            setTimeout(() => {
+              this.loading = false;
+              this.router.navigate(['/settings'], { queryParams: { id: 'idp' } });
+            }, 2000);
+          })
+          .catch((error) => {
+            this.toast.showError(error);
+            this.loading = false;
+          });
+      }
+    }
+  }
+
+  public close(): void {
+    this._location.back();
+  }
+
+  public addScope(event: MatChipInputEvent): void {
+    const input = event.chipInput?.inputElement;
+    const value = event.value.trim();
+
+    if (value !== '') {
+      if (this.scopesList?.value) {
+        this.scopesList.value.push(value);
+        if (input) {
+          input.value = '';
+        }
+      }
+    }
+  }
+
+  public removeScope(uri: string): void {
+    if (this.scopesList?.value) {
+      const index = this.scopesList.value.indexOf(uri);
+
+      if (index !== undefined && index >= 0) {
+        this.scopesList.value.splice(index, 1);
+      }
+    }
+  }
+
+  public get name(): AbstractControl | null {
+    return this.form.get('name');
+  }
+
+  public get authorizationEndpoint(): AbstractControl | null {
+    return this.form.get('authorizationEndpoint');
+  }
+
+  public get tokenEndpoint(): AbstractControl | null {
+    return this.form.get('tokenEndpoint');
+  }
+
+  public get userEndpoint(): AbstractControl | null {
+    return this.form.get('userEndpoint');
+  }
+
+  public get idAttribute(): AbstractControl | null {
+    return this.form.get('idAttribute');
+  }
+
+  public get clientId(): AbstractControl | null {
+    return this.form.get('clientId');
+  }
+
+  public get clientSecret(): AbstractControl | null {
+    return this.form.get('clientSecret');
+  }
+
+  public get issuer(): AbstractControl | null {
+    return this.form.get('issuer');
+  }
+
+  public get scopesList(): AbstractControl | null {
+    return this.form.get('scopesList');
+  }
+}

console/src/app/modules/providers/provider-oauth/provider-oauth.module.ts

@@ -0,0 +1,43 @@
+import { CommonModule } from '@angular/common';
+import { NgModule } from '@angular/core';
+import { FormsModule, ReactiveFormsModule } from '@angular/forms';
+import { MatIconModule } from '@angular/material/icon';
+import { MatLegacyButtonModule as MatButtonModule } from '@angular/material/legacy-button';
+import { MatLegacyCheckboxModule as MatCheckboxModule } from '@angular/material/legacy-checkbox';
+import { MatLegacyChipsModule as MatChipsModule } from '@angular/material/legacy-chips';
+import { MatLegacyProgressSpinnerModule } from '@angular/material/legacy-progress-spinner';
+import { MatLegacySelectModule as MatSelectModule } from '@angular/material/legacy-select';
+import { MatLegacyTooltipModule as MatTooltipModule } from '@angular/material/legacy-tooltip';
+import { TranslateModule } from '@ngx-translate/core';
+import { InputModule } from 'src/app/modules/input/input.module';
+
+import { CardModule } from '../../card/card.module';
+import { CreateLayoutModule } from '../../create-layout/create-layout.module';
+import { InfoSectionModule } from '../../info-section/info-section.module';
+import { ProviderOptionsModule } from '../../provider-options/provider-options.module';
+import { ProviderOAuthRoutingModule } from './provider-oauth-routing.module';
+import { ProviderOAuthComponent } from './provider-oauth.component';
+
+@NgModule({
+  declarations: [ProviderOAuthComponent],
+  imports: [
+    ProviderOAuthRoutingModule,
+    CommonModule,
+    FormsModule,
+    ReactiveFormsModule,
+    CreateLayoutModule,
+    InfoSectionModule,
+    InputModule,
+    MatButtonModule,
+    MatSelectModule,
+    MatIconModule,
+    MatChipsModule,
+    CardModule,
+    MatCheckboxModule,
+    MatTooltipModule,
+    TranslateModule,
+    ProviderOptionsModule,
+    MatLegacyProgressSpinnerModule,
+  ],
+})
+export default class ProviderOAuthModule {}