summaryrefslogtreecommitdiff
path: root/web/source/settings/lib/util/formvalidators.ts
blob: 4e0e4a6a8fab26ce3cefb470f1cea0eca8918725 (plain)
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
/*
	GoToSocial
	Copyright (C) GoToSocial Authors admin@gotosocial.org
	SPDX-License-Identifier: AGPL-3.0-or-later

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import isValidDomain from "is-valid-domain";
import { useCallback } from "react";
import { ValidScopes, ValidTopLevelScopes } from "../types/scopes";

/**
 * Validate the "domain" field of a form.
 * @param domain 
 * @returns 
 */
export function formDomainValidator(domain: string): string {
	if (domain.length === 0) {
		return "";
	}

	// Allow localhost for testing.
	if (domain === "localhost") {
		return "";
	}

	if (domain[domain.length-1] === ".") {
		return "invalid domain";
	}

	const valid = isValidDomain(domain, {
		subdomain: true,
		wildcard: false,
		allowUnicode: true,
		topLevel: false,
	});

	if (valid) {
		return "";
	}

	return "invalid domain";
}

export function urlValidator(urlStr: string): string {
	if (urlStr.length === 0) {
		return "";
	}

	let url: URL;
	try {
		url = new URL(urlStr);
	} catch (e) {
		return e.message;
	}

	if (url.protocol !== "http:" && url.protocol !== "https:") {
		return `invalid protocol, must be http or https`;
	}

	return formDomainValidator(url.hostname);
}

export function useScopesValidator(): (_scopes: string[]) => string {
	return useCallback((scopes) => {
		return scopes.
			map((scope) => validateScope(scope)).
			flatMap((msg) => msg || []).
			join(", ");
	}, []);
}

export function useScopeValidator(): (_scope: string) => string {
	return useCallback((scope) => validateScope(scope), []);
}

const validateScope = (scope: string) => {
	if (!ValidScopes.includes(scope)) {
		return scope + " is not a recognized scope";
	} 
	return "";
};

export function useScopesPermittedBy(): (_hasScopes: string[], _wantScopes: string[]) => string {
	return useCallback((hasScopes, wantsScopes) => {
		return wantsScopes.
			map((wanted) => scopePermittedByScopes(hasScopes, wanted)).
			flatMap((msg) => msg || []).
			join(", ");
	}, []);
}

const scopePermittedByScopes = (hasScopes: string[], wanted: string) => {
	if (hasScopes.some((hasScope) => scopePermittedByScope(hasScope, wanted) === "")) {
		return "";
	}
	return `scopes [${hasScopes}] do not permit ${wanted}`;
};

const scopePermittedByScope = (has: string, wanted: string) => {
	if (has === wanted) {
		// Exact match on either a
		// top-level or granular scope.
		return "";
	}

	// Ensure we have a
	// known top-level scope.
	switch (true) {
		case (ValidTopLevelScopes.includes(has)):
			// Check if top-level includes wanted,
			// eg., have "admin", want "admin:read".
			if (wanted.startsWith(has + ":")) {
				return "";
			} else {
				return `scope ${has} does not permit ${wanted}`;
			}
	
		default:
			// Unknown top-level scope,
			// can't permit anything.
			return `unrecognized scope ${has}`;
	}
};