Files
probo/pkg/connector/connector.go
Émile Ré 9156d6a16a Add wsl linter and fix
Signed-off-by: Émile Ré <emile@probo.com>
2026-05-20 09:27:28 +04:00

96 lines
2.9 KiB
Go

// Copyright (c) 2025-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 connector
import (
"context"
"encoding/json"
"fmt"
"net/http"
"go.probo.inc/probo/pkg/gid"
)
type (
ProtocolType string
// InitiateOptions holds per-call options passed by the caller initiating
// a connector flow. Different callers may need different configurations
// for the same provider — for OAuth2, the most common case is requesting
// a different set of scopes (e.g. SCIM bridge vs access review).
InitiateOptions struct {
Scopes []string
// IncludeGrantedScopes is honored only when the provider has
// SupportsIncrementalAuth=true.
IncludeGrantedScopes bool
// ConnectorID, when set, marks this flow as a reconnect of an
// existing connector: the callback updates the row in place
// instead of creating a new one.
ConnectorID string
}
Connector interface {
Initiate(ctx context.Context, provider string, organizationID gid.GID, opts InitiateOptions, r *http.Request) (string, error)
Complete(ctx context.Context, r *http.Request) (Connection, *gid.GID, string, error) // returns: connection, organizationID, continueURL, error
}
Connection interface {
Type() ProtocolType
Client(ctx context.Context) (*http.Client, error)
Scopes() []string
json.Unmarshaler
json.Marshaler
}
)
const (
ProtocolOAuth2 ProtocolType = "OAUTH2"
ProtocolAPIKey ProtocolType = "API_KEY"
)
func UnmarshalConnection(protocol string, provider string, data []byte) (Connection, error) {
switch protocol {
case string(ProtocolOAuth2):
switch provider {
case SlackProvider:
var slackConn SlackConnection
if err := json.Unmarshal(data, &slackConn); err != nil {
return nil, fmt.Errorf("cannot unmarshal slack connection: %w", err)
}
return &slackConn, nil
default:
var conn OAuth2Connection
if err := json.Unmarshal(data, &conn); err != nil {
return nil, fmt.Errorf("cannot unmarshal oauth2 connection: %w", err)
}
return &conn, nil
}
case string(ProtocolAPIKey):
var conn APIKeyConnection
if err := json.Unmarshal(data, &conn); err != nil {
return nil, fmt.Errorf("cannot unmarshal api key connection: %w", err)
}
return &conn, nil
}
return nil, fmt.Errorf("unknown connection protocol: %s", protocol)
}