Skip to content

feat: Angular OAuth2 login page #1923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions ui/src/app/app.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,23 @@ <h3 class="welcome">{{ 'appRoot.welcomeTo' | translate }}</h3>
{{ 'appRoot.appTitle' | translate }}
<h5 class="hint">{{ 'appRoot.youHaveToLogin' | translate }}</h5>
</section>
<div style="padding-bottom: 50px">
<a href="{{ baseApiUrl }}login" class="btn btn-primary"> Log In </a>
</div>
<div *ngIf="isOAuth2; then oauth2; else standard"></div>
</form>
</div>

<ng-template #standard>
<div style="padding-bottom: 50px">
<a href="{{ baseApiUrl }}login" class="btn btn-primary"> Log In </a>
</div>
</ng-template>
<ng-template #oauth2>
<div *ngFor="let item of clientRegistrations | async">
<div style="padding-bottom: 50px">
<a href="{{ baseApiUrl }}oauth2/authorization/{{ item }}" class="btn btn-primary">{{ item }}</a>
</div>
</div>
</ng-template>

<ng-template #main>
<clr-main-container>
<clr-header class="header header-7">
Expand Down
2 changes: 2 additions & 0 deletions ui/src/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import {UrlUtilities} from './url-utilities.service';
export class AppComponent {
shouldProtect = this.securityService.shouldProtect();
securityEnabled = this.securityService.securityEnabled();
isOAuth2 = this.securityService.isOAuth2();
clientRegistrations = this.securityService.clientRegistrations();
baseApiUrl = UrlUtilities.calculateBaseApiUrl();

constructor(
Expand Down
3 changes: 2 additions & 1 deletion ui/src/app/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ import {UrlUtilities} from './url-utilities.service';
security.authenticationEnabled,
security.authenticated,
security.username,
security.roles
security.roles,
security.clientRegistrations
);
if (security.authenticated || !security.authenticationEnabled) {
return aboutService.load().pipe(map(() => security));
Expand Down
2 changes: 1 addition & 1 deletion ui/src/app/security/service/security.service.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ describe('security/service/security.service.ts integration', () => {
});

it('should have proper state after loaded', () => {
service.loaded(false, true, 'fakeuser', ['role1']);
service.loaded(false, true, 'fakeuser', ['role1'], []);

let expected = cold('(a|)', {a: false});
expect(service.securityEnabled().pipe(take(1))).toBeObservable(expected);
Expand Down
39 changes: 32 additions & 7 deletions ui/src/app/security/service/security.service.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
import {Injectable} from '@angular/core';
import {HttpClient} from '@angular/common/http';
import {Store, select} from '@ngrx/store';
import {Store, select, props} from '@ngrx/store';
import {Observable} from 'rxjs';
import {catchError, mergeMap, take} from 'rxjs/operators';
import {HttpUtils} from '../../shared/support/http.utils';
import {ErrorUtils} from '../../shared/support/error.utils';
import {Security} from '../../shared/model/security.model';
import {State, getUsername, getRoles, getEnabled, getShouldProtect, getSecurity} from '../store/security.reducer';
import {
State,
getUsername,
getRoles,
getEnabled,
getShouldProtect,
getSecurity,
getClientRegistrations,
isOAuth2
} from '../store/security.reducer';
import {loaded, logout, unauthorised} from '../store/security.action';
import {UrlUtilities} from '../../url-utilities.service';

Expand Down Expand Up @@ -34,12 +43,19 @@ export class SecurityService {
return arr1.some(i => arr2.includes(i));
}

loaded(enabled: boolean, authenticated: boolean, username: string, roles: string[]): void {
this.store.dispatch(loaded({enabled, authenticated, username, roles}));
loaded(enabled: boolean, authenticated: boolean, username: string, roles: string[], clientRegistrations: string[]): void {
this.store.dispatch(loaded({enabled, authenticated, username, roles, clientRegistrations}));
}

unauthorised(): void {
this.store.dispatch(unauthorised());
this.store.dispatch(
unauthorised({
authenticated: false,
enabled: false,
username: '',
roles: [],
clientRegistrations: []
}));
}

securityEnabled(): Observable<boolean> {
Expand All @@ -50,6 +66,10 @@ export class SecurityService {
return this.store.pipe(select(getUsername));
}

clientRegistrations(): Observable<string[]> {
return this.store.pipe(select(getClientRegistrations));
}

roles(): Observable<string[]> {
return this.store.pipe(select(getRoles));
}
Expand All @@ -58,6 +78,10 @@ export class SecurityService {
return this.store.pipe(select(getShouldProtect));
}

isOAuth2(): Observable<boolean> {
return this.store.pipe(select(isOAuth2));
}

load(): Observable<any> {
const headers = HttpUtils.getDefaultHttpHeaders();
return this.http
Expand All @@ -73,8 +97,9 @@ export class SecurityService {
const headers = HttpUtils.getDefaultHttpHeaders();
return this.http.get(UrlUtilities.calculateBaseApiUrl() + 'logout', {headers: headers, responseType: 'text'}).pipe(
mergeMap(() => {
this.store.dispatch(logout());
return this.load();
const observable = this.load();
observable.pipe().subscribe(securityContext => this.store.dispatch(logout(securityContext)));
return observable;
}),
catchError(ErrorUtils.catchError)
);
Expand Down
12 changes: 9 additions & 3 deletions ui/src/app/security/store/security.action.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@ import {createAction, props} from '@ngrx/store';

export const loaded = createAction(
'[Security] Loaded',
props<{enabled: boolean; authenticated: boolean; username: string; roles: string[]}>()
props<{enabled: boolean; authenticated: boolean; username: string; roles: string[]; clientRegistrations: string[]}>()
);
export const logout = createAction(
'[Security] Logout',
props<{enabled: boolean; authenticated: boolean; username: string; roles: string[]; clientRegistrations: string[]}>()
);
export const unauthorised = createAction(
'[Security] Unauthorised',
props<{enabled: boolean; authenticated: boolean; username: string; roles: string[]; clientRegistrations: string[]}>()
);
export const logout = createAction('[Security] Logout');
export const unauthorised = createAction('[Security] Unauthorised');
11 changes: 9 additions & 2 deletions ui/src/app/security/store/security.effect.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@ describe('Security Effect', () => {
}));

it('Unauthorised should logout', () => {
actions$ = of(SecurityAction.unauthorised());
const expected = cold('(a|)', {a: SecurityAction.logout()});
const props = {
authenticated: false,
enabled: false,
username: '',
roles: [],
clientRegistrations: []
};
actions$ = of(SecurityAction.unauthorised(props));
const expected = cold('(a|)', {a: SecurityAction.logout(props)});
expect(effects.securityReset$).toBeObservable(expected);
expect(routerSpy.navigate).toHaveBeenCalledWith(['/']);
});
Expand Down
20 changes: 16 additions & 4 deletions ui/src/app/security/store/security.reducer.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,37 @@ describe('security/store/security.reducer.ts', () => {
enabled: false,
authenticated: true,
username: 'fakeuser',
roles: ['role1', 'role2']
roles: ['role1', 'role2'],
clientRegistrations: ['test_registration', 'test_registration2']
};
let newState = fromSecurity.reducer(
undefined,
SecurityActions.loaded({
enabled: false,
authenticated: true,
username: 'fakeuser',
roles: ['role1', 'role2']
roles: ['role1', 'role2'],
clientRegistrations: ['test_registration', 'test_registration2']
})
);
expect(newState).toEqual(expectedState);
expectedState = {
enabled: false,
authenticated: false,
username: undefined,
roles: []
roles: [],
clientRegistrations: ['test_registration', 'test_registration2']
};
newState = fromSecurity.reducer(newState, SecurityActions.logout());
newState = fromSecurity.reducer(
newState,
SecurityActions.logout({
enabled: false,
authenticated: false,
username: undefined,
roles: [],
clientRegistrations: ['test_registration', 'test_registration2']
})
);
expect(newState).toEqual(expectedState);
});
});
16 changes: 12 additions & 4 deletions ui/src/app/security/store/security.reducer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export interface SecurityState {
authenticated: boolean;
username: string;
roles: string[];
clientRegistrations?: string[];
}

export interface State extends fromRoot.State {
Expand All @@ -23,17 +24,22 @@ export const getAuthenticated = (state: State): boolean => state[securityFeature

export const getUsername = (state: State): string => state[securityFeatureKey].username;

export const getClientRegistrations = (state: State): string[] => state[securityFeatureKey].clientRegistrations;

export const getRoles = (state: State): string[] => state[securityFeatureKey].roles;

export const getShouldProtect = createSelector(getEnabled, getAuthenticated, (enabled, authenticated) =>
!enabled ? false : enabled && !authenticated
);

export const isOAuth2 = createSelector(getClientRegistrations, clientRegistrations => clientRegistrations.length > 0);

export const initialState: SecurityState = {
enabled: true,
authenticated: false,
username: undefined,
roles: []
roles: [],
clientRegistrations: []
};

export const reducer = createReducer(
Expand All @@ -42,12 +48,14 @@ export const reducer = createReducer(
enabled: props.enabled,
authenticated: props.authenticated,
username: props.username,
roles: props.roles
roles: props.roles,
clientRegistrations: props.clientRegistrations
})),
on(SecurityActions.logout, state => ({
on(SecurityActions.logout, (state, props) => ({
enabled: state.enabled,
authenticated: false,
username: undefined,
roles: []
roles: props.roles,
clientRegistrations: props.clientRegistrations
}))
);
1 change: 1 addition & 0 deletions ui/src/app/shared/model/security.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ export interface Security {
authenticated: boolean;
username: string;
roles: string[];
clientRegistrations: string[];
}
1 change: 1 addition & 0 deletions ui/src/app/tests/data/security.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ export const LOAD = {
authenticated: false,
username: null,
roles: [],
clientRegistrations: [],
_links: {self: {href: 'http://localhost:4200/security/info'}}
};