Fix eslint errors and update documentation

pull/2855/head
Aaron Dalton 6 months ago committed by Aaron Dalton
parent de79744530
commit cc2e59e633

@ -485,11 +485,14 @@ Auth can be configured on the service, bookmark, and widget level using the `all
- User3
```
Auth for groups can be set in the `groups` under `auth`.
Auth for groups can be set in the `groups` under `auth`. In general the `groups` tag follows the format of the `layout`
section. For example:
```yaml
auth:
groups:
My Service Group:
My Service Group:
allowGroups: ['Group1', 'Group2']
My Other Group:
allowGroups: ['Group1']
```

@ -7,7 +7,7 @@ export default async function handler(req, res) {
try {
if (checkAllowedGroup(provider.permissions(req), groups, group)) {
res.json({ group: group})
res.json({group})
} else {
res.status(401).json({message:"Group unathorized"})
}

@ -1,5 +1,5 @@
/* eslint-disable react/no-array-index-key */
import useSWR, { unstable_serialize, SWRConfig } from "swr";
import useSWR, { unstable_serialize as unstableSerialize, SWRConfig } from "swr";
import Head from "next/head";
import dynamic from "next/dynamic";
import classNames from "classnames";
@ -9,6 +9,7 @@ import { BiError } from "react-icons/bi";
import { serverSideTranslations } from "next-i18next/serverSideTranslations";
import { useRouter } from "next/router";
import NullAuthProvider from "utils/auth/null";
import Tab, { slugify } from "components/tab";
import FileContent from "components/filecontent";
import ServicesGroup from "components/services/group";
@ -28,7 +29,7 @@ import themes from "utils/styles/themes";
import QuickLaunch from "components/quicklaunch";
import { getStoredProvider, searchProviders } from "components/widgets/search/search";
import { fetchWithAuth, readAuthSettings } from "utils/auth/auth-helpers";
import { NullAuthProvider } from "utils/auth/null";
const ThemeToggle = dynamic(() => import("components/toggles/theme"), {
ssr: false,
});
@ -59,12 +60,12 @@ export async function getServerSideProps({req}) {
props: {
initialSettings: settings,
fallback: {
[unstable_serialize(["/api/services", authContext])]: services,
[unstable_serialize(["/api/bookmarks", authContext])]: bookmarks,
[unstable_serialize(["/api/widgets", authContext])]: widgets,
[unstableSerialize(["/api/services", authContext])]: services,
[unstableSerialize(["/api/bookmarks", authContext])]: bookmarks,
[unstableSerialize(["/api/widgets", authContext])]: widgets,
"/api/hash": false,
},
authContext: authContext,
authContext,
...(await serverSideTranslations(settings.language ?? "en")),
},
};
@ -77,12 +78,12 @@ export async function getServerSideProps({req}) {
props: {
initialSettings: {},
fallback: {
[unstable_serialize(["/api/services", authContext])]: [],
[unstable_serialize(["/api/bookmarks", authContext])]: [],
[unstable_serialize(["/api/widgets", authContext])]: [],
[unstableSerialize(["/api/services", authContext])]: [],
[unstableSerialize(["/api/bookmarks", authContext])]: [],
[unstableSerialize(["/api/widgets", authContext])]: [],
"/api/hash": false,
},
authContext: authContext,
authContext,
...(await serverSideTranslations("en")),
},
};

@ -1,5 +1,5 @@
import { ProxyAuthProvider} from "./proxy";
import { NullAuthProvider} from "./null";
import ProxyAuthProvider from "./proxy";
import NullAuthProvider from "./null";
const AuthProviders = {
NullAuthProvider,
@ -7,34 +7,22 @@ const AuthProviders = {
};
function getProviderByKey(key) {
return AuthProviders.find((provider) => provider.key == key) ?? NullAuthProvider;
return AuthProviders.find((provider) => provider.key === key) ?? NullAuthProvider;
}
export function readAuthSettings({provider, groups} = {}) {
return {
provider: provider ? getProviderByKey(provider.type).create(provider) : NullAuthProvider.create(),
groups: groups ? groups.map((group) => ({
name: Object.keys(group)[0],
allowUsers: group[Object.keys(group)[0]].allowUsers,
allowGroups: group[Object.keys(group)[0]].allowGroups
})) : []
}
}
function authAllow({user, groups}, item) {
const groupAllow = (('allowGroups' in item)) && groups.some(group => item.allowGroups.includes(group));
const userAllow = (('allowUsers' in item)) && item.allowUsers.includes(user);
const allowAll = (!('allowGroups' in item)) && (!('allowUsers' in item));
export async function fetchWithAuth(key, context) {
return getProviderByKey(context.provider).fetch([key, context]);
return userAllow || groupAllow || allowAll;
}
export function checkAllowedGroup(perms, authGroups, groupName) {
testGroup = authGroups.find((group) => group.name == groupName )
const testGroup = authGroups.find((group) => group.name === groupName )
return testGroup ? authAllow(perms, testGroup) : true
}
export const filterAllowedServices = (perms, authGroups, services) => filterAllowedItems(perms, authGroups, services, 'services');
export const filterAllowedBookmarks = (perms, authGroups, bookmarks) => filterAllowedItems(perms, authGroups, bookmarks, 'bookmarks');
export const filterAllowedWidgets = (perms, widgets) => {
return widgets.filter((widget) => authItemFilter(perms, widget.options) )
}
function filterAllowedItems(perms, authGroups, groups, groupKey) {
return groups.filter((group) => checkAllowedGroup(perms, authGroups, group.name))
@ -45,13 +33,21 @@ function filterAllowedItems(perms, authGroups, groups, groupKey) {
.filter((group) => group[groupKey].length);
}
export function readAuthSettings({provider, groups} = {}) {
return {
provider: provider ? getProviderByKey(provider.type).create(provider) : NullAuthProvider.create(),
groups: groups ? groups.map((group) => ({
name: Object.keys(group)[0],
allowUsers: group[Object.keys(group)[0]].allowUsers,
allowGroups: group[Object.keys(group)[0]].allowGroups
})) : []
}
}
function authAllow({user, groups}, item) {
const groupAllow = (('allowGroups' in item)) && groups.some(group => item.allowGroups.includes(group));
const userAllow = (('allowUsers' in item)) && item.allowUsers.includes(user);
const allowAll = (!('allowGroups' in item)) && (!('allowUsers' in item));
return userAllow || groupAllow || allowAll;
export async function fetchWithAuth(key, context) {
return getProviderByKey(context.provider).fetch([key, context]);
}
export const filterAllowedServices = (perms, authGroups, services) => filterAllowedItems(perms, authGroups, services, 'services');
export const filterAllowedBookmarks = (perms, authGroups, bookmarks) => filterAllowedItems(perms, authGroups, bookmarks, 'bookmarks');
export const filterAllowedWidgets = (perms, widgets) => widgets.filter((widget) => authAllow(perms, widget.options))

@ -3,19 +3,21 @@ const NullAuthKey = "none"
function createNullAuth() {
return {
authorize: (request) => NullPermissions,
getContext: (request) => { return {
authorize: () => NullPermissions,
getContext: () => ({
provider: NullAuthKey
} },
}),
}
}
async function fetchNullAuth([key, context]) {
async function fetchNullAuth([key]) {
return fetch(key).then((res) => res.json())
}
export const NullAuthProvider = {
const NullAuthProvider = {
key: NullAuthKey,
create: createNullAuth,
fetch: fetchNullAuth
}
export default NullAuthProvider;

@ -3,21 +3,19 @@
const ProxyAuthKey="proxy"
function getProxyPermissions(userHeader, groupHeader, request) {
const user = (userHeader)?request.headers.get(userHeader):None;
const user = (userHeader)?request.headers.get(userHeader):null;
const groupsString = (groupHeader)?request.headers.get(groupHeader):"";
return {user: user, groups: (groupsString)?groupsString.split(",").map((v) => v.trimStart()):[]}
return {user, groups: (groupsString)?groupsString.split(",").map((v) => v.trimStart()):[]}
}
function createProxyAuth({groupHeader, userHeader}) {
return {
getContext : (request) => {
return {
getContext : (request) => ({
type: ProxyAuthKey,
...userHeader && {[userHeader]: request.headers.get(userHeader) },
...groupHeader && {[groupHeader]: request.headers.get(groupHeader)}
}
},
}),
authorize : (request) => getProxyPermissions(userHeader, groupHeader, request)
}
}
@ -26,8 +24,10 @@ async function fetchProxyAuth([key, context]) {
return fetch(key, {headers: context.headers}).then((res) => res.json())
}
export const ProxyAuthProvider = {
const ProxyAuthProvider = {
key: ProxyAuthKey,
create: createProxyAuth,
fetch: fetchProxyAuth
}
}
export default ProxyAuthProvider;

@ -12,7 +12,6 @@ import {
servicesFromKubernetes,
} from "utils/config/service-helpers";
import { cleanWidgetGroups, widgetsFromConfig } from "utils/config/widget-helpers";
import {
filterAllowedBookmarks,
filterAllowedServices,

Loading…
Cancel
Save