mirror of
https://github.com/zitadel/zitadel
synced 2024-11-22 00:39:36 +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>
74 lines
1.6 KiB
Go
74 lines
1.6 KiB
Go
package domain
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/ttacon/libphonenumber"
|
|
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
es_models "github.com/zitadel/zitadel/internal/eventstore/v1/models"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
const defaultRegion = "CH"
|
|
|
|
type PhoneNumber string
|
|
|
|
func (p PhoneNumber) Normalize() (PhoneNumber, error) {
|
|
if p == "" {
|
|
return p, zerrors.ThrowInvalidArgument(nil, "PHONE-Zt0NV", "Errors.User.Phone.Empty")
|
|
}
|
|
phoneNr, err := libphonenumber.Parse(string(p), defaultRegion)
|
|
if err != nil {
|
|
return p, zerrors.ThrowInvalidArgument(err, "PHONE-so0wa", "Errors.User.Phone.Invalid")
|
|
}
|
|
return PhoneNumber(libphonenumber.Format(phoneNr, libphonenumber.E164)), nil
|
|
}
|
|
|
|
type Phone struct {
|
|
es_models.ObjectRoot
|
|
|
|
PhoneNumber PhoneNumber
|
|
IsPhoneVerified bool
|
|
// PlainCode is set by the command and can be used to return it to the caller (API)
|
|
PlainCode *string
|
|
}
|
|
|
|
type PhoneCode struct {
|
|
es_models.ObjectRoot
|
|
|
|
Code *crypto.CryptoValue
|
|
Expiry time.Duration
|
|
}
|
|
|
|
func (p *Phone) Normalize() error {
|
|
if p == nil {
|
|
return zerrors.ThrowInvalidArgument(nil, "PHONE-YlbwO", "Errors.User.Phone.Empty")
|
|
}
|
|
normalizedNumber, err := p.PhoneNumber.Normalize()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Issue for avoiding mutating state: https://github.com/zitadel/zitadel/issues/5412
|
|
p.PhoneNumber = normalizedNumber
|
|
return nil
|
|
}
|
|
|
|
type PhoneState int32
|
|
|
|
const (
|
|
PhoneStateUnspecified PhoneState = iota
|
|
PhoneStateActive
|
|
PhoneStateRemoved
|
|
|
|
phoneStateCount
|
|
)
|
|
|
|
func (s PhoneState) Valid() bool {
|
|
return s >= 0 && s < phoneStateCount
|
|
}
|
|
|
|
func (s PhoneState) Exists() bool {
|
|
return s == PhoneStateActive
|
|
}
|