Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add Api Authentication security integration to sdk #2840

Merged
merged 7 commits into from
May 29, 2024
Merged

feat: Add Api Authentication security integration to sdk #2840

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
89618ac
Implement api auth security integration
sfc-gh-jmichalak May 28, 2024
c0e0dfe
Fix
sfc-gh-jmichalak May 28, 2024
25cf0a8
Fix
sfc-gh-jmichalak May 28, 2024
084fb2d
Merge remote-tracking branch 'origin/main' into jmichalak-security-in…
sfc-gh-jmichalak May 29, 2024
d27d319
Rename
sfc-gh-jmichalak May 29, 2024
bf63d0f
Fixes
sfc-gh-jmichalak May 29, 2024
ddc0d9c
Merge remote-tracking branch 'origin/main' into jmichalak-security-in…
sfc-gh-jmichalak May 29, 2024
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
4 changes: 4 additions & 0 deletions pkg/sdk/poc/generator/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ func wrapWith(s string, with string) string {
func sqlToFieldName(sql string, shouldExport bool) string {
sqlWords := splitSQLPattern.Split(sql, -1)
for i, s := range sqlWords {
if s == "=" {
sqlWords[i] = ""
continue
}
if !shouldExport && i == 0 {
sqlWords[i] = englishLowerCaser.String(s)
continue
Expand Down
189 changes: 189 additions & 0 deletions pkg/sdk/security_integrations_def.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ import g "github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk/poc/gen

//go:generate go run ./poc/main.go

type ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption string

const (
ApiAuthenticationSecurityIntegrationOauthClientAuthMethodClientSecretPost ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption = "CLIENT_SECRET_POST"
)

type ExternalOauthSecurityIntegrationTypeOption string

const (
Expand Down Expand Up @@ -67,6 +73,7 @@ const (
)

var (
allowedScopeDef = g.NewQueryStruct("AllowedScope").Text("Scope", g.KeywordOptions().SingleQuotes().Required())
userDomainDef = g.NewQueryStruct("UserDomain").Text("Domain", g.KeywordOptions().SingleQuotes().Required())
emailPatternDef = g.NewQueryStruct("EmailPattern").Text("Pattern", g.KeywordOptions().SingleQuotes().Required())
preAuthorizedRolesListDef = g.NewQueryStruct("PreAuthorizedRolesList").
Expand Down Expand Up @@ -109,6 +116,75 @@ func alterSecurityIntegrationOperation(structName string, opts func(qs *g.QueryS
return qs
}

var apiAuthClientCredentialsFlowIntegrationSetDef = g.NewQueryStruct("ApiAuthenticationWithClientCredentialsFlowIntegrationSet").
OptionalBooleanAssignment("ENABLED", g.ParameterOptions()).
OptionalTextAssignment("OAUTH_TOKEN_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalAssignment(
"OAUTH_CLIENT_AUTH_METHOD",
g.KindOfT[ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption](),
g.ParameterOptions(),
).
OptionalTextAssignment("OAUTH_CLIENT_ID", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_CLIENT_SECRET", g.ParameterOptions().SingleQuotes()).
OptionalSQL("OAUTH_GRANT = CLIENT_CREDENTIALS").
OptionalNumberAssignment("OAUTH_ACCESS_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalNumberAssignment("OAUTH_REFRESH_TOKEN_VALIDITY", g.ParameterOptions()).
sfc-gh-asawicki marked this conversation as resolved.
Show resolved Hide resolved
ListAssignment("OAUTH_ALLOWED_SCOPES", "AllowedScope", g.ParameterOptions().Parentheses()).
OptionalComment().
WithValidation(g.AtLeastOneValueSet, "Enabled", "OauthTokenEndpoint", "OauthClientAuthMethod", "OauthClientId", "OauthClientSecret", "OauthGrantClientCredentials",
"OauthAccessTokenValidity", "OauthRefreshTokenValidity", "OauthAllowedScopes", "Comment")

var apiAuthClientCredentialsFlowIntegrationUnsetDef = g.NewQueryStruct("ApiAuthenticationWithClientCredentialsFlowIntegrationUnset").
OptionalSQL("ENABLED").
OptionalSQL("COMMENT").
WithValidation(g.AtLeastOneValueSet, "Enabled", "Comment")

var apiAuthCodeGrantFlowIntegrationSetDef = g.NewQueryStruct("ApiAuthenticationWithAuthorizationCodeGrantFlowIntegrationSet").
OptionalBooleanAssignment("ENABLED", g.ParameterOptions()).
OptionalTextAssignment("OAUTH_AUTHORIZATION_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_TOKEN_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalAssignment(
"OAUTH_CLIENT_AUTH_METHOD",
g.KindOfT[ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption](),
g.ParameterOptions(),
).
OptionalTextAssignment("OAUTH_CLIENT_ID", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_CLIENT_SECRET", g.ParameterOptions().SingleQuotes()).
OptionalSQL("OAUTH_GRANT = AUTHORIZATION_CODE").
OptionalNumberAssignment("OAUTH_ACCESS_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalNumberAssignment("OAUTH_REFRESH_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalComment().
WithValidation(g.AtLeastOneValueSet, "Enabled", "OauthAuthorizationEndpoint", "OauthTokenEndpoint", "OauthClientAuthMethod", "OauthClientId", "OauthClientSecret", "OauthGrantAuthorizationCode",
"OauthAccessTokenValidity", "OauthRefreshTokenValidity", "Comment")

var apiAuthCodeGrantFlowIntegrationUnsetDef = g.NewQueryStruct("ApiAuthenticationWithAuthorizationCodeGrantFlowIntegrationUnset").
OptionalSQL("ENABLED").
OptionalSQL("COMMENT").
WithValidation(g.AtLeastOneValueSet, "Enabled", "Comment")

var apiAuthJwtBearerFlowIntegrationSetDef = g.NewQueryStruct("ApiAuthenticationWithJwtBearerFlowIntegrationSet").
OptionalBooleanAssignment("ENABLED", g.ParameterOptions()).
OptionalTextAssignment("OAUTH_AUTHORIZATION_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_TOKEN_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalAssignment(
"OAUTH_CLIENT_AUTH_METHOD",
g.KindOfT[ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption](),
g.ParameterOptions(),
).
OptionalTextAssignment("OAUTH_CLIENT_ID", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_CLIENT_SECRET", g.ParameterOptions().SingleQuotes()).
OptionalSQL("OAUTH_GRANT = JWT_BEARER").
OptionalNumberAssignment("OAUTH_ACCESS_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalNumberAssignment("OAUTH_REFRESH_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalComment().
WithValidation(g.AtLeastOneValueSet, "Enabled", "OauthAuthorizationEndpoint", "OauthTokenEndpoint", "OauthClientAuthMethod", "OauthClientId", "OauthClientSecret", "OauthGrantJwtBearer",
"OauthAccessTokenValidity", "OauthRefreshTokenValidity", "Comment")

var apiAuthJwtBearerFlowIntegrationUnsetDef = g.NewQueryStruct("ApiAuthenticationWithJwtBearerFlowIntegrationUnset").
OptionalSQL("ENABLED").
OptionalSQL("COMMENT").
WithValidation(g.AtLeastOneValueSet, "Enabled", "Comment")
sfc-gh-asawicki marked this conversation as resolved.
Show resolved Hide resolved

var externalOauthIntegrationSetDef = g.NewQueryStruct("ExternalOauthIntegrationSet").
OptionalBooleanAssignment("ENABLED", g.ParameterOptions()).
OptionalAssignment(
Expand Down Expand Up @@ -246,6 +322,74 @@ var SecurityIntegrationsDef = g.NewInterface(
"SecurityIntegration",
g.KindOfT[AccountObjectIdentifier](),
).
CustomOperation(
"CreateApiAuthenticationWithClientCredentialsFlow",
"https://docs.snowflake.com/en/sql-reference/sql/create-security-integration-api-auth",
createSecurityIntegrationOperation("CreateApiAuthenticationWithClientCredentialsFlow", func(qs *g.QueryStruct) *g.QueryStruct {
return qs.
PredefinedQueryStructField("integrationType", "string", g.StaticOptions().SQL("TYPE = API_AUTHENTICATION")).
PredefinedQueryStructField("authType", "string", g.StaticOptions().SQL("AUTH_TYPE = OAUTH2")).
BooleanAssignment("ENABLED", g.ParameterOptions().Required()).
OptionalTextAssignment("OAUTH_TOKEN_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalAssignment(
"OAUTH_CLIENT_AUTH_METHOD",
g.KindOfT[ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption](),
g.ParameterOptions(),
).
TextAssignment("OAUTH_CLIENT_ID", g.ParameterOptions().Required().SingleQuotes()).
TextAssignment("OAUTH_CLIENT_SECRET", g.ParameterOptions().Required().SingleQuotes()).
OptionalSQL("OAUTH_GRANT = CLIENT_CREDENTIALS").
OptionalNumberAssignment("OAUTH_ACCESS_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalNumberAssignment("OAUTH_REFRESH_TOKEN_VALIDITY", g.ParameterOptions()).
sfc-gh-jcieslak marked this conversation as resolved.
Show resolved Hide resolved
ListAssignment("OAUTH_ALLOWED_SCOPES", "AllowedScope", g.ParameterOptions().Parentheses())
}),
allowedScopeDef,
).
CustomOperation(
"CreateApiAuthenticationWithAuthorizationCodeGrantFlow",
"https://docs.snowflake.com/en/sql-reference/sql/create-security-integration-api-auth",
createSecurityIntegrationOperation("CreateApiAuthenticationWithAuthorizationCodeGrantFlow", func(qs *g.QueryStruct) *g.QueryStruct {
return qs.
PredefinedQueryStructField("integrationType", "string", g.StaticOptions().SQL("TYPE = API_AUTHENTICATION")).
PredefinedQueryStructField("authType", "string", g.StaticOptions().SQL("AUTH_TYPE = OAUTH2")).
BooleanAssignment("ENABLED", g.ParameterOptions().Required()).
OptionalTextAssignment("OAUTH_AUTHORIZATION_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_TOKEN_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalAssignment(
sfc-gh-jcieslak marked this conversation as resolved.
Show resolved Hide resolved
"OAUTH_CLIENT_AUTH_METHOD",
g.KindOfT[ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption](),
g.ParameterOptions(),
).
TextAssignment("OAUTH_CLIENT_ID", g.ParameterOptions().Required().SingleQuotes()).
TextAssignment("OAUTH_CLIENT_SECRET", g.ParameterOptions().Required().SingleQuotes()).
OptionalSQL("OAUTH_GRANT = AUTHORIZATION_CODE").
OptionalNumberAssignment("OAUTH_ACCESS_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalNumberAssignment("OAUTH_REFRESH_TOKEN_VALIDITY", g.ParameterOptions())
}),
).
CustomOperation(
"CreateApiAuthenticationWithJwtBearerFlow",
"https://docs.snowflake.com/en/sql-reference/sql/create-security-integration-api-auth",
createSecurityIntegrationOperation("CreateApiAuthenticationWithJwtBearerFlow", func(qs *g.QueryStruct) *g.QueryStruct {
return qs.
PredefinedQueryStructField("integrationType", "string", g.StaticOptions().SQL("TYPE = API_AUTHENTICATION")).
PredefinedQueryStructField("authType", "string", g.StaticOptions().SQL("AUTH_TYPE = OAUTH2")).
BooleanAssignment("ENABLED", g.ParameterOptions().Required()).
TextAssignment("OAUTH_ASSERTION_ISSUER", g.ParameterOptions().Required().SingleQuotes()).
sfc-gh-jcieslak marked this conversation as resolved.
Show resolved Hide resolved
OptionalTextAssignment("OAUTH_AUTHORIZATION_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("OAUTH_TOKEN_ENDPOINT", g.ParameterOptions().SingleQuotes()).
OptionalAssignment(
"OAUTH_CLIENT_AUTH_METHOD",
g.KindOfT[ApiAuthenticationSecurityIntegrationOauthClientAuthMethodOption](),
g.ParameterOptions(),
).
TextAssignment("OAUTH_CLIENT_ID", g.ParameterOptions().Required().SingleQuotes()).
TextAssignment("OAUTH_CLIENT_SECRET", g.ParameterOptions().Required().SingleQuotes()).
OptionalSQL("OAUTH_GRANT = JWT_BEARER").
OptionalNumberAssignment("OAUTH_ACCESS_TOKEN_VALIDITY", g.ParameterOptions()).
OptionalNumberAssignment("OAUTH_REFRESH_TOKEN_VALIDITY", g.ParameterOptions())
}),
).
CustomOperation(
"CreateExternalOauth",
"https://docs.snowflake.com/en/sql-reference/sql/create-security-integration-oauth-external",
Expand Down Expand Up @@ -391,6 +535,51 @@ var SecurityIntegrationsDef = g.NewInterface(
OptionalBooleanAssignment("SYNC_PASSWORD", g.ParameterOptions())
}),
).
CustomOperation(
"AlterApiAuthenticationWithClientCredentialsFlow",
"https://docs.snowflake.com/en/sql-reference/sql/alter-security-integration-api-auth",
alterSecurityIntegrationOperation("AlterApiAuthenticationWithClientCredentialsFlow", func(qs *g.QueryStruct) *g.QueryStruct {
return qs.OptionalQueryStructField(
"Set",
apiAuthClientCredentialsFlowIntegrationSetDef,
g.ListOptions().NoParentheses().SQL("SET"),
).OptionalQueryStructField(
"Unset",
apiAuthClientCredentialsFlowIntegrationUnsetDef,
g.ListOptions().NoParentheses().SQL("UNSET"),
).WithValidation(g.ExactlyOneValueSet, "Set", "Unset", "SetTags", "UnsetTags")
}),
).
CustomOperation(
"AlterApiAuthenticationWithAuthorizationCodeGrantFlow",
"https://docs.snowflake.com/en/sql-reference/sql/alter-security-integration-api-auth",
alterSecurityIntegrationOperation("AlterApiAuthenticationWithAuthorizationCodeGrantFlow", func(qs *g.QueryStruct) *g.QueryStruct {
return qs.OptionalQueryStructField(
"Set",
apiAuthCodeGrantFlowIntegrationSetDef,
g.ListOptions().NoParentheses().SQL("SET"),
).OptionalQueryStructField(
"Unset",
apiAuthCodeGrantFlowIntegrationUnsetDef,
g.ListOptions().NoParentheses().SQL("UNSET"),
).WithValidation(g.ExactlyOneValueSet, "Set", "Unset", "SetTags", "UnsetTags")
}),
).
CustomOperation(
"AlterApiAuthenticationWithJwtBearerFlow",
"https://docs.snowflake.com/en/sql-reference/sql/alter-security-integration-api-auth",
alterSecurityIntegrationOperation("AlterApiAuthenticationWithJwtBearerFlow", func(qs *g.QueryStruct) *g.QueryStruct {
return qs.OptionalQueryStructField(
"Set",
apiAuthJwtBearerFlowIntegrationSetDef,
g.ListOptions().NoParentheses().SQL("SET"),
).OptionalQueryStructField(
"Unset",
apiAuthJwtBearerFlowIntegrationUnsetDef,
g.ListOptions().NoParentheses().SQL("UNSET"),
).WithValidation(g.ExactlyOneValueSet, "Set", "Unset", "SetTags", "UnsetTags")
}),
).
CustomOperation(
"AlterExternalOauth",
"https://docs.snowflake.com/en/sql-reference/sql/alter-security-integration-oauth-external",
Expand Down
Loading
Loading