mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-16 12:58:00 +00:00
14e2aba1bc
# Which Problems Are Solved Twilio supports a robust, multi-channel verification service that notably supports multi-region SMS sender numbers required for our use case. Currently, Zitadel does much of the work of the Twilio Verify (eg. localization, code generation, messaging) but doesn't support the pool of sender numbers that Twilio Verify does. # How the Problems Are Solved To support this API, we need to be able to store the Twilio Service ID and send that in a verification request where appropriate: phone number verification and SMS 2FA code paths. This PR does the following: - Adds the ability to use Twilio Verify of standard messaging through Twilio - Adds support for international numbers and more reliable verification messages sent from multiple numbers - Adds a new Twilio configuration option to support Twilio Verify in the admin console - Sends verification SMS messages through Twilio Verify - Implements Twilio Verification Checks for codes generated through the same # Additional Changes # Additional Context - base was implemented by @zhirschtritt in https://github.com/zitadel/zitadel/pull/8268 ❤️ - closes https://github.com/zitadel/zitadel/issues/8581 --------- Co-authored-by: Zachary Hirschtritt <zachary.hirschtritt@klaviyo.com> Co-authored-by: Joey Biscoglia <joey.biscoglia@klaviyo.com>
387 lines
9.8 KiB
Go
387 lines
9.8 KiB
Go
package query
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"errors"
|
|
"time"
|
|
|
|
sq "github.com/Masterminds/squirrel"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
"github.com/zitadel/zitadel/internal/api/call"
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/query/projection"
|
|
"github.com/zitadel/zitadel/internal/telemetry/tracing"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
type SMSConfigs struct {
|
|
SearchResponse
|
|
Configs []*SMSConfig
|
|
}
|
|
|
|
type SMSConfig struct {
|
|
AggregateID string
|
|
ID string
|
|
CreationDate time.Time
|
|
ChangeDate time.Time
|
|
ResourceOwner string
|
|
State domain.SMSConfigState
|
|
Sequence uint64
|
|
Description string
|
|
|
|
TwilioConfig *Twilio
|
|
HTTPConfig *HTTP
|
|
}
|
|
|
|
type Twilio struct {
|
|
SID string
|
|
Token *crypto.CryptoValue
|
|
SenderNumber string
|
|
VerifyServiceSID string
|
|
}
|
|
|
|
type HTTP struct {
|
|
Endpoint string
|
|
}
|
|
|
|
type SMSConfigsSearchQueries struct {
|
|
SearchRequest
|
|
Queries []SearchQuery
|
|
}
|
|
|
|
func (q *SMSConfigsSearchQueries) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
|
|
query = q.SearchRequest.toQuery(query)
|
|
for _, q := range q.Queries {
|
|
query = q.toQuery(query)
|
|
}
|
|
return query
|
|
}
|
|
|
|
var (
|
|
smsConfigsTable = table{
|
|
name: projection.SMSConfigProjectionTable,
|
|
instanceIDCol: projection.SMSColumnInstanceID,
|
|
}
|
|
SMSColumnID = Column{
|
|
name: projection.SMSColumnID,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnAggregateID = Column{
|
|
name: projection.SMSColumnAggregateID,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnCreationDate = Column{
|
|
name: projection.SMSColumnCreationDate,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnChangeDate = Column{
|
|
name: projection.SMSColumnChangeDate,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnResourceOwner = Column{
|
|
name: projection.SMSColumnResourceOwner,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnInstanceID = Column{
|
|
name: projection.SMSColumnInstanceID,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnState = Column{
|
|
name: projection.SMSColumnState,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnSequence = Column{
|
|
name: projection.SMSColumnSequence,
|
|
table: smsConfigsTable,
|
|
}
|
|
SMSColumnDescription = Column{
|
|
name: projection.SMSColumnDescription,
|
|
table: smsConfigsTable,
|
|
}
|
|
)
|
|
|
|
var (
|
|
smsTwilioTable = table{
|
|
name: projection.SMSTwilioTable,
|
|
instanceIDCol: projection.SMSTwilioColumnInstanceID,
|
|
}
|
|
SMSTwilioColumnSMSID = Column{
|
|
name: projection.SMSTwilioColumnSMSID,
|
|
table: smsTwilioTable,
|
|
}
|
|
SMSTwilioColumnSID = Column{
|
|
name: projection.SMSTwilioColumnSID,
|
|
table: smsTwilioTable,
|
|
}
|
|
SMSTwilioColumnToken = Column{
|
|
name: projection.SMSTwilioColumnToken,
|
|
table: smsTwilioTable,
|
|
}
|
|
SMSTwilioColumnSenderNumber = Column{
|
|
name: projection.SMSTwilioColumnSenderNumber,
|
|
table: smsTwilioTable,
|
|
}
|
|
SMSTwilioColumnVerifyServiceSID = Column{
|
|
name: projection.SMSTwilioColumnVerifyServiceSID,
|
|
table: smsTwilioTable,
|
|
}
|
|
)
|
|
|
|
var (
|
|
smsHTTPTable = table{
|
|
name: projection.SMSHTTPTable,
|
|
instanceIDCol: projection.SMSHTTPColumnInstanceID,
|
|
}
|
|
SMSHTTPColumnSMSID = Column{
|
|
name: projection.SMSHTTPColumnSMSID,
|
|
table: smsHTTPTable,
|
|
}
|
|
SMSHTTPColumnEndpoint = Column{
|
|
name: projection.SMSHTTPColumnEndpoint,
|
|
table: smsHTTPTable,
|
|
}
|
|
)
|
|
|
|
func (q *Queries) SMSProviderConfigByID(ctx context.Context, id string) (config *SMSConfig, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer func() { span.EndWithError(err) }()
|
|
|
|
query, scan := prepareSMSConfigQuery(ctx, q.client)
|
|
stmt, args, err := query.Where(
|
|
sq.Eq{
|
|
SMSColumnID.identifier(): id,
|
|
SMSColumnInstanceID.identifier(): authz.GetInstance(ctx).InstanceID(),
|
|
},
|
|
).ToSql()
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "QUERY-dn9JW", "Errors.Query.SQLStatement")
|
|
}
|
|
|
|
err = q.client.QueryRowContext(ctx, func(row *sql.Row) error {
|
|
config, err = scan(row)
|
|
return err
|
|
}, stmt, args...)
|
|
return config, err
|
|
}
|
|
|
|
func (q *Queries) SMSProviderConfigActive(ctx context.Context, instanceID string) (config *SMSConfig, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer func() { span.EndWithError(err) }()
|
|
|
|
query, scan := prepareSMSConfigQuery(ctx, q.client)
|
|
stmt, args, err := query.Where(
|
|
sq.Eq{
|
|
SMSColumnInstanceID.identifier(): instanceID,
|
|
SMSColumnState.identifier(): domain.SMSConfigStateActive,
|
|
},
|
|
).ToSql()
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "QUERY-dn9JW", "Errors.Query.SQLStatement")
|
|
}
|
|
|
|
err = q.client.QueryRowContext(ctx, func(row *sql.Row) error {
|
|
config, err = scan(row)
|
|
return err
|
|
}, stmt, args...)
|
|
return config, err
|
|
}
|
|
|
|
func (q *Queries) SearchSMSConfigs(ctx context.Context, queries *SMSConfigsSearchQueries) (configs *SMSConfigs, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer func() { span.EndWithError(err) }()
|
|
|
|
query, scan := prepareSMSConfigsQuery(ctx, q.client)
|
|
stmt, args, err := queries.toQuery(query).
|
|
Where(sq.Eq{
|
|
SMSColumnInstanceID.identifier(): authz.GetInstance(ctx).InstanceID(),
|
|
}).ToSql()
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInvalidArgument(err, "QUERY-sn9Jf", "Errors.Query.InvalidRequest")
|
|
}
|
|
|
|
err = q.client.QueryContext(ctx, func(rows *sql.Rows) error {
|
|
configs, err = scan(rows)
|
|
return err
|
|
}, stmt, args...)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "QUERY-aJnZL", "Errors.Internal")
|
|
}
|
|
configs.State, err = q.latestState(ctx, smsConfigsTable)
|
|
return configs, err
|
|
}
|
|
|
|
func NewSMSProviderStateQuery(state domain.SMSConfigState) (SearchQuery, error) {
|
|
return NewNumberQuery(SMSColumnState, state, NumberEquals)
|
|
}
|
|
|
|
func prepareSMSConfigQuery(ctx context.Context, db prepareDatabase) (sq.SelectBuilder, func(*sql.Row) (*SMSConfig, error)) {
|
|
return sq.Select(
|
|
SMSColumnID.identifier(),
|
|
SMSColumnAggregateID.identifier(),
|
|
SMSColumnCreationDate.identifier(),
|
|
SMSColumnChangeDate.identifier(),
|
|
SMSColumnResourceOwner.identifier(),
|
|
SMSColumnState.identifier(),
|
|
SMSColumnSequence.identifier(),
|
|
SMSColumnDescription.identifier(),
|
|
|
|
SMSTwilioColumnSMSID.identifier(),
|
|
SMSTwilioColumnSID.identifier(),
|
|
SMSTwilioColumnToken.identifier(),
|
|
SMSTwilioColumnSenderNumber.identifier(),
|
|
SMSTwilioColumnVerifyServiceSID.identifier(),
|
|
|
|
SMSHTTPColumnSMSID.identifier(),
|
|
SMSHTTPColumnEndpoint.identifier(),
|
|
).From(smsConfigsTable.identifier()).
|
|
LeftJoin(join(SMSTwilioColumnSMSID, SMSColumnID)).
|
|
LeftJoin(join(SMSHTTPColumnSMSID, SMSColumnID) + db.Timetravel(call.Took(ctx))).
|
|
PlaceholderFormat(sq.Dollar), func(row *sql.Row) (*SMSConfig, error) {
|
|
config := new(SMSConfig)
|
|
|
|
var (
|
|
twilioConfig = sqlTwilioConfig{}
|
|
httpConfig = sqlHTTPConfig{}
|
|
)
|
|
|
|
err := row.Scan(
|
|
&config.ID,
|
|
&config.AggregateID,
|
|
&config.CreationDate,
|
|
&config.ChangeDate,
|
|
&config.ResourceOwner,
|
|
&config.State,
|
|
&config.Sequence,
|
|
&config.Description,
|
|
|
|
&twilioConfig.smsID,
|
|
&twilioConfig.sid,
|
|
&twilioConfig.token,
|
|
&twilioConfig.senderNumber,
|
|
&twilioConfig.verifyServiceSid,
|
|
|
|
&httpConfig.id,
|
|
&httpConfig.endpoint,
|
|
)
|
|
|
|
if err != nil {
|
|
if errors.Is(err, sql.ErrNoRows) {
|
|
return nil, zerrors.ThrowNotFound(err, "QUERY-fn99w", "Errors.SMSConfig.NotExisting")
|
|
}
|
|
return nil, zerrors.ThrowInternal(err, "QUERY-3n9Js", "Errors.Internal")
|
|
}
|
|
|
|
twilioConfig.set(config)
|
|
httpConfig.setSMS(config)
|
|
|
|
return config, nil
|
|
}
|
|
}
|
|
|
|
func prepareSMSConfigsQuery(ctx context.Context, db prepareDatabase) (sq.SelectBuilder, func(*sql.Rows) (*SMSConfigs, error)) {
|
|
return sq.Select(
|
|
SMSColumnID.identifier(),
|
|
SMSColumnAggregateID.identifier(),
|
|
SMSColumnCreationDate.identifier(),
|
|
SMSColumnChangeDate.identifier(),
|
|
SMSColumnResourceOwner.identifier(),
|
|
SMSColumnState.identifier(),
|
|
SMSColumnSequence.identifier(),
|
|
SMSColumnDescription.identifier(),
|
|
|
|
SMSTwilioColumnSMSID.identifier(),
|
|
SMSTwilioColumnSID.identifier(),
|
|
SMSTwilioColumnToken.identifier(),
|
|
SMSTwilioColumnSenderNumber.identifier(),
|
|
SMSTwilioColumnVerifyServiceSID.identifier(),
|
|
|
|
SMSHTTPColumnSMSID.identifier(),
|
|
SMSHTTPColumnEndpoint.identifier(),
|
|
|
|
countColumn.identifier(),
|
|
).From(smsConfigsTable.identifier()).
|
|
LeftJoin(join(SMSTwilioColumnSMSID, SMSColumnID)).
|
|
LeftJoin(join(SMSHTTPColumnSMSID, SMSColumnID) + db.Timetravel(call.Took(ctx))).
|
|
PlaceholderFormat(sq.Dollar), func(row *sql.Rows) (*SMSConfigs, error) {
|
|
configs := &SMSConfigs{Configs: []*SMSConfig{}}
|
|
|
|
for row.Next() {
|
|
config := new(SMSConfig)
|
|
var (
|
|
twilioConfig = sqlTwilioConfig{}
|
|
httpConfig = sqlHTTPConfig{}
|
|
)
|
|
|
|
err := row.Scan(
|
|
&config.ID,
|
|
&config.AggregateID,
|
|
&config.CreationDate,
|
|
&config.ChangeDate,
|
|
&config.ResourceOwner,
|
|
&config.State,
|
|
&config.Sequence,
|
|
&config.Description,
|
|
|
|
&twilioConfig.smsID,
|
|
&twilioConfig.sid,
|
|
&twilioConfig.token,
|
|
&twilioConfig.senderNumber,
|
|
&twilioConfig.verifyServiceSid,
|
|
|
|
&httpConfig.id,
|
|
&httpConfig.endpoint,
|
|
|
|
&configs.Count,
|
|
)
|
|
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "QUERY-d9jJd", "Errors.Internal")
|
|
}
|
|
|
|
twilioConfig.set(config)
|
|
httpConfig.setSMS(config)
|
|
|
|
configs.Configs = append(configs.Configs, config)
|
|
}
|
|
|
|
return configs, nil
|
|
}
|
|
}
|
|
|
|
type sqlTwilioConfig struct {
|
|
smsID sql.NullString
|
|
sid sql.NullString
|
|
token *crypto.CryptoValue
|
|
senderNumber sql.NullString
|
|
verifyServiceSid sql.NullString
|
|
}
|
|
|
|
func (c sqlTwilioConfig) set(smsConfig *SMSConfig) {
|
|
if !c.smsID.Valid {
|
|
return
|
|
}
|
|
smsConfig.TwilioConfig = &Twilio{
|
|
SID: c.sid.String,
|
|
Token: c.token,
|
|
SenderNumber: c.senderNumber.String,
|
|
VerifyServiceSID: c.verifyServiceSid.String,
|
|
}
|
|
}
|
|
|
|
type sqlHTTPConfig struct {
|
|
id sql.NullString
|
|
endpoint sql.NullString
|
|
}
|
|
|
|
func (c sqlHTTPConfig) setSMS(smsConfig *SMSConfig) {
|
|
if !c.id.Valid {
|
|
return
|
|
}
|
|
smsConfig.HTTPConfig = &HTTP{
|
|
Endpoint: c.endpoint.String,
|
|
}
|
|
}
|