Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Fix: Validate webhook form (#19546)

balibabu0dd438c538c2
diff --git a/web/.env.production b/web/.env.production
index 977e2151ca..84990c33de 100644
--- a/web/.env.production
+++ b/web/.env.production
@@ -1,2 +1,3 @@
VITE_BASE_URL='/'
API_PROXY_SCHEME='python'
+VITE_BUILD_SOURCEMAP=false
\ No newline at end of file
diff --git a/web/src/components/webhook-response-status.tsx b/web/src/components/webhook-response-status.tsx
index cf21323183..0f967dd576 100644
--- a/web/src/components/webhook-response-status.tsx
+++ b/web/src/components/webhook-response-status.tsx
@@ -16,7 +16,7 @@
import { useTranslation } from 'react-i18next';
import { RAGFlowFormItem } from './ragflow-form';
-import { Input } from './ui/input';
+import NumberInput from './originui/number-input';
type WebHookResponseStatusFormFieldProps = {
name: string;
@@ -29,7 +29,7 @@ export function WebHookResponseStatusFormField({
return (
<RAGFlowFormItem name={name} label={t('flow.webhook.status')}>
- <Input type="number"></Input>
+ <NumberInput integer className="w-full"></NumberInput>
</RAGFlowFormItem>
);
}
diff --git a/web/src/pages/agent/form/begin-form/schema.ts b/web/src/pages/agent/form/begin-form/schema.ts
index 396d71595a..febf0d84d8 100644
--- a/web/src/pages/agent/form/begin-form/schema.ts
+++ b/web/src/pages/agent/form/begin-form/schema.ts
@@ -1,5 +1,35 @@
import { WebhookJWTAlgorithmList } from '@/constants/agent';
+import { countBy } from 'lodash';
import { z } from 'zod';
+import { isValidIpOrCidr } from './utils';
+
+function validateUniqueKeys(
+ items: Array<{ key: string }>,
+ ctx: z.RefinementCtx,
+) {
+ const keyCounts = countBy(items, 'key');
+
+ items.forEach((item, index) => {
+ if (item.key && keyCounts[item.key] > 1) {
+ ctx.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: [index, 'key'],
+ message: 'The key cannot be repeated!',
+ });
+ }
+ });
+}
+
+const WebhookParametersSchema = z
+ .array(
+ z.object({
+ key: z.string().trim().min(1, 'The key is required!'),
+ type: z.string(),
+ required: z.boolean(),
+ }),
+ )
+ .superRefine(validateUniqueKeys)
+ .optional();
export const BeginFormSchema = z.object({
enablePrologue: z.boolean().optional(),
@@ -23,7 +53,13 @@ export const BeginFormSchema = z.object({
security: z
.object({
auth_type: z.string(),
- ip_whitelist: z.array(z.object({ value: z.string() })),
+ ip_whitelist: z.array(
+ z.object({
+ value: z.string().trim().refine(isValidIpOrCidr, {
+ message: 'Invalid IP address or CIDR block',
+ }),
+ }),
+ ),
rate_limit: z.object({
limit: z.number(),
per: z.string().optional(),
@@ -46,38 +82,16 @@ export const BeginFormSchema = z.object({
.optional(),
schema: z
.object({
- query: z
- .array(
- z.object({
- key: z.string(),
- type: z.string(),
- required: z.boolean(),
- }),
- )
- .optional(),
- headers: z
- .array(
- z.object({
- key: z.string(),
- type: z.string(),
- required: z.boolean(),
- }),
- )
- .optional(),
- body: z
- .array(
- z.object({
- key: z.string(),
- type: z.string(),
- required: z.boolean(),
- }),
- )
- .optional(),
+ query: WebhookParametersSchema,
+ headers: WebhookParametersSchema,
+ body: WebhookParametersSchema,
})
.optional(),
response: z
.object({
- status: z.number(),
+ status: z
+ .number({ invalid_type_error: 'The status is required!' })
+ .int('The status must be an integer'),
// headers_template: z.array(
// z.object({ key: z.string(), value: z.string() }),
// ),
diff --git a/web/src/pages/agent/form/begin-form/utils.test.ts b/web/src/pages/agent/form/begin-form/utils.test.ts
new file mode 100644
index 0000000000..dfae28152a
--- /dev/null
+++ b/web/src/pages/agent/form/begin-form/utils.test.ts
@@ -0,0 +1,48 @@
+import { isValidIpOrCidr } from './utils';
+
+describe('isValidIpOrCidr', () => {
+ it.each([
+ '10.0.0.5',
+ '192.168.1.1',
+ '0.0.0.0',
+ '255.255.255.255',
+ '10.0.0.0/8',
+ '10.0.0.0/0',
+ '10.0.0.0/32',
+ ])('accepts IPv4 %s', (value) => {
+ expect(isValidIpOrCidr(value)).toBe(true);
+ });
+
+ it.each([
+ '::1',
+ '::',
+ '2001:db8::1',
+ '2001:0db8:85a3:0000:0000:8a2e:0370:7334',
+ '1:2:3:4:5:6:7:8',
+ '::ffff:192.168.0.1',
+ '2001:db8::/32',
+ '::1/128',
+ ])('accepts IPv6 %s', (value) => {
+ expect(isValidIpOrCidr(value)).toBe(true);
+ });
+
+ it.each([
+ '',
+ 'abc',
+ '256.1.1.1',
+ '1.2.3',
+ '1.2.3.4.5',
+ '01.2.3.4',
+ '10.0.0.0/33',
+ '10.0.0.0/',
+ '10.0.0.0/abc',
+ '10.0.0.0/8/16',
+ '1:2:3:4:5:6:7:8:9',
+ '2001::db8::1',
+ '12345::',
+ ':1::',
+ '::1/129',
+ ])('rejects %s', (value) => {
+ expect(isValidIpOrCidr(value)).toBe(false);
+ });
+});
diff --git a/web/src/pages/agent/form/begin-form/utils.ts b/web/src/pages/agent/form/begin-form/utils.ts
index 36038c4f6d..e8dde63f76 100644
--- a/web/src/pages/agent/form/begin-form/utils.ts
+++ b/web/src/pages/agent/form/begin-form/utils.ts
@@ -12,3 +12,66 @@ export function buildBeginInputListFromObject(
[],
);
}
+
+const Ipv4Segment = '(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)';
+const Ipv4Pattern = new RegExp(`^(${Ipv4Segment}\\.){3}${Ipv4Segment}$`);
+const Ipv6HextetPattern = /^[0-9a-fA-F]{1,4}$/;
+const DigitsPattern = /^\d+$/;
+
+function isValidIpv6(value: string): boolean {
+ let rest = value;
+
+ // An embedded IPv4 tail (e.g. ::ffff:192.168.0.1) counts as two hextets.
+ const lastColonIndex = rest.lastIndexOf(':');
+ const ipv4Tail = rest.slice(lastColonIndex + 1);
+ if (lastColonIndex !== -1 && ipv4Tail.includes('.')) {
+ if (!Ipv4Pattern.test(ipv4Tail)) {
+ return false;
+ }
+ rest = `${rest.slice(0, lastColonIndex)}:0:0`;
+ } else if (rest.includes('.')) {
+ return false;
+ }
+
+ const halves = rest.split('::');
+ if (halves.length > 2) {
+ return false;
+ }
+
+ const head = halves[0] ? halves[0].split(':') : [];
+ const tail = halves.length === 2 && halves[1] ? halves[1].split(':') : [];
+
+ if (![...head, ...tail].every((hextet) => Ipv6HextetPattern.test(hextet))) {
+ return false;
+ }
+
+ // '::' must compress at least one hextet; without it exactly 8 are required.
+ return halves.length === 2
+ ? head.length + tail.length < 8
+ : head.length === 8;
+}
+
+// Accepts a bare IPv4/IPv6 address or one with a CIDR prefix length,
+// matching what the webhook backend understands (e.g. 10.0.0.5, 10.0.0.0/8).
+export function isValidIpOrCidr(value: string): boolean {
+ const parts = value.split('/');
+ if (parts.length > 2) {
+ return false;
+ }
+
+ const [address, prefixLength] = parts;
+ const isV4 = Ipv4Pattern.test(address);
+ if (!isV4 && !isValidIpv6(address)) {
+ return false;
+ }
+
+ if (prefixLength === undefined) {
+ return true;
+ }
+ if (!DigitsPattern.test(prefixLength)) {
+ return false;
+ }
+
+ const bits = Number(prefixLength);
+ return isV4 ? bits <= 32 : bits <= 128;
+}
diff --git a/web/src/pages/agent/form/begin-form/webhook/auth.tsx b/web/src/pages/agent/form/begin-form/webhook/auth.tsx
index a674e10db9..b60724aca8 100644
--- a/web/src/pages/agent/form/begin-form/webhook/auth.tsx
+++ b/web/src/pages/agent/form/begin-form/webhook/auth.tsx
@@ -54,7 +54,7 @@ export function Auth() {
name="security.basic_auth.password"
label={t('flow.webhook.password')}
>
- <Input></Input>
+ <Input type="password" autoComplete="new-password"></Input>
</RAGFlowFormItem>
</>
),
diff --git a/web/src/pages/agent/form/begin-form/webhook/dynamic-request.tsx b/web/src/pages/agent/form/begin-form/webhook/dynamic-request.tsx
index 2124f5e188..cc8be825df 100644
--- a/web/src/pages/agent/form/begin-form/webhook/dynamic-request.tsx
+++ b/web/src/pages/agent/form/begin-form/webhook/dynamic-request.tsx
@@ -7,7 +7,7 @@ import { Switch } from '@/components/ui/switch';
import { buildOptions } from '@/utils/form';
import { loader } from '@monaco-editor/react';
import { X } from 'lucide-react';
-import { ReactNode } from 'react';
+import { ReactNode, useCallback } from 'react';
import { useFieldArray, useFormContext } from 'react-hook-form';
import { TypesWithArray, WebhookRequestParameters } from '../../../constant';
import { DynamicFormHeader } from '../../components/dynamic-fom-header';
@@ -42,18 +42,23 @@ export function DynamicRequest({
control: form.control,
});
+ // append is not a change event, so trigger manually to surface
+ // the required/duplicate errors of the freshly added empty row.
+ const handleAdd = useCallback(() => {
+ append({
+ [keyField]: '',
+ [operatorField]: TypesWithArray.String,
+ [requiredField]: false,
+ });
+ form.trigger(name);
+ }, [append, form, keyField, name, operatorField, requiredField]);
+
return (
<section className="space-y-2">
<DynamicFormHeader
label={label}
tooltip={tooltip}
- onClick={() =>
- append({
- [keyField]: '',
- [operatorField]: TypesWithArray.String,
- [requiredField]: false,
- })
- }
+ onClick={handleAdd}
></DynamicFormHeader>
<div className="space-y-5">
{fields.map((field, index) => {
@@ -64,11 +69,13 @@ export function DynamicRequest({
return (
<section key={field.id} className="flex gap-2">
<div className="flex-1 space-y-3 min-w-0">
- <div className="flex items-center gap-2">
+ <div className="flex items-start gap-2">
<RAGFlowFormItem name={keyFieldAlias} className="flex-1 ">
<KeyInput></KeyInput>
</RAGFlowFormItem>
- <Separator className="w-2" />
+ <div className="flex h-8 items-center">
+ <Separator className="w-2" />
+ </div>
<RAGFlowFormItem name={operatorFieldAlias} className="flex-1">
{(field) => (
<SelectWithSearch
@@ -80,13 +87,17 @@ export function DynamicRequest({
></SelectWithSearch>
)}
</RAGFlowFormItem>
- <Separator className="w-2" />
+ <div className="flex h-8 items-center">
+ <Separator className="w-2" />
+ </div>
<RAGFlowFormItem name={requiredFieldAlias}>
{(field) => (
- <Switch
- checked={field.value}
- onCheckedChange={field.onChange}
- ></Switch>
+ <div className="flex h-8 items-center">
+ <Switch
+ checked={field.value}
+ onCheckedChange={field.onChange}
+ ></Switch>
+ </div>
)}
</RAGFlowFormItem>
</div>
diff --git a/web/src/pages/agent/form/begin-form/webhook/index.tsx b/web/src/pages/agent/form/begin-form/webhook/index.tsx
index 36c0f94040..b852922c94 100644
--- a/web/src/pages/agent/form/begin-form/webhook/index.tsx
+++ b/web/src/pages/agent/form/begin-form/webhook/index.tsx
@@ -89,6 +89,7 @@ export function WebHook() {
<NumberInput
max={getLimitRateLimitPerMax(rateLimitPer)}
className="w-full"
+ integer
></NumberInput>
</RAGFlowFormItem>
<Separator className="w-2" />
diff --git a/web/src/pages/agent/form/begin-form/webhook/response.tsx b/web/src/pages/agent/form/begin-form/webhook/response.tsx
index a1a26b4f94..e3847b4b86 100644
--- a/web/src/pages/agent/form/begin-form/webhook/response.tsx
+++ b/web/src/pages/agent/form/begin-form/webhook/response.tsx
@@ -35,14 +35,6 @@ export function WebhookResponse() {
<WebHookResponseStatusFormField
name={'response.status'}
></WebHookResponseStatusFormField>
- {/* <DynamicResponse
- name="response.headers_template"
- label={t('flow.webhook.headersTemplate')}
- ></DynamicResponse> */}
- {/* <DynamicResponse
- name="response.body_template"
- label={t('flow.webhook.bodyTemplate')}
- ></DynamicResponse> */}
<RAGFlowFormItem
name="response.body_template"
label={t('flow.webhook.bodyTemplate')}
diff --git a/web/src/pages/agent/form/components/dynamic-string-form.tsx b/web/src/pages/agent/form/components/dynamic-string-form.tsx
index 224e923108..ee61acac82 100644
--- a/web/src/pages/agent/form/components/dynamic-string-form.tsx
+++ b/web/src/pages/agent/form/components/dynamic-string-form.tsx
@@ -2,6 +2,7 @@ import { RAGFlowFormItem } from '@/components/ragflow-form';
import { Button } from '@/components/ui/button';
import { Input } from '@/components/ui/input';
import { Trash2 } from 'lucide-react';
+import { useCallback } from 'react';
import { useFieldArray, useFormContext } from 'react-hook-form';
import { DynamicFormHeader, FormListHeaderProps } from './dynamic-fom-header';
@@ -14,15 +15,19 @@ export function DynamicStringForm({ name, label }: DynamicStringFormProps) {
control: form.control,
});
+ // append is not a change event, so trigger manually to surface
+ // the validation errors of the freshly added empty row.
+ const handleAdd = useCallback(() => {
+ append({ value: '' });
+ form.trigger(name);
+ }, [append, form, name]);
+
return (
<section>
- <DynamicFormHeader
- label={label}
- onClick={() => append({ value: '' })}
- ></DynamicFormHeader>
+ <DynamicFormHeader label={label} onClick={handleAdd}></DynamicFormHeader>
<div className="space-y-4">
{fields.map((field, index) => (
- <div key={field.id} className="flex items-center gap-2">
+ <div key={field.id} className="flex items-start gap-2">
<RAGFlowFormItem
name={`${name}.${index}.value`}
label="delimiter"