Retrict some query and mutation to only session

Signed-off-by: Bryan Frimin <bryan@probo.com>
This commit is contained in:
Bryan Frimin
2026-06-02 17:43:00 -07:00
parent 9c4b6aff18
commit 383ea5a2d4
25 changed files with 268 additions and 190 deletions

View File

@@ -1,5 +1,6 @@
schema: schema:
- "graphql/*.graphql" - "graphql/*.graphql"
- "../../../gqlutils/directives/authentication/schema.graphql"
- "../../../gqlutils/directives/session/schema.graphql" - "../../../gqlutils/directives/session/schema.graphql"
exec: exec:
@@ -22,7 +23,9 @@ call_argument_directives_with_null: true
directives: directives:
mustBeAuthorized: mustBeAuthorized:
skip_runtime: false skip_runtime: false
session: authentication:
skip_runtime: false
sessionOnly:
skip_runtime: false skip_runtime: false
models: models:

View File

@@ -54,7 +54,7 @@ type AuditLogEntry implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
type AuditLogEntryConnection type AuditLogEntryConnection

View File

@@ -21,17 +21,17 @@ interface Node {
} }
type Query { type Query {
node(id: ID!): Node @session(required: PRESENT) node(id: ID!): Node @authentication(required: PRESENT)
viewer: Identity @session(required: PRESENT) viewer: Identity @authentication(required: PRESENT)
ssoLoginURL(email: EmailAddr!): String ssoLoginURL(email: EmailAddr!): String
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
oidcProviders: [OIDCProviderInfo!]! oidcProviders: [OIDCProviderInfo!]!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
signUpEnabled: Boolean! signUpEnabled: Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
} }
type OIDCProviderInfo { type OIDCProviderInfo {

View File

@@ -28,17 +28,22 @@ type Identity implements Node {
after: CursorKey after: CursorKey
last: Int last: Int
before: CursorKey before: CursorKey
): PersonalAPIKeyConnection @goField(forceResolver: true) ): PersonalAPIKeyConnection
@goField(forceResolver: true)
@authentication(required: PRESENT)
@sessionOnly
invitingOrganizations: [Organization!]! invitingOrganizations: [Organization!]!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
@sessionOnly
ssoLoginURL: String ssoLoginURL: String
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
@sessionOnly
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }

View File

@@ -7,7 +7,7 @@ type Invitation implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
enum InvitationStatus enum InvitationStatus
@@ -51,7 +51,7 @@ type InvitationEdge {
extend type Mutation { extend type Mutation {
inviteUser(input: InviteUserInput!): InviteUserPayload inviteUser(input: InviteUserInput!): InviteUserPayload
@session(required: PRESENT) @authentication(required: PRESENT)
} }
input InviteUserInput { input InviteUserInput {

View File

@@ -18,7 +18,7 @@ type Membership implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
extend type Mutation { extend type Mutation {

View File

@@ -1,11 +1,11 @@
extend type Mutation { extend type Mutation {
authorizeDevice( authorizeDevice(
input: AuthorizeDeviceInput! input: AuthorizeDeviceInput!
): AuthorizeDevicePayload @session(required: PRESENT) ): AuthorizeDevicePayload @authentication(required: PRESENT) @sessionOnly
approveConsent( approveConsent(
input: ApproveConsentInput! input: ApproveConsentInput!
): ApproveConsentPayload @session(required: PRESENT) ): ApproveConsentPayload @authentication(required: PRESENT) @sessionOnly
} }

View File

@@ -41,22 +41,22 @@ type Organization implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
extend type Mutation { extend type Mutation {
createOrganization( createOrganization(
input: CreateOrganizationInput! input: CreateOrganizationInput!
): CreateOrganizationPayload @session(required: PRESENT) ): CreateOrganizationPayload @authentication(required: PRESENT)
updateOrganization( updateOrganization(
input: UpdateOrganizationInput! input: UpdateOrganizationInput!
): UpdateOrganizationPayload @session(required: PRESENT) ): UpdateOrganizationPayload @authentication(required: PRESENT)
deleteOrganization( deleteOrganization(
input: DeleteOrganizationInput! input: DeleteOrganizationInput!
): DeleteOrganizationPayload @session(required: PRESENT) ): DeleteOrganizationPayload @authentication(required: PRESENT)
deleteOrganizationHorizontalLogo( deleteOrganizationHorizontalLogo(
input: DeleteOrganizationHorizontalLogoInput! input: DeleteOrganizationHorizontalLogoInput!
): DeleteOrganizationHorizontalLogoPayload @session(required: PRESENT) ): DeleteOrganizationHorizontalLogoPayload @authentication(required: PRESENT)
} }
input CreateOrganizationInput { input CreateOrganizationInput {

View File

@@ -5,11 +5,15 @@ type PersonalAPIKey implements Node {
lastUsedAt: Datetime lastUsedAt: Datetime
createdAt: Datetime! createdAt: Datetime!
token: String @goField(forceResolver: true) token: String
@goField(forceResolver: true)
@authentication(required: PRESENT)
@sessionOnly
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
@sessionOnly
} }
type PersonalAPIKeyConnection type PersonalAPIKeyConnection
@@ -29,10 +33,14 @@ type PersonalAPIKeyEdge {
extend type Mutation { extend type Mutation {
createPersonalAPIKey( createPersonalAPIKey(
input: CreatePersonalAPIKeyInput! input: CreatePersonalAPIKeyInput!
): CreatePersonalAPIKeyPayload @session(required: PRESENT) ): CreatePersonalAPIKeyPayload
@authentication(required: PRESENT)
@sessionOnly
revokePersonalAPIKey( revokePersonalAPIKey(
input: RevokePersonalAPIKeyInput! input: RevokePersonalAPIKeyInput!
): RevokePersonalAPIKeyPayload @session(required: PRESENT) ): RevokePersonalAPIKeyPayload
@authentication(required: PRESENT)
@sessionOnly
} }
input CreatePersonalAPIKeyInput { input CreatePersonalAPIKeyInput {

View File

@@ -25,7 +25,7 @@ type Profile implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
enum ProfileState enum ProfileState
@@ -97,13 +97,13 @@ type ProfileEdge {
extend type Mutation { extend type Mutation {
createUser(input: CreateUserInput!): CreateUserPayload createUser(input: CreateUserInput!): CreateUserPayload
@session(required: PRESENT) @authentication(required: PRESENT)
deactivateUser(input: DeactivateUserInput!): DeactivateUserPayload deactivateUser(input: DeactivateUserInput!): DeactivateUserPayload
updateUser(input: UpdateUserInput!): UpdateUserPayload! updateUser(input: UpdateUserInput!): UpdateUserPayload!
archiveUser(input: ArchiveUserInput!): ArchiveUserPayload archiveUser(input: ArchiveUserInput!): ArchiveUserPayload
@session(required: PRESENT) @authentication(required: PRESENT)
removeUser(input: RemoveUserInput!): RemoveUserPayload removeUser(input: RemoveUserInput!): RemoveUserPayload
@session(required: PRESENT) @authentication(required: PRESENT)
} }
input CreateUserInput { input CreateUserInput {

View File

@@ -15,7 +15,7 @@ type SAMLConfiguration implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
type SAMLAttributeMappings { type SAMLAttributeMappings {
@@ -55,13 +55,13 @@ type SAMLConfigurationEdge {
extend type Mutation { extend type Mutation {
createSAMLConfiguration( createSAMLConfiguration(
input: CreateSAMLConfigurationInput! input: CreateSAMLConfigurationInput!
): CreateSAMLConfigurationPayload @session(required: PRESENT) ): CreateSAMLConfigurationPayload @authentication(required: PRESENT) @sessionOnly
updateSAMLConfiguration( updateSAMLConfiguration(
input: UpdateSAMLConfigurationInput! input: UpdateSAMLConfigurationInput!
): UpdateSAMLConfigurationPayload @session(required: PRESENT) ): UpdateSAMLConfigurationPayload @authentication(required: PRESENT) @sessionOnly
deleteSAMLConfiguration( deleteSAMLConfiguration(
input: DeleteSAMLConfigurationInput! input: DeleteSAMLConfigurationInput!
): DeleteSAMLConfigurationPayload @session(required: PRESENT) ): DeleteSAMLConfigurationPayload @authentication(required: PRESENT) @sessionOnly
} }
input CreateSAMLConfigurationInput { input CreateSAMLConfigurationInput {

View File

@@ -17,7 +17,7 @@ type SCIMConfiguration implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
type SCIMBridge implements Node { type SCIMBridge implements Node {
@@ -33,7 +33,7 @@ type SCIMBridge implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
type Connector implements Node { type Connector implements Node {
@@ -44,7 +44,7 @@ type Connector implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
enum ConnectorProvider enum ConnectorProvider
@@ -94,7 +94,7 @@ type SCIMEvent implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
enum SCIMEventOrderField enum SCIMEventOrderField
@@ -130,16 +130,16 @@ type SCIMEventEdge {
extend type Mutation { extend type Mutation {
createSCIMConfiguration( createSCIMConfiguration(
input: CreateSCIMConfigurationInput! input: CreateSCIMConfigurationInput!
): CreateSCIMConfigurationPayload @session(required: PRESENT) ): CreateSCIMConfigurationPayload @authentication(required: PRESENT) @sessionOnly
deleteSCIMConfiguration( deleteSCIMConfiguration(
input: DeleteSCIMConfigurationInput! input: DeleteSCIMConfigurationInput!
): DeleteSCIMConfigurationPayload @session(required: PRESENT) ): DeleteSCIMConfigurationPayload @authentication(required: PRESENT) @sessionOnly
regenerateSCIMToken( regenerateSCIMToken(
input: RegenerateSCIMTokenInput! input: RegenerateSCIMTokenInput!
): RegenerateSCIMTokenPayload @session(required: PRESENT) ): RegenerateSCIMTokenPayload @authentication(required: PRESENT) @sessionOnly
updateSCIMBridge( updateSCIMBridge(
input: UpdateSCIMBridgeInput! input: UpdateSCIMBridgeInput!
): UpdateSCIMBridgePayload @session(required: PRESENT) ): UpdateSCIMBridgePayload @authentication(required: PRESENT)
} }
input CreateSCIMConfigurationInput { input CreateSCIMConfigurationInput {

View File

@@ -5,29 +5,29 @@ enum ReauthenticationReason {
} }
extend type Mutation { extend type Mutation {
signIn(input: SignInInput!): SignInPayload @session(required: OPTIONAL) signIn(input: SignInInput!): SignInPayload @authentication(required: OPTIONAL)
signUp(input: SignUpInput!): SignUpPayload @session(required: NONE) signUp(input: SignUpInput!): SignUpPayload @authentication(required: NONE)
signOut: SignOutPayload @session(required: PRESENT) signOut: SignOutPayload @authentication(required: PRESENT) @sessionOnly
activateAccount( activateAccount(
input: ActivateAccountInput! input: ActivateAccountInput!
): ActivateAccountPayload @session(required: OPTIONAL) ): ActivateAccountPayload @authentication(required: OPTIONAL)
forgotPassword(input: ForgotPasswordInput!): ForgotPasswordPayload forgotPassword(input: ForgotPasswordInput!): ForgotPasswordPayload
@session(required: NONE) @authentication(required: NONE)
resetPassword(input: ResetPasswordInput!): ResetPasswordPayload resetPassword(input: ResetPasswordInput!): ResetPasswordPayload
@session(required: NONE) @authentication(required: NONE)
verifyEmail(input: VerifyEmailInput!): VerifyEmailPayload verifyEmail(input: VerifyEmailInput!): VerifyEmailPayload
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
changePassword(input: ChangePasswordInput!): ChangePasswordPayload changePassword(input: ChangePasswordInput!): ChangePasswordPayload
@session(required: PRESENT) @authentication(required: PRESENT) @sessionOnly
changeEmail(input: ChangeEmailInput!): ChangeEmailPayload changeEmail(input: ChangeEmailInput!): ChangeEmailPayload
@session(required: PRESENT) @authentication(required: PRESENT) @sessionOnly
assumeOrganizationSession( assumeOrganizationSession(
input: AssumeOrganizationSessionInput! input: AssumeOrganizationSessionInput!
): AssumeOrganizationSessionPayload @session(required: PRESENT) ): AssumeOrganizationSessionPayload @authentication(required: PRESENT) @sessionOnly
revokeSession(input: RevokeSessionInput!): RevokeSessionPayload! revokeSession(input: RevokeSessionInput!): RevokeSessionPayload!
@session(required: PRESENT) @authentication(required: PRESENT) @sessionOnly
revokeAllSessions: RevokeAllSessionsPayload @session(required: PRESENT) revokeAllSessions: RevokeAllSessionsPayload @authentication(required: PRESENT) @sessionOnly
} }
enum SessionOrderField enum SessionOrderField
@@ -56,7 +56,7 @@ type Session implements Node {
permission(action: String!): Boolean! permission(action: String!): Boolean!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: PRESENT) @authentication(required: PRESENT)
} }
type SessionConnection type SessionConnection

View File

@@ -25,6 +25,7 @@ import (
"go.probo.inc/probo/pkg/server/api/authz" "go.probo.inc/probo/pkg/server/api/authz"
"go.probo.inc/probo/pkg/server/api/connect/v1/schema" "go.probo.inc/probo/pkg/server/api/connect/v1/schema"
"go.probo.inc/probo/pkg/server/gqlutils" "go.probo.inc/probo/pkg/server/gqlutils"
"go.probo.inc/probo/pkg/server/gqlutils/directives/authentication"
"go.probo.inc/probo/pkg/server/gqlutils/directives/session" "go.probo.inc/probo/pkg/server/gqlutils/directives/session"
) )
@@ -39,7 +40,8 @@ func NewGraphQLHandler(svc *iam.Service, logger *log.Logger, baseURL *baseurl.Ba
sessionCookie: authn.NewCookie(&cookieConfig), sessionCookie: authn.NewCookie(&cookieConfig),
}, },
Directives: schema.DirectiveRoot{ Directives: schema.DirectiveRoot{
Session: session.Directive, Authentication: authentication.Directive,
SessionOnly: session.Directive,
}, },
} }

View File

@@ -1,5 +1,6 @@
schema: schema:
- "graphql/*.graphql" - "graphql/*.graphql"
- "../../../gqlutils/directives/authentication/schema.graphql"
- "../../../gqlutils/directives/session/schema.graphql" - "../../../gqlutils/directives/session/schema.graphql"
exec: exec:

View File

@@ -1,10 +1,10 @@
extend type Mutation { extend type Mutation {
sendMagicLink(input: SendMagicLinkInput!): SendMagicLinkPayload sendMagicLink(input: SendMagicLinkInput!): SendMagicLinkPayload
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
verifyMagicLink(input: VerifyMagicLinkInput!): VerifyMagicLinkPayload verifyMagicLink(input: VerifyMagicLinkInput!): VerifyMagicLinkPayload
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
updateFullName(input: UpdateFullNameInput!): UpdateFullNamePayload updateFullName(input: UpdateFullNameInput!): UpdateFullNamePayload
@session(required: PRESENT) @authentication(required: PRESENT) @sessionOnly
} }
input SendMagicLinkInput { input SendMagicLinkInput {

View File

@@ -27,7 +27,7 @@ type Query {
currentTrustCenter: TrustCenter currentTrustCenter: TrustCenter
oidcProviders: [OIDCProviderInfo!]! oidcProviders: [OIDCProviderInfo!]!
@goField(forceResolver: true) @goField(forceResolver: true)
@session(required: OPTIONAL) @authentication(required: OPTIONAL)
} }
type OIDCProviderInfo { type OIDCProviderInfo {

View File

@@ -42,9 +42,9 @@ type MailingListSubscriber implements Node
} }
extend type Mutation { extend type Mutation {
subscribeToMailingList: SubscribeToMailingListPayload! @session(required: PRESENT) subscribeToMailingList: SubscribeToMailingListPayload! @authentication(required: PRESENT) @sessionOnly
unsubscribeFromMailingList: UnsubscribeFromMailingListPayload! @session(required: PRESENT) unsubscribeFromMailingList: UnsubscribeFromMailingListPayload! @authentication(required: PRESENT) @sessionOnly
} }
type SubscribeToMailingListPayload { type SubscribeToMailingListPayload {

View File

@@ -124,11 +124,11 @@ type ElectronicSignature implements Node {
extend type Mutation { extend type Mutation {
acceptElectronicSignature( acceptElectronicSignature(
input: AcceptElectronicSignatureInput! input: AcceptElectronicSignatureInput!
): AcceptElectronicSignaturePayload @session(required: PRESENT) ): AcceptElectronicSignaturePayload @authentication(required: PRESENT) @sessionOnly
recordSigningEvent( recordSigningEvent(
input: RecordSigningEventInput! input: RecordSigningEventInput!
): RecordSigningEventPayload @session(required: PRESENT) ): RecordSigningEventPayload @authentication(required: PRESENT) @sessionOnly
} }
input AcceptElectronicSignatureInput { input AcceptElectronicSignatureInput {

View File

@@ -346,29 +346,29 @@ type DocumentAccess implements Node {
} }
extend type Mutation { extend type Mutation {
requestAllAccesses: RequestAccessesPayload! @session(required: PRESENT) @nda requestAllAccesses: RequestAccessesPayload! @authentication(required: PRESENT) @nda
exportDocumentPDF(input: ExportDocumentPDFInput!): ExportDocumentPDFPayload! exportDocumentPDF(input: ExportDocumentPDFInput!): ExportDocumentPDFPayload!
@session(required: OPTIONAL) @nda @authentication(required: OPTIONAL) @nda
exportReportPDF(input: ExportReportPDFInput!): ExportReportPDFPayload! exportReportPDF(input: ExportReportPDFInput!): ExportReportPDFPayload!
@session(required: OPTIONAL) @nda @authentication(required: OPTIONAL) @nda
exportTrustCenterFile( exportTrustCenterFile(
input: ExportTrustCenterFileInput! input: ExportTrustCenterFileInput!
): ExportTrustCenterFilePayload! @session(required: OPTIONAL) @nda ): ExportTrustCenterFilePayload! @authentication(required: OPTIONAL) @nda
requestDocumentAccess( requestDocumentAccess(
input: RequestDocumentAccessInput! input: RequestDocumentAccessInput!
): RequestDocumentAccessPayload! @session(required: PRESENT) @nda ): RequestDocumentAccessPayload! @authentication(required: PRESENT) @nda
requestReportAccess( requestReportAccess(
input: RequestReportAccessInput! input: RequestReportAccessInput!
): RequestReportAccessPayload! @session(required: PRESENT) @nda ): RequestReportAccessPayload! @authentication(required: PRESENT) @nda
requestTrustCenterFileAccess( requestTrustCenterFileAccess(
input: RequestTrustCenterFileAccessInput! input: RequestTrustCenterFileAccessInput!
): RequestFileAccessPayload! @session(required: PRESENT) @nda ): RequestFileAccessPayload! @authentication(required: PRESENT) @nda
} }
type RequestDocumentAccessPayload { type RequestDocumentAccessPayload {

View File

@@ -26,6 +26,7 @@ import (
"go.probo.inc/probo/pkg/server/api/authn" "go.probo.inc/probo/pkg/server/api/authn"
"go.probo.inc/probo/pkg/server/api/trust/v1/schema" "go.probo.inc/probo/pkg/server/api/trust/v1/schema"
"go.probo.inc/probo/pkg/server/gqlutils" "go.probo.inc/probo/pkg/server/gqlutils"
"go.probo.inc/probo/pkg/server/gqlutils/directives/authentication"
"go.probo.inc/probo/pkg/server/gqlutils/directives/session" "go.probo.inc/probo/pkg/server/gqlutils/directives/session"
"go.probo.inc/probo/pkg/trust" "go.probo.inc/probo/pkg/trust"
) )
@@ -43,7 +44,8 @@ func NewGraphQLHandler(iamSvc *iam.Service, trustSvc *trust.Service, esignSvc *e
}, },
Directives: schema.DirectiveRoot{ Directives: schema.DirectiveRoot{
Nda: newNDADirective(logger, trustSvc, esignSvc), Nda: newNDADirective(logger, trustSvc, esignSvc),
Session: session.Directive, Authentication: authentication.Directive,
SessionOnly: session.Directive,
}, },
} }

View File

@@ -0,0 +1,112 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package authentication
import (
"bytes"
"context"
"fmt"
"io"
"strconv"
"github.com/99designs/gqlgen/graphql"
"go.probo.inc/probo/pkg/server/api/authn"
"go.probo.inc/probo/pkg/server/gqlutils"
)
type AuthenticationRequirement string
const (
AuthenticationRequirementPresent AuthenticationRequirement = "PRESENT"
AuthenticationRequirementNone AuthenticationRequirement = "NONE"
AuthenticationRequirementOptional AuthenticationRequirement = "OPTIONAL"
)
var AllAuthenticationRequirement = []AuthenticationRequirement{
AuthenticationRequirementPresent,
AuthenticationRequirementNone,
AuthenticationRequirementOptional,
}
func (e AuthenticationRequirement) IsValid() bool {
switch e {
case AuthenticationRequirementPresent, AuthenticationRequirementNone, AuthenticationRequirementOptional:
return true
}
return false
}
func (e AuthenticationRequirement) String() string {
return string(e)
}
func (e *AuthenticationRequirement) UnmarshalGQL(v any) error {
str, ok := v.(string)
if !ok {
return fmt.Errorf("enums must be strings")
}
*e = AuthenticationRequirement(str)
if !e.IsValid() {
return fmt.Errorf("%s is not a valid AuthenticationRequirement", str)
}
return nil
}
func (e AuthenticationRequirement) MarshalGQL(w io.Writer) {
_, _ = fmt.Fprint(w, strconv.Quote(e.String()))
}
func (e *AuthenticationRequirement) UnmarshalJSON(b []byte) error {
s, err := strconv.Unquote(string(b))
if err != nil {
return err
}
return e.UnmarshalGQL(s)
}
func (e AuthenticationRequirement) MarshalJSON() ([]byte, error) {
var buf bytes.Buffer
e.MarshalGQL(&buf)
return buf.Bytes(), nil
}
func Directive(ctx context.Context, obj any, next graphql.Resolver, required AuthenticationRequirement) (any, error) {
identity := authn.IdentityFromContext(ctx)
switch required {
case AuthenticationRequirementOptional:
case AuthenticationRequirementPresent:
if identity == nil {
return nil, gqlutils.Unauthenticatedf(
ctx,
"authentication is required to access this resource",
)
}
case AuthenticationRequirementNone:
if identity != nil {
return nil, gqlutils.AlreadyAuthenticatedf(
ctx,
"authentication not allowed for this resource/action",
)
}
}
return next(ctx)
}

View File

@@ -0,0 +1,39 @@
# Authentication directive for GraphQL APIs
# Include this schema in your gqlgen configuration to enable identity-based
# access control (session OR API key).
#
# Usage in your schema.graphql:
# type Query {
# viewer: User @authentication(required: PRESENT)
# publicData: Data @authentication(required: OPTIONAL)
# signup(input: SignUpInput!): SignUpPayload @authentication(required: NONE)
# }
directive @authentication(required: AuthenticationRequirement!) on FIELD_DEFINITION
enum AuthenticationRequirement
@goModel(
model: "go.probo.inc/probo/pkg/server/gqlutils/directives/authentication.AuthenticationRequirement"
) {
"""
Requires an authenticated identity (session or API key).
"""
PRESENT
@goEnum(
value: "go.probo.inc/probo/pkg/server/gqlutils/directives/authentication.AuthenticationRequirementPresent"
)
"""
Forbids authenticated access (e.g., for login/signup endpoints).
"""
NONE
@goEnum(
value: "go.probo.inc/probo/pkg/server/gqlutils/directives/authentication.AuthenticationRequirementNone"
)
"""
Allows both authenticated and unauthenticated access.
"""
OPTIONAL
@goEnum(
value: "go.probo.inc/probo/pkg/server/gqlutils/directives/authentication.AuthenticationRequirementOptional"
)
}

View File

@@ -1,38 +1,18 @@
# Session directive for GraphQL APIs # sessionOnly directive for GraphQL APIs
# Include this schema in your gqlgen configuration to enable session-based access control. # Include this schema in your gqlgen configuration to restrict a field to
# session authentication.
#
# It is meant to be combined with @authentication(required: PRESENT):
# @authentication enforces that the caller is authenticated, while @sessionOnly
# additionally rejects API key authentication (which carries an identity but no
# session). Use it for sensitive identity self-management (e.g. managing
# personal API keys).
# #
# Usage in your schema.graphql: # Usage in your schema.graphql:
# type Query { # type Mutation {
# viewer: User @session(required: PRESENT) # createPersonalAPIKey(input: CreatePersonalAPIKeyInput!): CreatePersonalAPIKeyPayload
# publicData: Data @session(required: OPTIONAL) # @authentication(required: PRESENT)
# signup(input: SignUpInput!): SignUpPayload @session(required: NONE) # @sessionOnly
# } # }
directive @session(required: SessionRequirement!) on FIELD_DEFINITION directive @sessionOnly on FIELD_DEFINITION
enum SessionRequirement
@goModel(
model: "go.probo.inc/probo/pkg/server/gqlutils/directives/session.SessionRequirement"
) {
"""
Requires an authenticated session or API key.
"""
PRESENT
@goEnum(
value: "go.probo.inc/probo/pkg/server/gqlutils/directives/session.SessionRequirementPresent"
)
"""
Forbids authenticated access (e.g., for login/signup endpoints).
"""
NONE
@goEnum(
value: "go.probo.inc/probo/pkg/server/gqlutils/directives/session.SessionRequirementNone"
)
"""
Allows both authenticated and unauthenticated access.
"""
OPTIONAL
@goEnum(
value: "go.probo.inc/probo/pkg/server/gqlutils/directives/session.SessionRequirementOptional"
)
}

View File

@@ -15,98 +15,24 @@
package session package session
import ( import (
"bytes"
"context" "context"
"fmt"
"io"
"strconv"
"github.com/99designs/gqlgen/graphql" "github.com/99designs/gqlgen/graphql"
"go.probo.inc/probo/pkg/server/api/authn" "go.probo.inc/probo/pkg/server/api/authn"
"go.probo.inc/probo/pkg/server/gqlutils" "go.probo.inc/probo/pkg/server/gqlutils"
) )
type SessionRequirement string // Directive enforces that the request carries a real session. It is meant to
// be combined with @authentication(required: PRESENT): @authentication handles
const ( // the "must be authenticated" check, while @sessionOnly additionally rejects
SessionRequirementPresent SessionRequirement = "PRESENT" // API key authentication, which also carries an identity but no session.
SessionRequirementNone SessionRequirement = "NONE" func Directive(ctx context.Context, obj any, next graphql.Resolver) (any, error) {
SessionRequirementOptional SessionRequirement = "OPTIONAL" if authn.SessionFromContext(ctx) == nil {
) return nil, gqlutils.Forbiddenf(
var AllSessionRequirement = []SessionRequirement{
SessionRequirementPresent,
SessionRequirementNone,
SessionRequirementOptional,
}
func (e SessionRequirement) IsValid() bool {
switch e {
case SessionRequirementPresent, SessionRequirementNone, SessionRequirementOptional:
return true
}
return false
}
func (e SessionRequirement) String() string {
return string(e)
}
func (e *SessionRequirement) UnmarshalGQL(v any) error {
str, ok := v.(string)
if !ok {
return fmt.Errorf("enums must be strings")
}
*e = SessionRequirement(str)
if !e.IsValid() {
return fmt.Errorf("%s is not a valid SessionRequirement", str)
}
return nil
}
func (e SessionRequirement) MarshalGQL(w io.Writer) {
_, _ = fmt.Fprint(w, strconv.Quote(e.String()))
}
func (e *SessionRequirement) UnmarshalJSON(b []byte) error {
s, err := strconv.Unquote(string(b))
if err != nil {
return err
}
return e.UnmarshalGQL(s)
}
func (e SessionRequirement) MarshalJSON() ([]byte, error) {
var buf bytes.Buffer
e.MarshalGQL(&buf)
return buf.Bytes(), nil
}
func Directive(ctx context.Context, obj any, next graphql.Resolver, required SessionRequirement) (any, error) {
identity := authn.IdentityFromContext(ctx)
switch required {
case SessionRequirementOptional:
case SessionRequirementPresent:
if identity == nil {
return nil, gqlutils.Unauthenticatedf(
ctx, ctx,
"authentication is required to access this resource", "this resource can only be accessed with session authentication, not API key authentication",
) )
} }
case SessionRequirementNone:
if identity != nil {
return nil, gqlutils.AlreadyAuthenticatedf(
ctx,
"authentication not allowed for this resource/action",
)
}
}
return next(ctx) return next(ctx)
} }