Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2025-02-22 06:41:36 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8407 from jwangyangls/oidc-ping

Browse Source 
Add test button in configration width oidc mode
This commit is contained in:
jwangyangls 2019-07-26 14:30:29 +08:00 committed by GitHub
commit 993643bb78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 98 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/portal/lib/src/shared/shared.const.ts
View File

@ -93,7 +93,9 @@ export const LabelColor = [
export const CONFIG_AUTH_MODE = { export const CONFIG_AUTH_MODE = {
HTTP_AUTH: "http_auth", HTTP_AUTH: "http_auth",
LDAP_AUTH: "ldap_auth" LDAP_AUTH: "ldap_auth",
OIDC_AUTH: "oidc_auth",
UAA_AUTH: "uaa_auth"
}; };
export const PROJECT_ROOTS = [ export const PROJECT_ROOTS = [
{ {

6
src/portal/src/app/config/auth/config-auth.component.html
View File

@ -423,7 +423,7 @@
[disabled]="!isValid() || !hasChanges()">{{'BUTTON.SAVE' | translate}}</button> [disabled]="!isValid() || !hasChanges()">{{'BUTTON.SAVE' | translate}}</button>
<button type="button" class="btn btn-outline" (click)="cancel()" <button type="button" class="btn btn-outline" (click)="cancel()"
[disabled]="!isValid() || !hasChanges()">{{'BUTTON.CANCEL' | translate}}</button> [disabled]="!isValid() || !hasChanges()">{{'BUTTON.CANCEL' | translate}}</button>
<button type="button" class="btn btn-outline" (click)="testLDAPServer()" *ngIf="showLdapServerBtn" <button type="button" class="btn btn-outline" (click)="pingTestServer()" *ngIf="showTestingServerBtn"
[disabled]="!isLDAPConfigValid()">{{'BUTTON.TEST_LDAP' | translate}}</button> [disabled]="!isConfigValidForTesting()">{{(showLdap?'BUTTON.TEST_LDAP':'BUTTON.TEST_OIDC') | translate}}</button>
<span id="forTestingLDAP" class="spinner spinner-inline" [hidden]="hideLDAPTestingSpinner"></span> <span id="forTestingLDAP" class="spinner spinner-inline" [hidden]="hideTestingSpinner"></span>
</div> </div>

118
src/portal/src/app/config/auth/config-auth.component.ts
View File

@ -15,7 +15,8 @@ import { Component, Input, ViewChild, SimpleChanges, OnChanges, OnInit, Output,
import { NgForm } from '@angular/forms'; import { NgForm } from '@angular/forms';
import { Subscription } from "rxjs"; import { Subscription } from "rxjs";
import { Configuration, clone, isEmpty, getChanges, StringValueItem, BoolValueItem, SystemInfoService, ErrorHandler } from '@harbor/ui'; import { Configuration, clone, isEmpty, getChanges, StringValueItem, BoolValueItem, SystemInfoService, ErrorHandler
, CONFIG_AUTH_MODE } from '@harbor/ui';
import { MessageHandlerService } from '../../shared/message-handler/message-handler.service'; import { MessageHandlerService } from '../../shared/message-handler/message-handler.service';
import { ConfirmMessageHandler } from '../config.msg.utils'; import { ConfirmMessageHandler } from '../config.msg.utils';
import { AppConfigService } from '../../app-config.service'; import { AppConfigService } from '../../app-config.service';
@ -30,7 +31,7 @@ const fakePass = 'aWpLOSYkIzJTTU4wMDkx';
}) })
export class ConfigurationAuthComponent implements OnChanges, OnInit { export class ConfigurationAuthComponent implements OnChanges, OnInit {
changeSub: Subscription; changeSub: Subscription;
testingLDAPOnGoing = false; testingOnGoing = false;
onGoing = false; onGoing = false;
redirectUrl: string; redirectUrl: string;
// tslint:disable-next-line:no-input-rename // tslint:disable-next-line:no-input-rename
@ -72,24 +73,26 @@ export class ConfigurationAuthComponent implements OnChanges, OnInit {
public get showLdap(): boolean { public get showLdap(): boolean {
return this.currentConfig && return this.currentConfig &&
this.currentConfig.auth_mode && this.currentConfig.auth_mode &&
this.currentConfig.auth_mode.value === 'ldap_auth'; this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.LDAP_AUTH;
} }
public get showUAA(): boolean { public get showUAA(): boolean {
return this.currentConfig && this.currentConfig.auth_mode && this.currentConfig.auth_mode.value === 'uaa_auth'; return this.currentConfig && this.currentConfig.auth_mode && this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.UAA_AUTH;
} }
public get showOIDC(): boolean { public get showOIDC(): boolean {
return this.currentConfig && this.currentConfig.auth_mode && this.currentConfig.auth_mode.value === 'oidc_auth'; return this.currentConfig && this.currentConfig.auth_mode && this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.OIDC_AUTH;
} }
public get showHttpAuth(): boolean { public get showHttpAuth(): boolean {
return this.currentConfig && this.currentConfig.auth_mode && this.currentConfig.auth_mode.value === 'http_auth'; return this.currentConfig && this.currentConfig.auth_mode && this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.HTTP_AUTH;
} }
public get showSelfReg(): boolean { public get showSelfReg(): boolean {
if (!this.currentConfig || !this.currentConfig.auth_mode) { if (!this.currentConfig || !this.currentConfig.auth_mode) {
return true; return true;
} else { } else {
return this.currentConfig.auth_mode.value !== 'ldap_auth' && this.currentConfig.auth_mode.value !== 'uaa_auth' return this.currentConfig.auth_mode.value !== CONFIG_AUTH_MODE.LDAP_AUTH
&& this.currentConfig.auth_mode.value !== 'http_auth' && this.currentConfig.auth_mode.value !== 'oidc_auth'; && this.currentConfig.auth_mode.value !== CONFIG_AUTH_MODE.UAA_AUTH
&& this.currentConfig.auth_mode.value !== CONFIG_AUTH_MODE.HTTP_AUTH
&& this.currentConfig.auth_mode.value !== CONFIG_AUTH_MODE.OIDC_AUTH;
} }
} }
@ -105,52 +108,74 @@ export class ConfigurationAuthComponent implements OnChanges, OnInit {
this.currentConfig.ldap_verify_cert.value = $event; this.currentConfig.ldap_verify_cert.value = $event;
} }
public testLDAPServer(): void { public pingTestServer(): void {
if (this.testingLDAPOnGoing) { if (this.testingOnGoing) {
return; // Should not come here return; // Should not come here
} }
let ldapSettings = {}; let settings = {};
for (let prop in this.currentConfig) { if (this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.LDAP_AUTH) {
if (prop.startsWith('ldap_')) {
ldapSettings[prop] = this.currentConfig[prop].value;
}
}
let allChanges = this.getChanges(); for (let prop in this.currentConfig) {
let ldapSearchPwd = allChanges['ldap_search_password']; if (prop.startsWith('ldap_')) {
if (ldapSearchPwd) { settings[prop] = this.currentConfig[prop].value;
ldapSettings['ldap_search_password'] = ldapSearchPwd;
} else {
delete ldapSettings['ldap_search_password'];
}
// Fix: Confirm ldap scope is number
ldapSettings['ldap_scope'] = +ldapSettings['ldap_scope'];
this.testingLDAPOnGoing = true;
this.configService.testLDAPServer(ldapSettings)
.subscribe(respone => {
this.testingLDAPOnGoing = false;
this.msgHandler.showSuccess('CONFIG.TEST_LDAP_SUCCESS');
}, error => {
this.testingLDAPOnGoing = false;
let err = error.error;
if (!err || !err.trim()) {
err = 'UNKNOWN';
} }
this.msgHandler.showError('CONFIG.TEST_LDAP_FAILED', { 'param': err }); }
});
let allChanges = this.getChanges();
this.testingOnGoing = true;
// set password for ldap
let ldapSearchPwd = allChanges['ldap_search_password'];
if (ldapSearchPwd) {
settings['ldap_search_password'] = ldapSearchPwd;
} else {
delete settings['ldap_search_password'];
}
// Fix: Confirm ldap scope is number
settings['ldap_scope'] = +settings['ldap_scope'];
this.configService.testLDAPServer(settings)
.subscribe(respone => {
this.testingOnGoing = false;
this.msgHandler.showSuccess('CONFIG.TEST_LDAP_SUCCESS');
}, error => {
this.testingOnGoing = false;
let err = error.error;
if (!err || !err.trim()) {
err = 'UNKNOWN';
}
this.msgHandler.showError('CONFIG.TEST_LDAP_FAILED', { 'param': err });
});
} else {
for (let prop in this.currentConfig) {
if (prop === 'oidc_endpoint') {
settings['url'] = this.currentConfig[prop].value;
} else if (prop === 'oidc_verify_cert') {
settings['verify_cert'] = this.currentConfig[prop].value;
}
}
this.configService.testOIDCServer(settings)
.subscribe(respone => {
this.testingOnGoing = false;
this.msgHandler.showSuccess('CONFIG.TEST_OIDC_SUCCESS');
}, error => {
this.testingOnGoing = false;
this.errorHandler.error(error);
});
}
} }
public get showLdapServerBtn(): boolean { public get showTestingServerBtn(): boolean {
return this.currentConfig.auth_mode && return this.currentConfig.auth_mode &&
this.currentConfig.auth_mode.value === 'ldap_auth'; (this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.LDAP_AUTH
|| this.currentConfig.auth_mode.value === CONFIG_AUTH_MODE.OIDC_AUTH);
} }
public isLDAPConfigValid(): boolean { public isConfigValidForTesting(): boolean {
return this.isValid() && return this.isValid() &&
!this.testingLDAPOnGoing; !this.testingOnGoing;
} }
public getChanges() { public getChanges() {
@ -171,8 +196,8 @@ export class ConfigurationAuthComponent implements OnChanges, OnInit {
return changes; return changes;
} }
public get hideLDAPTestingSpinner(): boolean { public get hideTestingSpinner(): boolean {
return !this.testingLDAPOnGoing || !this.showLdapServerBtn; return !this.testingOnGoing || !this.showTestingServerBtn;
} }
disabled(prop: any): boolean { disabled(prop: any): boolean {
@ -182,7 +207,8 @@ export class ConfigurationAuthComponent implements OnChanges, OnInit {
handleOnChange($event: any): void { handleOnChange($event: any): void {
if ($event && $event.target && $event.target["value"]) { if ($event && $event.target && $event.target["value"]) {
let authMode = $event.target["value"]; let authMode = $event.target["value"];
if (authMode === 'ldap_auth' || authMode === 'uaa_auth' || authMode === 'http_auth' || authMode === 'oidc_auth') { if (authMode === CONFIG_AUTH_MODE.LDAP_AUTH || authMode === CONFIG_AUTH_MODE.UAA_AUTH || authMode === CONFIG_AUTH_MODE.HTTP_AUTH
|| authMode === CONFIG_AUTH_MODE.OIDC_AUTH) {
if (this.currentConfig.self_registration.value) { if (this.currentConfig.self_registration.value) {
this.currentConfig.self_registration.value = false; // unselect this.currentConfig.self_registration.value = false; // unselect
} }

5
src/portal/src/app/config/config.service.ts
View File

@ -22,6 +22,7 @@ import { Configuration, HTTP_GET_OPTIONS, HTTP_JSON_OPTIONS } from '@harbor/ui';
const configEndpoint = "/api/configurations"; const configEndpoint = "/api/configurations";
const emailEndpoint = "/api/email/ping"; const emailEndpoint = "/api/email/ping";
const ldapEndpoint = "/api/ldap/ping"; const ldapEndpoint = "/api/ldap/ping";
const oidcEndpoint = "/api/system/oidc/ping";
@Injectable() @Injectable()
export class ConfigurationService { export class ConfigurationService {
@ -51,4 +52,8 @@ export class ConfigurationService {
.pipe(map(response => response) .pipe(map(response => response)
, catchError(error => observableThrowError(error))); , catchError(error => observableThrowError(error)));
} }
public testOIDCServer(oidcSettings: any): Observable<any> {
return this.http.post(oidcEndpoint, JSON.stringify(oidcSettings), HTTP_JSON_OPTIONS)
.pipe(catchError(error => observableThrowError(error)));
}
} }

4
src/portal/src/i18n/lang/en-us-lang.json
View File

@ -31,6 +31,7 @@
"TEST_MAIL": "TEST MAIL SERVER", "TEST_MAIL": "TEST MAIL SERVER",
"CLOSE": "CLOSE", "CLOSE": "CLOSE",
"TEST_LDAP": "TEST LDAP SERVER", "TEST_LDAP": "TEST LDAP SERVER",
"TEST_OIDC": "TEST OIDC SERVER",
"MORE_INFO": "More info...", "MORE_INFO": "More info...",
"YES": "YES", "YES": "YES",
"NO": "NO", "NO": "NO",
@ -813,7 +814,8 @@
"TEST_MAIL_FAILED": "Failed to verify mail server with error: {{param}}.", "TEST_MAIL_FAILED": "Failed to verify mail server with error: {{param}}.",
"TEST_LDAP_FAILED": "Failed to verify LDAP server with error: {{param}}.", "TEST_LDAP_FAILED": "Failed to verify LDAP server with error: {{param}}.",
"LEAVING_CONFIRMATION_TITLE": "Confirm to leave", "LEAVING_CONFIRMATION_TITLE": "Confirm to leave",
"LEAVING_CONFIRMATION_SUMMARY": "Changes have not been saved yet. Do you want to leave current page?" "LEAVING_CONFIRMATION_SUMMARY": "Changes have not been saved yet. Do you want to leave current page?",
"TEST_OIDC_SUCCESS": "Connection to OIDC server is verified."
}, },
"PAGE_NOT_FOUND": { "PAGE_NOT_FOUND": {
"MAIN_TITLE": "Page not found", "MAIN_TITLE": "Page not found",

4
src/portal/src/i18n/lang/es-es-lang.json
View File

@ -31,6 +31,7 @@
"TEST_MAIL": "COMPROBAR SERVIDOR DE CORREO", "TEST_MAIL": "COMPROBAR SERVIDOR DE CORREO",
"CLOSE": "CERRAR", "CLOSE": "CERRAR",
"TEST_LDAP": "COMPROBAR SERVIDOR LDAP", "TEST_LDAP": "COMPROBAR SERVIDOR LDAP",
"TEST_OIDC": "TEST OIDC SERVER",
"MORE_INFO": "Más información...", "MORE_INFO": "Más información...",
"YES": "SI", "YES": "SI",
"NO": "NO", "NO": "NO",
@ -813,7 +814,8 @@
"TEST_MAIL_FAILED": "Fallo al verificar el servidor de correo con el error: {{param}}.", "TEST_MAIL_FAILED": "Fallo al verificar el servidor de correo con el error: {{param}}.",
"TEST_LDAP_FAILED": "Fallo al verificar el servidor LDAP con el error: {{param}}.", "TEST_LDAP_FAILED": "Fallo al verificar el servidor LDAP con el error: {{param}}.",
"LEAVING_CONFIRMATION_TITLE": "Confirme la salida", "LEAVING_CONFIRMATION_TITLE": "Confirme la salida",
"LEAVING_CONFIRMATION_SUMMARY": "Los cambios no han sido guardados aún. ¿Quiere abandonar la página actual?" "LEAVING_CONFIRMATION_SUMMARY": "Los cambios no han sido guardados aún. ¿Quiere abandonar la página actual?",
"TEST_OIDC_SUCCESS": "Connection to OIDC server is verified."
}, },
"PAGE_NOT_FOUND": { "PAGE_NOT_FOUND": {
"MAIN_TITLE": "Página no encontrada", "MAIN_TITLE": "Página no encontrada",

4
src/portal/src/i18n/lang/fr-fr-lang.json
View File

@ -31,6 +31,7 @@
"TEST_MAIL": "TESTER LE SERVEUR MAIL", "TEST_MAIL": "TESTER LE SERVEUR MAIL",
"CLOSE": "FERMER", "CLOSE": "FERMER",
"TEST_LDAP": "TESTER LE SERVEUR LDAP", "TEST_LDAP": "TESTER LE SERVEUR LDAP",
"TEST_OIDC": "TEST OIDC SERVER",
"MORE_INFO": "Plus d'informations...", "MORE_INFO": "Plus d'informations...",
"YES": "OUI", "YES": "OUI",
"NO": "NON", "NO": "NON",
@ -787,7 +788,8 @@
"TEST_MAIL_FAILED": "Echec de la vérification du serveur de mail avec erreurs : {{param}}.", "TEST_MAIL_FAILED": "Echec de la vérification du serveur de mail avec erreurs : {{param}}.",
"TEST_LDAP_FAILED": "Echec de la vérification du serveur LDAP avec erreurs : {{param}}.", "TEST_LDAP_FAILED": "Echec de la vérification du serveur LDAP avec erreurs : {{param}}.",
"LEAVING_CONFIRMATION_TITLE": "Confirmer pour quitter", "LEAVING_CONFIRMATION_TITLE": "Confirmer pour quitter",
"LEAVING_CONFIRMATION_SUMMARY": "Les modifications n'ont pas encore été enregistrées. Voulez-vous quitter la page actuelle ?" "LEAVING_CONFIRMATION_SUMMARY": "Les modifications n'ont pas encore été enregistrées. Voulez-vous quitter la page actuelle ?",
"TEST_OIDC_SUCCESS": "Connection to OIDC server is verified."
}, },
"PAGE_NOT_FOUND": { "PAGE_NOT_FOUND": {
"MAIN_TITLE": "Page introuvable", "MAIN_TITLE": "Page introuvable",

4
src/portal/src/i18n/lang/pt-br-lang.json
View File

@ -31,6 +31,7 @@
"TEST_MAIL": "TESTAR SERVIDOR DE EMAIL", "TEST_MAIL": "TESTAR SERVIDOR DE EMAIL",
"CLOSE": "FECHAR", "CLOSE": "FECHAR",
"TEST_LDAP": "TESTAR SERVIDOR DE LDAP", "TEST_LDAP": "TESTAR SERVIDOR DE LDAP",
"TEST_OIDC": "TEST OIDC SERVER",
"MORE_INFO": "Mais informações...", "MORE_INFO": "Mais informações...",
"YES": "SIM", "YES": "SIM",
"NO": "NÃO", "NO": "NÃO",
@ -807,7 +808,8 @@
"TEST_MAIL_FAILED": "Falha ao verificar servidor de Email com erro: {{param}}.", "TEST_MAIL_FAILED": "Falha ao verificar servidor de Email com erro: {{param}}.",
"TEST_LDAP_FAILED": "Falha ao verificar servidor de LDAP com erro: {{param}}.", "TEST_LDAP_FAILED": "Falha ao verificar servidor de LDAP com erro: {{param}}.",
"LEAVING_CONFIRMATION_TITLE": "Confirme para sair", "LEAVING_CONFIRMATION_TITLE": "Confirme para sair",
"LEAVING_CONFIRMATION_SUMMARY": "As alterações ainda não foram salvas. Você deseja sair da página atual?" "LEAVING_CONFIRMATION_SUMMARY": "As alterações ainda não foram salvas. Você deseja sair da página atual?",
"TEST_OIDC_SUCCESS": "Connection to OIDC server is verified."
}, },
"PAGE_NOT_FOUND": { "PAGE_NOT_FOUND": {
"MAIN_TITLE": "Página não encontrada", "MAIN_TITLE": "Página não encontrada",

4
src/portal/src/i18n/lang/zh-cn-lang.json
View File

@ -31,6 +31,7 @@
"TEST_MAIL": "测试邮件服务器", "TEST_MAIL": "测试邮件服务器",
"CLOSE": "关闭", "CLOSE": "关闭",
"TEST_LDAP": "测试LDAP服务器", "TEST_LDAP": "测试LDAP服务器",
"TEST_OIDC": "测试OIDC服务器",
"MORE_INFO": "更多信息...", "MORE_INFO": "更多信息...",
"YES": "是", "YES": "是",
"NO": "否", "NO": "否",
@ -812,7 +813,8 @@
"TEST_MAIL_FAILED": "验证邮件服务器失败，错误: {{param}}。", "TEST_MAIL_FAILED": "验证邮件服务器失败，错误: {{param}}。",
"TEST_LDAP_FAILED": "验证LDAP服务器失败，错误: {{param}}。", "TEST_LDAP_FAILED": "验证LDAP服务器失败，错误: {{param}}。",
"LEAVING_CONFIRMATION_TITLE": "确定离开", "LEAVING_CONFIRMATION_TITLE": "确定离开",
"LEAVING_CONFIRMATION_SUMMARY": "有未保存的配置更改, 确认离开当前页面?" "LEAVING_CONFIRMATION_SUMMARY": "有未保存的配置更改, 确认离开当前页面?",
"TEST_OIDC_SUCCESS": "OIDC服务器的连通正常。"
}, },
"PAGE_NOT_FOUND": { "PAGE_NOT_FOUND": {
"MAIN_TITLE": "页面不存在", "MAIN_TITLE": "页面不存在",