feat(core): add connector authentication (#31837)
This commit is contained in:
Dax
@@ -15,6 +15,7 @@ import { QuestionGroup } from "./groups/question"
|
||||
import { ReferenceGroup } from "./groups/reference"
|
||||
import { Authorization } from "./middleware/authorization"
|
||||
import { LocationGroup } from "./groups/location"
|
||||
import { ConnectorGroup } from "./groups/connector"
|
||||
|
||||
export const Api = HttpApi.make("server")
|
||||
.add(HealthGroup)
|
||||
@@ -24,6 +25,7 @@ export const Api = HttpApi.make("server")
|
||||
.add(MessageGroup)
|
||||
.add(ModelGroup)
|
||||
.add(ProviderGroup)
|
||||
.add(ConnectorGroup)
|
||||
.add(PermissionGroup)
|
||||
.add(FileSystemGroup)
|
||||
.add(CommandGroup)
|
||||
|
||||
133
packages/server/src/groups/connector.ts
Normal file
133
packages/server/src/groups/connector.ts
Normal file
@@ -0,0 +1,133 @@
|
||||
import { Connector } from "@opencode-ai/core/connector"
|
||||
import { Location } from "@opencode-ai/core/location"
|
||||
import { Schema } from "effect"
|
||||
import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/unstable/httpapi"
|
||||
import { InvalidRequestError } from "../errors"
|
||||
import { LocationMiddleware, LocationQuery, locationQueryOpenApi } from "./location"
|
||||
|
||||
const Inputs = Schema.Record(Schema.String, Schema.String)
|
||||
|
||||
export const ConnectorGroup = HttpApiGroup.make("server.connector")
|
||||
.add(
|
||||
HttpApiEndpoint.get("connector.list", "/api/connector", {
|
||||
query: LocationQuery,
|
||||
success: Location.response(Schema.Array(Connector.Info)),
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.list",
|
||||
summary: "List connectors",
|
||||
description: "Retrieve available connectors and their authentication methods.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.add(
|
||||
HttpApiEndpoint.get("connector.get", "/api/connector/:connectorID", {
|
||||
params: { connectorID: Connector.ID },
|
||||
query: LocationQuery,
|
||||
success: Location.response(Schema.UndefinedOr(Connector.Info)),
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.get",
|
||||
summary: "Get connector",
|
||||
description: "Retrieve one connector and its authentication methods.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.add(
|
||||
HttpApiEndpoint.post("connector.connect.key", "/api/connector/:connectorID/connect/key", {
|
||||
params: { connectorID: Connector.ID },
|
||||
query: LocationQuery,
|
||||
payload: Schema.Struct({
|
||||
methodID: Connector.MethodID,
|
||||
key: Schema.String,
|
||||
inputs: Inputs,
|
||||
label: Schema.optional(Schema.String),
|
||||
}),
|
||||
success: HttpApiSchema.NoContent,
|
||||
error: InvalidRequestError,
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.connect.key",
|
||||
summary: "Connect with key",
|
||||
description: "Run a key authentication method and store the resulting credential.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.add(
|
||||
HttpApiEndpoint.post("connector.connect.oauth.begin", "/api/connector/:connectorID/connect/oauth", {
|
||||
params: { connectorID: Connector.ID },
|
||||
query: LocationQuery,
|
||||
payload: Schema.Struct({
|
||||
methodID: Connector.MethodID,
|
||||
inputs: Inputs,
|
||||
label: Schema.optional(Schema.String),
|
||||
}),
|
||||
success: Location.response(Connector.Attempt),
|
||||
error: InvalidRequestError,
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.connect.oauth.begin",
|
||||
summary: "Begin OAuth connection",
|
||||
description: "Start an OAuth attempt and return the authorization details.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.add(
|
||||
HttpApiEndpoint.get("connector.connect.oauth.status", "/api/connector/oauth/:attemptID", {
|
||||
params: { attemptID: Connector.AttemptID },
|
||||
query: LocationQuery,
|
||||
success: Location.response(Connector.AttemptStatus),
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.connect.oauth.status",
|
||||
summary: "Get OAuth attempt status",
|
||||
description: "Poll the current status of an OAuth attempt.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.add(
|
||||
HttpApiEndpoint.post("connector.connect.oauth.complete", "/api/connector/oauth/:attemptID/complete", {
|
||||
params: { attemptID: Connector.AttemptID },
|
||||
query: LocationQuery,
|
||||
payload: Schema.Struct({ code: Schema.optional(Schema.String) }),
|
||||
success: HttpApiSchema.NoContent,
|
||||
error: InvalidRequestError,
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.connect.oauth.complete",
|
||||
summary: "Complete OAuth connection",
|
||||
description: "Complete a code-based OAuth attempt and store the resulting credential.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.add(
|
||||
HttpApiEndpoint.delete("connector.connect.oauth.cancel", "/api/connector/oauth/:attemptID", {
|
||||
params: { attemptID: Connector.AttemptID },
|
||||
query: LocationQuery,
|
||||
success: HttpApiSchema.NoContent,
|
||||
})
|
||||
.annotateMerge(locationQueryOpenApi)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({
|
||||
identifier: "v2.connector.connect.oauth.cancel",
|
||||
summary: "Cancel OAuth connection",
|
||||
description: "Cancel an OAuth attempt and release its resources.",
|
||||
}),
|
||||
),
|
||||
)
|
||||
.annotateMerge(
|
||||
OpenApi.annotations({ title: "connectors", description: "Connector discovery and authentication routes." }),
|
||||
)
|
||||
.middleware(LocationMiddleware)
|
||||
@@ -19,6 +19,7 @@ import { QuestionHandler } from "./handlers/question"
|
||||
import { ReferenceHandler } from "./handlers/reference"
|
||||
import * as SessionExecutionLocal from "@opencode-ai/core/session/execution/local"
|
||||
import { LocationHandler } from "./handlers/location"
|
||||
import { ConnectorHandler } from "./handlers/connector"
|
||||
|
||||
export const handlers = Layer.mergeAll(
|
||||
HealthHandler,
|
||||
@@ -28,6 +29,7 @@ export const handlers = Layer.mergeAll(
|
||||
MessageHandler,
|
||||
ModelHandler,
|
||||
ProviderHandler,
|
||||
ConnectorHandler,
|
||||
PermissionHandler,
|
||||
FileSystemHandler,
|
||||
CommandHandler,
|
||||
|
||||
102
packages/server/src/handlers/connector.ts
Normal file
102
packages/server/src/handlers/connector.ts
Normal file
@@ -0,0 +1,102 @@
|
||||
import { Connector } from "@opencode-ai/core/connector"
|
||||
import { Effect } from "effect"
|
||||
import { HttpApiBuilder, HttpApiSchema } from "effect/unstable/httpapi"
|
||||
import { Api } from "../api"
|
||||
import { InvalidRequestError } from "../errors"
|
||||
import { response } from "../groups/location"
|
||||
|
||||
const authorize = <A, R>(effect: Effect.Effect<A, Connector.AuthorizationError, R>) =>
|
||||
effect.pipe(
|
||||
Effect.mapError(
|
||||
() =>
|
||||
new InvalidRequestError({
|
||||
message: "Authentication failed",
|
||||
kind: "connector_authorization",
|
||||
}),
|
||||
),
|
||||
)
|
||||
|
||||
export const ConnectorHandler = HttpApiBuilder.group(Api, "server.connector", (handlers) =>
|
||||
Effect.gen(function* () {
|
||||
return handlers
|
||||
.handle(
|
||||
"connector.list",
|
||||
Effect.fn(function* () {
|
||||
const service = yield* Connector.Service
|
||||
return yield* response(service.list())
|
||||
}),
|
||||
)
|
||||
.handle(
|
||||
"connector.get",
|
||||
Effect.fn(function* (ctx) {
|
||||
const service = yield* Connector.Service
|
||||
return yield* response(service.get(ctx.params.connectorID))
|
||||
}),
|
||||
)
|
||||
.handle(
|
||||
"connector.connect.key",
|
||||
Effect.fn(function* (ctx) {
|
||||
const service = yield* Connector.Service
|
||||
yield* authorize(
|
||||
service.connect.key({
|
||||
connectorID: ctx.params.connectorID,
|
||||
methodID: ctx.payload.methodID,
|
||||
key: ctx.payload.key,
|
||||
inputs: ctx.payload.inputs,
|
||||
label: ctx.payload.label,
|
||||
}),
|
||||
)
|
||||
return HttpApiSchema.NoContent.make()
|
||||
}),
|
||||
)
|
||||
.handle(
|
||||
"connector.connect.oauth.begin",
|
||||
Effect.fn(function* (ctx) {
|
||||
const service = yield* Connector.Service
|
||||
return yield* response(
|
||||
authorize(
|
||||
service.connect.oauth.begin({
|
||||
connectorID: ctx.params.connectorID,
|
||||
methodID: ctx.payload.methodID,
|
||||
inputs: ctx.payload.inputs,
|
||||
label: ctx.payload.label,
|
||||
}),
|
||||
),
|
||||
)
|
||||
}),
|
||||
)
|
||||
.handle(
|
||||
"connector.connect.oauth.status",
|
||||
Effect.fn(function* (ctx) {
|
||||
const service = yield* Connector.Service
|
||||
return yield* response(service.connect.oauth.status(ctx.params.attemptID))
|
||||
}),
|
||||
)
|
||||
.handle(
|
||||
"connector.connect.oauth.complete",
|
||||
Effect.fn(function* (ctx) {
|
||||
const service = yield* Connector.Service
|
||||
yield* service.connect.oauth
|
||||
.complete({ attemptID: ctx.params.attemptID, code: ctx.payload.code })
|
||||
.pipe(
|
||||
Effect.mapError(
|
||||
(error) =>
|
||||
new InvalidRequestError({
|
||||
message: error._tag === "Connector.CodeRequired" ? "Authorization code is required" : "Authentication failed",
|
||||
kind: error._tag === "Connector.CodeRequired" ? "connector_code_required" : "connector_authorization",
|
||||
}),
|
||||
),
|
||||
)
|
||||
return HttpApiSchema.NoContent.make()
|
||||
}),
|
||||
)
|
||||
.handle(
|
||||
"connector.connect.oauth.cancel",
|
||||
Effect.fn(function* (ctx) {
|
||||
const service = yield* Connector.Service
|
||||
yield* service.connect.oauth.cancel(ctx.params.attemptID)
|
||||
return HttpApiSchema.NoContent.make()
|
||||
}),
|
||||
)
|
||||
}),
|
||||
)
|
||||
Reference in New Issue
Block a user