verificationhelper

type ECDHPrivateKey struct {
	*ecdh.PrivateKey
}

type ECDHPublicKey struct {
	*ecdh.PublicKey
}

type InMemoryVerificationStore struct {
	// contains filtered or unexported fields
}

type QRCode struct {
	Mode          QRCodeMode
	TransactionID id.VerificationTransactionID
	Key1, Key2    [32]byte
	SharedSecret  []byte
}

type QRCodeMode byte

type RequiredCallbacks interface {
	// VerificationRequested is called when a verification request is received
	// from another device.
	VerificationRequested(ctx context.Context, txnID id.VerificationTransactionID, from id.UserID, fromDevice id.DeviceID)

	// VerificationCancelled is called when the verification is cancelled.
	VerificationCancelled(ctx context.Context, txnID id.VerificationTransactionID, code event.VerificationCancelCode, reason string)

	// VerificationDone is called when the verification is done.
	VerificationDone(ctx context.Context, txnID id.VerificationTransactionID)
}

type ShowQRCodeCallbacks interface {
	// ScanQRCode is called when another device has sent a
	// m.key.verification.ready event and indicated that they are capable of
	// showing a QR code.
	ScanQRCode(ctx context.Context, txnID id.VerificationTransactionID)

	// ShowQRCode is called when the verification has been accepted and a QR
	// code should be shown to the user.
	ShowQRCode(ctx context.Context, txnID id.VerificationTransactionID, qrCode *QRCode)

	// QRCodeScanned is called when the other user has scanned the QR code and
	// sent the m.key.verification.start event.
	QRCodeScanned(ctx context.Context, txnID id.VerificationTransactionID)
}

type ShowSASCallbacks interface {
	// ShowSAS is a callback that is called when the SAS verification has
	// generated a short authentication string to show. It is guaranteed that
	// either the emojis and emoji descriptions lists, or the decimals list, or
	// both will be present.
	ShowSAS(ctx context.Context, txnID id.VerificationTransactionID, emojis []rune, emojiDescriptions []string, decimals []int)
}

type VerificationHelper struct {
	// contains filtered or unexported fields
}

type VerificationState int

type VerificationStore interface {
	// DeleteVerification deletes a verification transaction by ID
	DeleteVerification(ctx context.Context, txnID id.VerificationTransactionID) error
	// GetVerificationTransaction gets a verification transaction by ID
	GetVerificationTransaction(ctx context.Context, txnID id.VerificationTransactionID) (VerificationTransaction, error)
	// SaveVerificationTransaction saves a verification transaction by ID
	SaveVerificationTransaction(ctx context.Context, txn VerificationTransaction) error
	// FindVerificationTransactionForUserDevice finds a verification
	// transaction by user and device ID
	FindVerificationTransactionForUserDevice(ctx context.Context, userID id.UserID, deviceID id.DeviceID) (VerificationTransaction, error)
	// GetAllVerificationTransactions returns all of the verification
	// transactions. This is used to reset the cancellation timeouts.
	GetAllVerificationTransactions(ctx context.Context) ([]VerificationTransaction, error)
}

type VerificationTransaction struct {
	ExpirationTime jsontime.UnixMilli `json:"expiration_time,omitempty"`

	// RoomID is the room ID if the verification is happening in a room or
	// empty if it is a to-device verification.
	RoomID id.RoomID `json:"room_id,omitempty"`

	// VerificationState is the current step of the verification flow.
	VerificationState VerificationState `json:"verification_state"`
	// TransactionID is the ID of the verification transaction.
	TransactionID id.VerificationTransactionID `json:"transaction_id"`

	// TheirDeviceID is the device ID of the device that either made the
	// initial request or accepted our request.
	TheirDeviceID id.DeviceID `json:"their_device_id,omitempty"`
	// TheirUserID is the user ID of the other user.
	TheirUserID id.UserID `json:"their_user_id,omitempty"`
	// TheirSupportedMethods is a list of verification methods that the other
	// device supports.
	TheirSupportedMethods []event.VerificationMethod `json:"their_supported_methods,omitempty"`

	// SentToDeviceIDs is a list of devices which the initial request was sent
	// to. This is only used for to-device verification requests, and is meant
	// to be used to send cancellation requests to all other devices when a
	// verification request is accepted via a m.key.verification.ready event.
	SentToDeviceIDs []id.DeviceID `json:"sent_to_device_ids,omitempty"`

	// QRCodeSharedSecret is the shared secret that was encoded in the QR code
	// that we showed.
	QRCodeSharedSecret []byte `json:"qr_code_shared_secret,omitempty"`

	StartedByUs              bool                                 `json:"started_by_us,omitempty"`               // Whether the verification was started by us
	StartEventContent        *event.VerificationStartEventContent `json:"start_event_content,omitempty"`         // The m.key.verification.start event content
	Commitment               []byte                               `json:"committment,omitempty"`                 // The commitment from the m.key.verification.accept event
	MACMethod                event.MACMethod                      `json:"mac_method,omitempty"`                  // The method used to calculate the MAC
	EphemeralKey             *ECDHPrivateKey                      `json:"ephemeral_key,omitempty"`               // The ephemeral key
	EphemeralPublicKeyShared bool                                 `json:"ephemeral_public_key_shared,omitempty"` // Whether this device's ephemeral public key has been shared
	OtherPublicKey           *ECDHPublicKey                       `json:"other_public_key,omitempty"`            // The other device's ephemeral public key
	ReceivedTheirMAC         bool                                 `json:"received_their_mac,omitempty"`          // Whether we have received their MAC
	SentOurMAC               bool                                 `json:"sent_our_mac,omitempty"`                // Whether we have sent our MAC
	ReceivedTheirDone        bool                                 `json:"received_their_done,omitempty"`         // Whether we have received their done event
	SentOurDone              bool                                 `json:"sent_our_done,omitempty"`               // Whether we have sent our done event
}