Files
Archivum/backend/internal/graph/schema.graphql
Bjorn Blomberg cd588197b9
All checks were successful
build-and-push / build (push) Successful in 15m15s
feat: Authentik OIDC SSO, allow/deny RBAC, admin console & Gitea CI
Authentication & RBAC
- Add confidential OIDC client (Authentik) with /auth/oidc/login +
  /auth/oidc/callback: discovery, code exchange, id_token verify (go-oidc),
  groups claim → role (Archivum-admin → admin, else user). Sessions carry groups.
- Rework ACL into an allow/deny model (new `effect` column + migration).
  db.EffectiveAccess resolves user + all groups over the path and its ancestors:
  default deny, explicit deny always beats allow.
- Enforce ACL for ALL non-admin users (not just guest) across list/read/save/
  delete/move/create/history/diff/images/upload. Admins bypass.
- Seed built-in Archivum-admin / Archivum-reader groups; login allow-list on
  users & groups; public (guest) user access is ACL-configurable.

Admin API & UI
- New GraphQL ops: oidcConfig/updateOidcConfig, group CRUD, membership,
  setUserRole/setUserLogin/setGroupLogin, userGroups, loginOptions.
- Rebuilt AdminView: SSO config, user/group management + membership, login
  toggles, and an allow/deny access-control matrix per path.
- LoginView: "Sign in with Authentik" + public-user option; OIDC callback route.

Rendering/editor
- Fix bug where inline marks (bold/italic/code/strike/link) were dropped on
  TipTap→AsciiDoc save. Add RENDERING_IMPROVEMENTS.md with proposals.

CI / build
- .gitea/workflows/build.yaml: build on the Pi5 runner, push
  localhost:5000/archivum:{latest,<sha>}. Add .dockerignore; bump Go image to 1.25.
- Docs: ARCHITECTURE.md, README.md, docs/AUTHENTIK_SETUP.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-05 21:58:50 +02:00

303 lines
7.3 KiB
GraphQL

type Query {
# Returns REQUIRE_SETUP if config is missing.
systemStatus: SystemStatus!
# Fetch current configuration (admin only).
config: AppConfig!
# List directories on the server for UI pickers.
serverDirectories(path: String): [ServerDirectory!]!
# Fetch a document by its slug path.
document(slug: String!): Document
# List documents under an optional path prefix.
documents(prefix: String): [DocumentMeta!]!
# List all relative folder paths in the repository.
folders: [String!]!
# Commit history for a document.
history(slug: String!): [CommitEntry!]!
# Unified diff between two commits for a document.
diff(slug: String!, fromHash: String!, toHash: String!): String!
# Raw content of a document at a specific commit.
documentAtCommit(slug: String!, hash: String!): String!
# Whether the current storage path has uncommitted files.
repoStatus: RepoStatus!
# List images next to a document.
images(slug: String!): [ImageFile!]!
# Browse LDAP tree (admin only)
ldapBrowse(url: String, baseDN: String, adminUser: String, adminPass: String): LDAPTree!
# Fetch permissions for a path
acl(path: String!): [ACLEntry!]!
# Fetch all permissions for a specific user or group (admin only).
subjectAcl(subjectType: String!, subjectId: Int!): [ACLEntry!]!
# Returns all users and groups that can be assigned to ACL entries (admin only).
aclSubjects: ACLSubjects!
# Returns "local", "ldap", or "guest" for a given username.
userAuthType(username: String!): String!
# Returns the role of the currently authenticated user ("admin", "user", "guest").
currentUserRole: String!
# Sign-in methods the login page should offer (public, no auth required).
loginOptions: LoginOptions!
# All local/external users with role & login state (admin only).
users: [UserInfo!]!
# Current OpenID Connect (Authentik) configuration (admin only, no secret).
oidcConfig: OIDCConfigView!
# Names of the groups a user belongs to (admin only).
userGroups(username: String!): [String!]!
}
type Mutation {
# First-run setup.
setup(input: SetupInput!): Boolean!
# Test an LDAP configuration.
testLdapConnection(url: String!, adminUser: String, adminPass: String): LDAPTestResult!
# Authenticate and receive a bearer token.
login(username: String!, password: String!, ldapPassword: String): String!
# Invalidate the current session.
logout: Boolean!
# Save (create or update) a document.
saveDocument(input: SaveDocumentInput!): Document!
# Delete a document.
deleteDocument(slug: String!): Boolean!
# Modify LDAP Configuration (admin only).
updateLdapConfig(input: LDAPInput): Boolean!
# Modify OpenID Connect (Authentik) configuration (admin only).
updateOidcConfig(input: OIDCInput!): Boolean!
# Sync users/groups from LDAP
importLdapSubject(type: String!, name: String!): Boolean!
# Group management (admin only).
createGroup(name: String!): Boolean!
deleteGroup(name: String!): Boolean!
addUserToGroup(username: String!, group: String!): Boolean!
removeUserFromGroup(username: String!, group: String!): Boolean!
# Who may sign in (admin only).
setUserLogin(username: String!, allow: Boolean!): Boolean!
setGroupLogin(name: String!, allow: Boolean!): Boolean!
# Change a user's application role: "admin" | "user" (admin only).
setUserRole(username: String!, role: String!): Boolean!
# ACL Mutations
setAcl(input: ACLInput!): Boolean!
removeAcl(id: Int!): Boolean!
# Modify Storage Path (admin only).
updateStoragePath(path: String!): Boolean!
# Change the current user's password.
changePassword(old: String!, new: String!): Boolean!
# Commit all uncommitted files in the storage path.
initCommit(message: String!): Boolean!
# Delete an image file.
deleteImage(slug: String!, filename: String!): Boolean!
# Create a new folder (directory) at the specified path.
createFolder(path: String!): Boolean!
# Move a document from one location to another.
moveDocument(oldSlug: String!, newSlug: String!): Boolean!
}
# ── Types ──────────────────────────────────────────────────────────────────────
enum SystemStatus {
OK
REQUIRE_SETUP
}
type AppConfig {
storagePath: String!
ldap: LDAPConfig
}
type LDAPConfig {
url: String!
baseDN: String!
adminUser: String!
}
type LDAPTree {
users: [String!]!
groups: [String!]!
}
type ACLEntry {
id: Int!
path: String!
subjectType: String!
subjectId: Int!
effect: String! # "allow" | "deny" — deny always wins over allow
canSearch: Boolean!
canView: Boolean!
canRead: Boolean!
canEdit: Boolean!
canCreate: Boolean!
canDelete: Boolean!
canMove: Boolean!
}
type LoginOptions {
localEnabled: Boolean!
oidcEnabled: Boolean!
oidcButtonLabel: String!
publicEnabled: Boolean!
}
type UserInfo {
username: String!
role: String!
isLdap: Boolean!
allowLogin: Boolean!
createdAt: String!
}
type OIDCConfigView {
enabled: Boolean!
ready: Boolean!
issuer: String!
clientId: String!
clientSecretSet: Boolean!
redirectUrl: String!
publicUrl: String!
groupsClaim: String!
usernameClaim: String!
adminGroup: String!
readerGroup: String!
}
type ServerDirectory {
name: String!
path: String!
isGitRepo: Boolean!
hasDocuments: Boolean!
}
type Document {
slug: String!
content: String!
meta: DocumentMeta!
}
type DocumentMeta {
slug: String!
title: String!
updatedAt: String!
}
type LDAPTestResult {
success: Boolean!
message: String!
}
type CommitEntry {
hash: String!
author: String!
email: String!
date: String!
subject: String!
added: Int!
removed: Int!
}
type RepoStatus {
hasUncommitted: Boolean!
}
type ImageFile {
name: String!
url: String!
size: Int!
}
# ── Inputs ─────────────────────────────────────────────────────────────────────
input SetupInput {
storagePath: String!
adminUser: String!
adminPass: String!
ldap: LDAPInput
jwtSecret: String!
}
input LDAPInput {
url: String!
baseDN: String
adminUser: String!
adminPass: String
}
type ACLSubject {
id: Int!
name: String!
isLdap: Boolean!
role: String # only present for users
allowLogin: Boolean!
}
type ACLSubjects {
users: [ACLSubject!]!
groups: [ACLSubject!]!
}
input ACLInput {
path: String!
subjectType: String!
subjectId: Int!
effect: String # "allow" (default) | "deny"
canSearch: Boolean!
canView: Boolean!
canRead: Boolean!
canEdit: Boolean!
canCreate: Boolean!
canDelete: Boolean!
canMove: Boolean!
}
input OIDCInput {
enabled: Boolean!
issuer: String!
clientId: String!
clientSecret: String # empty = keep existing
redirectUrl: String
publicUrl: String
groupsClaim: String
usernameClaim: String
adminGroup: String
readerGroup: String
}
input SaveDocumentInput {
slug: String!
content: String!
commitMessage: String!
}