Skip to content
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
3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ RUN pnpm install --frozen-lockfile && \
rm -rf /usr/local/bin/pnpm* /usr/local/bin/corepack && \
rm -rf $HOME/.local && \
rm -rf $HOME/.cache && \
sed -i 's/\r//' ./docker-entrypoint.sh && \
sed -i 's/\r//' ./process-environment.sh && \
sed -i 's/\r//' ./setup-ssl.sh && \
chmod a+x ./process-environment.sh && \
chmod a+x ./setup-ssl.sh && \
chmod a+x ./docker-entrypoint.sh
Expand Down
20 changes: 14 additions & 6 deletions packages/graph-explorer-proxy-server/src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ const DbQueryHeadersSchema = z.object({
.optional()
.default(DEFAULT_SERVICE_TYPE),
"db-query-logging-enabled": z.stringbool().optional().default(false),
authorization: z.string().optional(),
});

/** Validates and extracts database query headers. Throws {@link RequestValidationError} on failure. */
Expand All @@ -76,6 +77,7 @@ function parseDbQueryHeaders(headers: IncomingHttpHeaders) {
queryId: parsed.queryid,
graphDbConnectionUrl: parsed["graph-db-connection-url"],
shouldLogDbQuery: parsed["db-query-logging-enabled"],
authorization: parsed.authorization,
...authOptions,
};
}
Expand Down Expand Up @@ -285,6 +287,7 @@ export function createApp({
isIamEnabled,
region,
serviceType,
authorization,
} = parseDbQueryHeaders(req.headers);
assertAllowedDbOrigin(graphDbConnectionUrl, allowedDbOrigins);

Expand Down Expand Up @@ -355,6 +358,7 @@ export function createApp({
headers: {
"Content-Type": "application/x-www-form-urlencoded",
Accept: "application/sparql-results+json",
...(authorization && { Authorization: authorization }),
},
body,
};
Expand All @@ -380,6 +384,7 @@ export function createApp({
isIamEnabled,
region,
serviceType,
authorization,
} = parseDbQueryHeaders(req.headers);
assertAllowedDbOrigin(graphDbConnectionUrl, allowedDbOrigins);

Expand Down Expand Up @@ -441,6 +446,7 @@ export function createApp({
headers: {
"Content-Type": "application/json",
Accept: "application/vnd.gremlin-v3.0+json",
...(authorization && { Authorization: authorization }),
},
body: JSON.stringify(body),
};
Expand All @@ -465,6 +471,7 @@ export function createApp({
isIamEnabled,
region,
serviceType,
authorization,
} = parseDbQueryHeaders(req.headers);
assertAllowedDbOrigin(graphDbConnectionUrl, allowedDbOrigins);

Expand All @@ -488,6 +495,7 @@ export function createApp({
headers: {
"Content-Type": "application/x-www-form-urlencoded",
Accept: "application/json",
...(authorization && { Authorization: authorization }),
},
body: `query=${encodeURIComponent(queryString)}`,
};
Expand All @@ -505,7 +513,7 @@ export function createApp({

// GET endpoint to retrieve PropertyGraph statistics summary for Neptune Analytics.
app.get("/summary", async (req, res, next) => {
const { graphDbConnectionUrl, isIamEnabled, region, serviceType } =
const { graphDbConnectionUrl, isIamEnabled, region, serviceType, authorization } =
parseDbQueryHeaders(req.headers);
assertAllowedDbOrigin(graphDbConnectionUrl, allowedDbOrigins);
const rawUrl = resolveEndpointUrl(
Expand All @@ -517,7 +525,7 @@ export function createApp({
res,
next,
rawUrl,
{ method: "GET" },
{ method: "GET", headers: { ...(authorization && { Authorization: authorization }) } },
isIamEnabled,
region,
serviceType,
Expand All @@ -526,7 +534,7 @@ export function createApp({

// GET endpoint to retrieve PropertyGraph statistics summary for Neptune DB.
app.get("/pg/statistics/summary", async (req, res, next) => {
const { graphDbConnectionUrl, isIamEnabled, region, serviceType } =
const { graphDbConnectionUrl, isIamEnabled, region, serviceType, authorization } =
parseDbQueryHeaders(req.headers);
assertAllowedDbOrigin(graphDbConnectionUrl, allowedDbOrigins);
const rawUrl = resolveEndpointUrl(
Expand All @@ -538,7 +546,7 @@ export function createApp({
res,
next,
rawUrl,
{ method: "GET" },
{ method: "GET", headers: { ...(authorization && { Authorization: authorization }) } },
isIamEnabled,
region,
serviceType,
Expand All @@ -547,7 +555,7 @@ export function createApp({

// GET endpoint to retrieve RDF statistics summary.
app.get("/rdf/statistics/summary", async (req, res, next) => {
const { graphDbConnectionUrl, isIamEnabled, region, serviceType } =
const { graphDbConnectionUrl, isIamEnabled, region, serviceType, authorization } =
parseDbQueryHeaders(req.headers);
assertAllowedDbOrigin(graphDbConnectionUrl, allowedDbOrigins);
const rawUrl = resolveEndpointUrl(
Expand All @@ -559,7 +567,7 @@ export function createApp({
res,
next,
rawUrl,
{ method: "GET" },
{ method: "GET", headers: { ...(authorization && { Authorization: authorization }) } },
isIamEnabled,
region,
serviceType,
Expand Down
3 changes: 3 additions & 0 deletions packages/graph-explorer/src/connector/fetchDatabaseRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ function getAuthHeaders(
headers["aws-neptune-region"] = connection.awsRegion || "";
headers["service-type"] = connection.serviceType || DEFAULT_SERVICE_TYPE;
}
if (connection.username && connection.password) {
headers["Authorization"] = `Basic ${btoa(`${connection.username}:${connection.password}`)}`;
}

if (typeHeaders) {
Object.assign(headers, Object.fromEntries(new Headers(typeHeaders)));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ type ConnectionForm = {
fetchTimeoutMs?: number;
nodeExpansionLimitEnabled: boolean;
nodeExpansionLimit?: number;
username?: string;
password?: string;
};

const CONNECTIONS_OP: {
Expand Down Expand Up @@ -76,6 +78,8 @@ function mapToConnection(data: Required<ConnectionForm>): ConnectionConfig {
nodeExpansionLimit: data.nodeExpansionLimitEnabled
? data.nodeExpansionLimit
: undefined,
username: data.username || undefined,
password: data.password || undefined,
};
}

Expand Down Expand Up @@ -193,6 +197,8 @@ const CreateConnection = ({
fetchTimeoutMs: initialData?.fetchTimeoutMs,
nodeExpansionLimitEnabled: initialData?.nodeExpansionLimitEnabled || false,
nodeExpansionLimit: initialData?.nodeExpansionLimit,
username: initialData?.username || "",
password: initialData?.password || "",
});

const [hasError, setError] = useState(false);
Expand Down Expand Up @@ -295,6 +301,31 @@ const CreateConnection = ({
/>
</FormItem>

<FormItem>
<Label>
Username
<InfoTooltip>
Optional. Required when the graph database uses HTTP Basic
authentication, e.g. JanusGraph with SaslAndHMACAuthenticator.
</InfoTooltip>
</Label>
<InputField
aria-label="Username"
value={form.username}
onChange={onFormChange("username")}
placeholder="Leave empty for unauthenticated connections"
/>
</FormItem>
<FormItem>
<Label>Password</Label>
<InputField
aria-label="Password"
type="password"
value={form.password}
onChange={onFormChange("password")}
/>
</FormItem>

<Label className="cursor-pointer">
<Checkbox
value="proxyConnection"
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,13 @@ export type ConnectionConfig = {
* This value overrides the app wide default limit.
*/
nodeExpansionLimit?: number;
/**
* Username for HTTP Basic authentication (e.g. JanusGraph with
* SaslAndHMACAuthenticator). Leave empty to send unauthenticated requests.
*/
username?: string;
/**
* Password for HTTP Basic authentication. Stored client-side only.
*/
password?: string;
};