mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-13 19:44:21 +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>
121 lines
3.3 KiB
Go
121 lines
3.3 KiB
Go
package command
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/repository/user"
|
|
)
|
|
|
|
type HumanPhoneWriteModel struct {
|
|
eventstore.WriteModel
|
|
|
|
Phone domain.PhoneNumber
|
|
IsPhoneVerified bool
|
|
|
|
Code *crypto.CryptoValue
|
|
CodeCreationDate time.Time
|
|
CodeExpiry time.Duration
|
|
GeneratorID string
|
|
VerificationID string
|
|
|
|
State domain.PhoneState
|
|
UserState domain.UserState
|
|
}
|
|
|
|
func NewHumanPhoneWriteModel(userID, resourceOwner string) *HumanPhoneWriteModel {
|
|
return &HumanPhoneWriteModel{
|
|
WriteModel: eventstore.WriteModel{
|
|
AggregateID: userID,
|
|
ResourceOwner: resourceOwner,
|
|
},
|
|
}
|
|
}
|
|
|
|
func (wm *HumanPhoneWriteModel) Reduce() error {
|
|
for _, event := range wm.Events {
|
|
switch e := event.(type) {
|
|
case *user.HumanAddedEvent:
|
|
if e.PhoneNumber != "" {
|
|
wm.Phone = e.PhoneNumber
|
|
wm.State = domain.PhoneStateActive
|
|
}
|
|
wm.UserState = domain.UserStateActive
|
|
case *user.HumanRegisteredEvent:
|
|
if e.PhoneNumber != "" {
|
|
wm.Phone = e.PhoneNumber
|
|
wm.State = domain.PhoneStateActive
|
|
}
|
|
wm.UserState = domain.UserStateActive
|
|
case *user.HumanInitialCodeAddedEvent:
|
|
wm.UserState = domain.UserStateInitial
|
|
case *user.HumanInitializedCheckSucceededEvent:
|
|
wm.UserState = domain.UserStateActive
|
|
case *user.HumanPhoneChangedEvent:
|
|
wm.Phone = e.PhoneNumber
|
|
wm.IsPhoneVerified = false
|
|
wm.State = domain.PhoneStateActive
|
|
wm.Code = nil
|
|
case *user.HumanPhoneVerifiedEvent:
|
|
wm.IsPhoneVerified = true
|
|
wm.Code = nil
|
|
case *user.HumanPhoneCodeAddedEvent:
|
|
wm.Code = e.Code
|
|
wm.CodeCreationDate = e.CreationDate()
|
|
wm.CodeExpiry = e.Expiry
|
|
wm.GeneratorID = e.GeneratorID
|
|
case *user.HumanPhoneCodeSentEvent:
|
|
wm.GeneratorID = e.GeneratorInfo.GetID()
|
|
wm.VerificationID = e.GeneratorInfo.GetVerificationID()
|
|
case *user.HumanPhoneRemovedEvent:
|
|
wm.State = domain.PhoneStateRemoved
|
|
wm.IsPhoneVerified = false
|
|
wm.Phone = ""
|
|
case *user.UserRemovedEvent:
|
|
wm.UserState = domain.UserStateDeleted
|
|
wm.IsPhoneVerified = false
|
|
wm.Phone = ""
|
|
}
|
|
}
|
|
return wm.WriteModel.Reduce()
|
|
}
|
|
|
|
func (wm *HumanPhoneWriteModel) Query() *eventstore.SearchQueryBuilder {
|
|
return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
|
|
ResourceOwner(wm.ResourceOwner).
|
|
AddQuery().
|
|
AggregateTypes(user.AggregateType).
|
|
AggregateIDs(wm.AggregateID).
|
|
EventTypes(user.HumanAddedType,
|
|
user.HumanRegisteredType,
|
|
user.HumanInitialCodeAddedType,
|
|
user.HumanInitializedCheckSucceededType,
|
|
user.HumanPhoneChangedType,
|
|
user.HumanPhoneVerifiedType,
|
|
user.HumanPhoneCodeAddedType,
|
|
user.HumanPhoneCodeSentType,
|
|
user.HumanPhoneRemovedType,
|
|
user.UserRemovedType,
|
|
user.UserV1AddedType,
|
|
user.UserV1RegisteredType,
|
|
user.UserV1InitialCodeAddedType,
|
|
user.UserV1InitializedCheckSucceededType,
|
|
user.UserV1PhoneCodeAddedType,
|
|
user.UserV1PhoneChangedType,
|
|
user.UserV1PhoneVerifiedType,
|
|
user.UserV1PhoneRemovedType).
|
|
Builder()
|
|
}
|
|
|
|
func (wm *HumanPhoneWriteModel) NewChangedEvent(
|
|
ctx context.Context,
|
|
aggregate *eventstore.Aggregate,
|
|
phone domain.PhoneNumber,
|
|
) (*user.HumanPhoneChangedEvent, bool) {
|
|
changedEvent := user.NewHumanPhoneChangedEvent(ctx, aggregate, phone)
|
|
return changedEvent, phone != wm.Phone
|
|
}
|