Skip to content

Add OtaChecksumType validation per Matter Spec R1.4.2 #701

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

Open
Chapoly1305 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OtaChecksumType validation per Matter Spec R1.4.2 #701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions x/model/types/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ var (
ErrModelDeletionCertified = errors.Register(ModuleName, 525, "model has a model version that has a compliance record and correcponding model can not be deleted")
ErrFieldIsNotBase64Encoded = errors.Register(ModuleName, 526, "Field is not base64 encoded string")
ErrEnhancedSetupFlowTCRevisionInvalid = errors.Register(ModuleName, 527, "enhanced setup flow TC revision invalid")
ErrOtaChecksumTypeInvalid = errors.Register(ModuleName, 528, "OTA checksum type is not valid")
)

func NewErrModelAlreadyExists(vid interface{}, pid interface{}) error {
Expand Down Expand Up @@ -149,3 +150,9 @@ func NewErrEnhancedSetupFlowTCRevisionInvalidIncrement(newEnhancedSetupFlowTCRev
return errors.Wrapf(ErrEnhancedSetupFlowTCRevisionInvalid,
"EnhancedSetupFlowTCRevision %v is not correctly incremented to %v", prevEnhancedSetupFlowTCRevision, newEnhancedSetupFlowTCRevision)
}

func NewErrOtaChecksumTypeInvalid(otaChecksumType int32) error {
return errors.Wrapf(ErrOtaChecksumTypeInvalid,
"OtaChecksumType %v is not valid. Must be one of [1, 7, 8, 10, 11, 12] per IANA Named Information Hash Algorithm Registry",
otaChecksumType)
}
17 changes: 17 additions & 0 deletions x/model/types/messages_model_version.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,19 @@ func (msg *MsgCreateModelVersion) GetSignBytes() []byte {
return sdk.MustSortJSON(bz)
}

var ValidOtaChecksumTypes = map[int32]bool{
1: true, // sha-256
7: true, // sha-384
8: true, // sha-512
10: true, // sha3-256
11: true, // sha3-384
12: true, // sha3-512
}

func IsValidOtaChecksumType(checksumType int32) bool {
return ValidOtaChecksumTypes[checksumType]
}

func (msg *MsgCreateModelVersion) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(msg.Creator)
if err != nil {
Expand All @@ -91,6 +104,10 @@ func (msg *MsgCreateModelVersion) ValidateBasic() error {
return NewErrOtaChecksumIsNotBase64Encoded(msg.OtaChecksum)
}

if msg.OtaUrl != "" && !IsValidOtaChecksumType(msg.OtaChecksumType) {
return NewErrOtaChecksumTypeInvalid(msg.OtaChecksumType)
}

err = validator.Validate(msg)
if err != nil {
return err
Expand Down
96 changes: 88 additions & 8 deletions x/model/types/messages_model_version_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,25 +208,67 @@ func TestMsgCreateModelVersion_ValidateBasic(t *testing.T) {

return msg
}(validMsgCreateModelVersion()),
err: validator.ErrRequiredFieldMissing,
err: ErrOtaChecksumTypeInvalid,
},
{
name: "OtaChecksumType < 0",
name: "OtaChecksumType < 0 when OtaUrl is set",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = -1

return msg
}(validMsgCreateModelVersion()),
err: validator.ErrFieldLowerBoundViolated,
err: ErrOtaChecksumTypeInvalid,
},
{
name: "OtaChecksumType > 65535",
name: "OtaChecksumType > 65535 when OtaUrl is set",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 65536

return msg
}(validMsgCreateModelVersion()),
err: validator.ErrFieldUpperBoundViolated,
err: ErrOtaChecksumTypeInvalid,
},
{
name: "OtaChecksumType == 2 is not in allowed list when OtaUrl is set",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 2

return msg
}(validMsgCreateModelVersion()),
err: ErrOtaChecksumTypeInvalid,
},
{
name: "OtaChecksumType == 3 is not in allowed list when OtaUrl is set",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 3

return msg
}(validMsgCreateModelVersion()),
err: ErrOtaChecksumTypeInvalid,
},
{
name: "OtaChecksumType == 9 is not in allowed list when OtaUrl is set",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 9

return msg
}(validMsgCreateModelVersion()),
err: ErrOtaChecksumTypeInvalid,
},
{
name: "OtaChecksumType == 100 is not in allowed list when OtaUrl is set",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 100

return msg
}(validMsgCreateModelVersion()),
err: ErrOtaChecksumTypeInvalid,
},
{
name: "MinApplicableSoftwareVersion > MaxApplicableSoftwareVersion " +
Expand Down Expand Up @@ -488,17 +530,55 @@ func TestMsgCreateModelVersion_ValidateBasic(t *testing.T) {
}(validMsgCreateModelVersion()),
},
{
name: "OtaChecksumType == 1",
name: "OtaChecksumType == 1 (sha-256)",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 1

return msg
}(validMsgCreateModelVersion()),
},
{
name: "OtaChecksumType == 65535",
name: "OtaChecksumType == 7 (sha-384)",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 7

return msg
}(validMsgCreateModelVersion()),
},
{
name: "OtaChecksumType == 8 (sha-512)",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 8

return msg
}(validMsgCreateModelVersion()),
},
{
name: "OtaChecksumType == 10 (sha3-256)",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaChecksumType = 65535
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 10

return msg
}(validMsgCreateModelVersion()),
},
{
name: "OtaChecksumType == 11 (sha3-384)",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 11

return msg
}(validMsgCreateModelVersion()),
},
{
name: "OtaChecksumType == 12 (sha3-512)",
msg: func(msg *MsgCreateModelVersion) *MsgCreateModelVersion {
msg.OtaUrl = "https://sampleflowurl.dclmodel"
msg.OtaChecksumType = 12

return msg
}(validMsgCreateModelVersion()),
Expand Down