diff --git a/channels/generateProto.sh b/channels/generateProto.sh new file mode 100755 index 0000000000000000000000000000000000000000..43c17e7e0587fe877ef77e52452f20d646a29670 --- /dev/null +++ b/channels/generateProto.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +#/////////////////////////////////////////////////////////////////////////////// +#/ Copyright © 2020 xx network SEZC // +#/ // +#/ Use of this source code is governed by a license that can be found in the // +#/ LICENSE file // +#/////////////////////////////////////////////////////////////////////////////// + +protoc --go_out=paths=source_relative:. channels/messages.proto diff --git a/channels/messages.go b/channels/messages.go new file mode 100644 index 0000000000000000000000000000000000000000..0769bf01a94b149b35dfbc11dfa8cfed458d094b --- /dev/null +++ b/channels/messages.go @@ -0,0 +1,22 @@ +//////////////////////////////////////////////////////////////////////////////// +// Copyright © 2020 xx network SEZC // +// // +// Use of this source code is governed by a license that can be found in the // +// LICENSE file // +//////////////////////////////////////////////////////////////////////////////// + +package channels + +import "github.com/golang/protobuf/proto" + +// UserMessageInternal is the internal structure of a UserMessage protobuf. +type UserMessageInternal struct { + UserMessage + channelMsg ChannelMessage +} + +// GetChannelMessage retrieves a serializes ChannelMessage within the +// UserMessageInternal object. +func (umi *UserMessageInternal) GetChannelMessage() ([]byte, error) { + return proto.Marshal(&umi.channelMsg) +} diff --git a/channels/messages.pb.go b/channels/messages.pb.go new file mode 100644 index 0000000000000000000000000000000000000000..9626b2630372d47d4659dcf602961e586f8394cc --- /dev/null +++ b/channels/messages.pb.go @@ -0,0 +1,217 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// source: channels/messages.proto + +package channels + +import ( + fmt "fmt" + proto "github.com/golang/protobuf/proto" + math "math" +) + +// Reference imports to suppress errors if they are not otherwise used. +var _ = proto.Marshal +var _ = fmt.Errorf +var _ = math.Inf + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the proto package it is being compiled against. +// A compilation error at this line likely means your copy of the +// proto package needs to be updated. +const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package + +// ChannelMessage is transmitted by the channel. Effectively it is +// a command for the channel sent by a user with admin access of the channel. +type ChannelMessage struct { + // Lease is the length that this channel message will take effect. + Lease int64 `protobuf:"varint,1,opt,name=Lease,proto3" json:"Lease,omitempty"` + // The round this message was sent on + RoundID uint64 `protobuf:"varint,2,opt,name=RoundID,proto3" json:"RoundID,omitempty"` + // The type the below payload is. This may be some form of channel command, + // such as BAN<username1>. + PayloadType uint32 `protobuf:"varint,3,opt,name=PayloadType,proto3" json:"PayloadType,omitempty"` + // Payload is the actual message payload. It will be processed differently based + // on the PayloadType + Payload []byte `protobuf:"bytes,4,opt,name=Payload,proto3" json:"Payload,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *ChannelMessage) Reset() { *m = ChannelMessage{} } +func (m *ChannelMessage) String() string { return proto.CompactTextString(m) } +func (*ChannelMessage) ProtoMessage() {} +func (*ChannelMessage) Descriptor() ([]byte, []int) { + return fileDescriptor_91ac4de6d1711204, []int{0} +} + +func (m *ChannelMessage) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_ChannelMessage.Unmarshal(m, b) +} +func (m *ChannelMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_ChannelMessage.Marshal(b, m, deterministic) +} +func (m *ChannelMessage) XXX_Merge(src proto.Message) { + xxx_messageInfo_ChannelMessage.Merge(m, src) +} +func (m *ChannelMessage) XXX_Size() int { + return xxx_messageInfo_ChannelMessage.Size(m) +} +func (m *ChannelMessage) XXX_DiscardUnknown() { + xxx_messageInfo_ChannelMessage.DiscardUnknown(m) +} + +var xxx_messageInfo_ChannelMessage proto.InternalMessageInfo + +func (m *ChannelMessage) GetLease() int64 { + if m != nil { + return m.Lease + } + return 0 +} + +func (m *ChannelMessage) GetRoundID() uint64 { + if m != nil { + return m.RoundID + } + return 0 +} + +func (m *ChannelMessage) GetPayloadType() uint32 { + if m != nil { + return m.PayloadType + } + return 0 +} + +func (m *ChannelMessage) GetPayload() []byte { + if m != nil { + return m.Payload + } + return nil +} + +// UserMessage is a message sent by a user who is a member within the channel. +type UserMessage struct { + // Message contains the contents of the message. This is typically what + // the end-user has submitted to the channel. + Message []byte `protobuf:"bytes,1,opt,name=Message,proto3" json:"Message,omitempty"` + // ValidationSignature is the signature validating this user owns + // their username and may send messages to the channel under this username. + // This signature is provided by UD and may be validated by all members of + // the channel. + // ValidationSignature = Sig(UD_ECCPrivKey,Username|ECCPublicKey|UsernameLease) + ValidationSignature []byte `protobuf:"bytes,2,opt,name=ValidationSignature,proto3" json:"ValidationSignature,omitempty"` + // Signature is the signature proving this message has been + // sent by the owner of this user's public key. + // Signature = Sig(User_ECCPublicKey,Message) + Signature []byte `protobuf:"bytes,3,opt,name=Signature,proto3" json:"Signature,omitempty"` + // Username is the username the user has registered with the channel and + // with UD. + Username string `protobuf:"bytes,4,opt,name=Username,proto3" json:"Username,omitempty"` + // ECCPublicKey is the user's EC Public key. This is provided by the network. + ECCPublicKey []byte `protobuf:"bytes,5,opt,name=ECCPublicKey,proto3" json:"ECCPublicKey,omitempty"` + // UsernameLease is the lease that has been provided to the username. + // This value is provide by UD. + UsernameLease int64 `protobuf:"varint,6,opt,name=UsernameLease,proto3" json:"UsernameLease,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *UserMessage) Reset() { *m = UserMessage{} } +func (m *UserMessage) String() string { return proto.CompactTextString(m) } +func (*UserMessage) ProtoMessage() {} +func (*UserMessage) Descriptor() ([]byte, []int) { + return fileDescriptor_91ac4de6d1711204, []int{1} +} + +func (m *UserMessage) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_UserMessage.Unmarshal(m, b) +} +func (m *UserMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_UserMessage.Marshal(b, m, deterministic) +} +func (m *UserMessage) XXX_Merge(src proto.Message) { + xxx_messageInfo_UserMessage.Merge(m, src) +} +func (m *UserMessage) XXX_Size() int { + return xxx_messageInfo_UserMessage.Size(m) +} +func (m *UserMessage) XXX_DiscardUnknown() { + xxx_messageInfo_UserMessage.DiscardUnknown(m) +} + +var xxx_messageInfo_UserMessage proto.InternalMessageInfo + +func (m *UserMessage) GetMessage() []byte { + if m != nil { + return m.Message + } + return nil +} + +func (m *UserMessage) GetValidationSignature() []byte { + if m != nil { + return m.ValidationSignature + } + return nil +} + +func (m *UserMessage) GetSignature() []byte { + if m != nil { + return m.Signature + } + return nil +} + +func (m *UserMessage) GetUsername() string { + if m != nil { + return m.Username + } + return "" +} + +func (m *UserMessage) GetECCPublicKey() []byte { + if m != nil { + return m.ECCPublicKey + } + return nil +} + +func (m *UserMessage) GetUsernameLease() int64 { + if m != nil { + return m.UsernameLease + } + return 0 +} + +func init() { + proto.RegisterType((*ChannelMessage)(nil), "parse.ChannelMessage") + proto.RegisterType((*UserMessage)(nil), "parse.UserMessage") +} + +func init() { + proto.RegisterFile("channels/messages.proto", fileDescriptor_91ac4de6d1711204) +} + +var fileDescriptor_91ac4de6d1711204 = []byte{ + // 261 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x6c, 0x90, 0x4f, 0x4b, 0xc3, 0x40, + 0x10, 0xc5, 0x59, 0xd3, 0xf4, 0xcf, 0x34, 0xf5, 0x30, 0x0a, 0x2e, 0xe2, 0x21, 0x04, 0x0f, 0x39, + 0xa9, 0xe0, 0x37, 0x30, 0x7a, 0x10, 0x15, 0xca, 0xfa, 0xe7, 0xe0, 0x6d, 0xda, 0x0c, 0x35, 0x90, + 0xee, 0x86, 0x6c, 0x72, 0x08, 0xf8, 0x55, 0xfd, 0x2e, 0xd2, 0x4d, 0xd7, 0x5a, 0xe8, 0x6d, 0x7e, + 0x6f, 0xde, 0xf0, 0x86, 0x07, 0x67, 0xcb, 0x2f, 0xd2, 0x9a, 0x4b, 0x7b, 0xbd, 0x66, 0x6b, 0x69, + 0xc5, 0xf6, 0xaa, 0xaa, 0x4d, 0x63, 0x30, 0xac, 0xa8, 0xb6, 0x9c, 0x7c, 0xc3, 0x71, 0xd6, 0x3b, + 0x5e, 0xfa, 0x3d, 0x9e, 0x42, 0xf8, 0xcc, 0x64, 0x59, 0x8a, 0x58, 0xa4, 0x81, 0xea, 0x01, 0x25, + 0x8c, 0x94, 0x69, 0x75, 0xfe, 0x78, 0x2f, 0x8f, 0x62, 0x91, 0x0e, 0x94, 0x47, 0x8c, 0x61, 0x3a, + 0xa7, 0xae, 0x34, 0x94, 0xbf, 0x75, 0x15, 0xcb, 0x20, 0x16, 0xe9, 0x4c, 0xfd, 0x97, 0x36, 0xb7, + 0x5b, 0x94, 0x83, 0x58, 0xa4, 0x91, 0xf2, 0x98, 0xfc, 0x08, 0x98, 0xbe, 0x5b, 0xae, 0x7d, 0xb6, + 0x84, 0xd1, 0x76, 0x74, 0xe9, 0x91, 0xf2, 0x88, 0x37, 0x70, 0xf2, 0x41, 0x65, 0x91, 0x53, 0x53, + 0x18, 0xfd, 0x5a, 0xac, 0x34, 0x35, 0x6d, 0xcd, 0xee, 0x97, 0x48, 0x1d, 0x5a, 0xe1, 0x05, 0x4c, + 0x76, 0xbe, 0xc0, 0xf9, 0x76, 0x02, 0x9e, 0xc3, 0x78, 0x13, 0xac, 0x69, 0xcd, 0xee, 0xa9, 0x89, + 0xfa, 0x63, 0x4c, 0x20, 0x7a, 0xc8, 0xb2, 0x79, 0xbb, 0x28, 0x8b, 0xe5, 0x13, 0x77, 0x32, 0x74, + 0xc7, 0x7b, 0x1a, 0x5e, 0xc2, 0xcc, 0xfb, 0xfb, 0xb6, 0x86, 0xae, 0xad, 0x7d, 0xf1, 0x0e, 0x3e, + 0xc7, 0xbe, 0xff, 0xc5, 0xd0, 0xf5, 0x7e, 0xfb, 0x1b, 0x00, 0x00, 0xff, 0xff, 0xcb, 0xb2, 0xc9, + 0xf7, 0x92, 0x01, 0x00, 0x00, +} diff --git a/channels/messages.proto b/channels/messages.proto new file mode 100644 index 0000000000000000000000000000000000000000..c889329677ba19cbfefedd820287e817e0318ef6 --- /dev/null +++ b/channels/messages.proto @@ -0,0 +1,59 @@ +//////////////////////////////////////////////////////////////////////////////// +// Copyright © 2020 xx network SEZC // +// // +// Use of this source code is governed by a license that can be found in the // +// LICENSE file // +//////////////////////////////////////////////////////////////////////////////// + +syntax = "proto3"; + +package parse; +option go_package = "channels"; + +// ChannelMessage is transmitted by the channel. Effectively it is +// a command for the channel sent by a user with admin access of the channel. +message ChannelMessage{ + // Lease is the length that this channel message will take effect. + int64 Lease = 1; + + // The round this message was sent on + uint64 RoundID = 2; + + // The type the below payload is. This may be some form of channel command, + // such as BAN<username1>. + uint32 PayloadType = 3; + + // Payload is the actual message payload. It will be processed differently based + // on the PayloadType + bytes Payload = 4; +} + +// UserMessage is a message sent by a user who is a member within the channel. +message UserMessage { + // Message contains the contents of the message. This is typically what + // the end-user has submitted to the channel. + bytes Message = 1; + + // ValidationSignature is the signature validating this user owns + // their username and may send messages to the channel under this username. + // This signature is provided by UD and may be validated by all members of + // the channel. + // ValidationSignature = Sig(UD_ECCPrivKey,Username|ECCPublicKey|UsernameLease) + bytes ValidationSignature = 2; + + // Signature is the signature proving this message has been + // sent by the owner of this user's public key. + // Signature = Sig(User_ECCPublicKey,Message) + bytes Signature = 3; + + // Username is the username the user has registered with the channel and + // with UD. + string Username = 4; + + // ECCPublicKey is the user's EC Public key. This is provided by the network. + bytes ECCPublicKey = 5; + + // UsernameLease is the lease that has been provided to the username. + // This value is provide by UD. + int64 UsernameLease = 6; +}