Skip to content
Draft
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
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ require (
github.com/goccy/go-json v0.10.5 // indirect
github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang-jwt/jwt/v5 v5.3.0 // indirect
github.com/golang-jwt/jwt/v5 v5.3.1 // indirect
github.com/golang/snappy v1.0.0 // indirect
github.com/google/flatbuffers v25.2.10+incompatible // indirect
github.com/google/gnostic-models v0.6.9 // indirect
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
github.com/golang-jwt/jwt/v5 v5.3.0 h1:pv4AsKCKKZuqlgs5sUmn4x8UlGa0kEVt/puTpKx9vvo=
github.com/golang-jwt/jwt/v5 v5.3.0/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE=
github.com/golang-jwt/jwt/v5 v5.3.1 h1:kYf81DTWFe7t+1VvL7eS+jKFVWaUnK9cB1qbwn63YCY=
github.com/golang-jwt/jwt/v5 v5.3.1/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE=
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
github.com/golang/snappy v1.0.0 h1:Oy607GVXHs7RtbggtPBnr2RmDArIsAefDwvrdWvRhGs=
Expand Down
128 changes: 100 additions & 28 deletions internal/pkg/object/command/snowflake/snowflake.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import (
"encoding/pem"
"fmt"
"os"
"time"

"github.com/golang-jwt/jwt/v5"
sf "github.com/snowflakedb/gosnowflake"

heimdallContext "github.com/patterninc/heimdall/pkg/context"
Expand All @@ -21,29 +23,40 @@ import (
const (
privateKeyType = `PRIVATE KEY`
snowflakeDriverName = `snowflake`
oauthTokenTTL = time.Hour
oauthScope = `session:role-any`
)

var (
ErrFailedToDecodePEMBlock = fmt.Errorf(`failed to decode PEM block`)
ErrInvalidKeyType = fmt.Errorf(`invalid key type`)
ErrMissingOAuthConfig = fmt.Errorf(`impersonate_user requires oauth_private_key, oauth_issuer, and oauth_audience`)
ErrMissingJobUser = fmt.Errorf(`impersonate_user is enabled but job has no user identity`)
)

// commandContext represents command-level configuration from the YAML config file.
// Role is defined here for security - users cannot override
type commandContext struct {
Role string `yaml:"role,omitempty" json:"role,omitempty"`
DefaultRole string `yaml:"default_role,omitempty" json:"default_role,omitempty"`
}

type jobContext struct {
Query string `yaml:"query,omitempty" json:"query,omitempty"`
Role string `yaml:"role,omitempty" json:"role,omitempty"`
}

type clusterContext struct {
Account string `yaml:"account,omitempty" json:"account,omitempty"`
User string `yaml:"user,omitempty" json:"user,omitempty"`
Database string `yaml:"database,omitempty" json:"database,omitempty"`
Warehouse string `yaml:"warehouse,omitempty" json:"warehouse,omitempty"`
PrivateKey string `yaml:"private_key,omitempty" json:"private_key,omitempty"`
PrivateKey string `yaml:"private_key,omitempty" json:"private_key,omitempty"`
ImpersonateUser bool `yaml:"impersonate_user,omitempty" json:"impersonate_user,omitempty"`
// OAuthPrivateKey is a path to the PEM-encoded RSA private key used to mint OAuth tokens.
// Only required when impersonate_user is true.
OAuthPrivateKey string `yaml:"oauth_private_key,omitempty" json:"oauth_private_key,omitempty"`
// OAuthIssuer must match the EXTERNAL_OAUTH_ISSUER configured in Snowflake.
OAuthIssuer string `yaml:"oauth_issuer,omitempty" json:"oauth_issuer,omitempty"`
// OAuthAudience is the token audience, typically the Snowflake account URL.
OAuthAudience string `yaml:"oauth_audience,omitempty" json:"oauth_audience,omitempty"`
}

func parsePrivateKey(privateKeyBytes []byte) (*rsa.PrivateKey, error) {
Expand All @@ -70,6 +83,31 @@ func parsePrivateKey(privateKeyBytes []byte) (*rsa.PrivateKey, error) {

}

func (c *clusterContext) mintOAuthToken(username string) (string, error) {
privateKeyBytes, err := os.ReadFile(c.OAuthPrivateKey)
if err != nil {
return "", err
}

privateKey, err := parsePrivateKey(privateKeyBytes)
if err != nil {
return "", err
}

now := time.Now()
claims := jwt.MapClaims{
"sub": username,
"iss": c.OAuthIssuer,
"aud": jwt.ClaimStrings{c.OAuthAudience},
"iat": now.Unix(),
"exp": now.Add(oauthTokenTTL).Unix(),
"scp": oauthScope,
}

token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
return token.SignedString(privateKey)
}

func New(cmdCtx *heimdallContext.Context) (plugin.Handler, error) {
s := &commandContext{}

Expand Down Expand Up @@ -99,31 +137,65 @@ func (s *commandContext) Execute(ctx context.Context, r *plugin.Runtime, j *job.
return err
}

// prepare snowflake config
privateKeyBytes, err := os.ReadFile(clusterContext.PrivateKey)
if err != nil {
return err
}
// build snowflake DSN — either OAuth impersonation or key-pair JWT
var dsn string
if clusterContext.ImpersonateUser {
if clusterContext.OAuthPrivateKey == `` || clusterContext.OAuthIssuer == `` || clusterContext.OAuthAudience == `` {
return ErrMissingOAuthConfig
}
if j.User == `` {
return ErrMissingJobUser
}

// Parse the private key
privateKey, err := parsePrivateKey(privateKeyBytes)
if err != nil {
return err
}
oauthToken, err := clusterContext.mintOAuthToken(j.User)
if err != nil {
return err
}

// s.Role from command context; empty string = Snowflake uses user's default role
dsn, err := sf.DSN(&sf.Config{
Account: clusterContext.Account,
User: clusterContext.User,
Database: clusterContext.Database,
Warehouse: clusterContext.Warehouse,
Role: s.Role,
Authenticator: sf.AuthTypeJwt,
PrivateKey: privateKey,
Application: r.UserAgent,
})
if err != nil {
return err
role := s.DefaultRole
if jobContext.Role != `` {
role = jobContext.Role
}

dsn, err = sf.DSN(&sf.Config{
Account: clusterContext.Account,
User: j.User,
Authenticator: sf.AuthTypeOAuth,
Token: oauthToken,
Application: r.UserAgent,
Database: clusterContext.Database,
Warehouse: clusterContext.Warehouse,
Role: role,
})
if err != nil {
return err
}
} else {
// standard key-pair JWT auth as Heimdall service account
privateKeyBytes, err := os.ReadFile(clusterContext.PrivateKey)
if err != nil {
return err
}

privateKey, err := parsePrivateKey(privateKeyBytes)
if err != nil {
return err
}

// s.DefaultRole from command context; empty string = Snowflake uses user's default role
dsn, err = sf.DSN(&sf.Config{
Account: clusterContext.Account,
User: clusterContext.User,
Database: clusterContext.Database,
Warehouse: clusterContext.Warehouse,
Role: s.DefaultRole,
Authenticator: sf.AuthTypeJwt,
PrivateKey: privateKey,
Application: r.UserAgent,
})
if err != nil {
return err
}
}

// open connection
Expand Down Expand Up @@ -170,7 +242,7 @@ func (s *commandContext) HealthCheck(ctx context.Context, c *cluster.Cluster) er
User: clusterCtx.User,
Database: clusterCtx.Database,
Warehouse: clusterCtx.Warehouse,
Role: s.Role,
Role: s.DefaultRole,
Authenticator: sf.AuthTypeJwt,
PrivateKey: privateKey,
})
Expand Down
Loading