Refactor and comment

This commit is contained in:
ycc
2023-11-08 21:52:09 +01:00
parent 08ff9d58b8
commit 04a390d558
11 changed files with 271 additions and 294 deletions

View File

@ -11,16 +11,19 @@ import (
"google.golang.org/protobuf/proto"
)
// Peer manages the peer messaging functions
// - Building simple user messages
// - Utility functions for packing/unpacking, encrypting/decrypting messages for peer communication
type Peer struct {
Name string `json:"name,omitempty"`
MyName string `json:"my_name,omitempty"`
MyAvatar string `json:"my_avatar,omitempty"`
// Conversation []InternalMessage `json:"conversation,omitempty"`
// My own keys for that peer
MyIdentity meowlib.KeyPair `json:"my_identity,omitempty"`
MyEncryptionKp meowlib.KeyPair `json:"my_encryption_kp,omitempty"`
MyLookupKp meowlib.KeyPair `json:"my_lookup_kp,omitempty"`
MyPullServers []meowlib.Server `json:"my_pull_servers,omitempty"`
MyIdentity meowlib.KeyPair `json:"my_identity,omitempty"`
MyEncryptionKp meowlib.KeyPair `json:"my_encryption_kp,omitempty"`
MyLookupKp meowlib.KeyPair `json:"my_lookup_kp,omitempty"`
MyPullServers []meowlib.ServerCard `json:"my_pull_servers,omitempty"`
// Peer keys and infos
Contact meowlib.ContactCard `json:"contact,omitempty"`
InvitationId string `json:"invitation_id,omitempty"`
@ -37,50 +40,9 @@ type Peer struct {
dbPassword string
}
type PeerList []Peer
type Group struct {
Name string `json:"name,omitempty"`
Members []Peer `json:"members,omitempty"`
}
func (pl *PeerList) GetFromPublicKey(publickey string) *Peer {
for _, peer := range *pl {
if peer.Contact.ContactPublicKey == publickey {
return &peer
}
}
return nil
}
func (pl *PeerList) GetFromMyLookupKey(publickey string) *Peer {
for _, peer := range *pl {
if peer.MyLookupKp.Public == publickey {
return &peer
}
}
return nil
}
func (pl *PeerList) GetFromName(name string) *Peer {
for _, peer := range *pl {
if peer.Contact.Name == name {
return &peer
}
}
return nil
}
func (pl *PeerList) GetConversationRequests() []*meowlib.ConversationRequest {
var list []*meowlib.ConversationRequest
for _, peer := range *pl {
var cr meowlib.ConversationRequest
cr.LookupKey = peer.MyLookupKp.Public
// TODO Add key signature
list = append(list, &cr)
}
return list
}
//
// Messages building
//
func (p *Peer) BuildSimpleUserMessage(message []byte) (*meowlib.UserMessage, error) {
var msg meowlib.UserMessage
@ -99,16 +61,13 @@ func (p *Peer) BuildSingleFileMessage(filename string, message []byte) ([]meowli
if err != nil {
return nil, err
}
file, err := os.Open(filename)
if err != nil {
return nil, err
}
defer file.Close()
// declare chunk size
maxSz := GetConfig().Chunksize
// create buffer
b := make([]byte, maxSz)
chunk := 0
@ -141,6 +100,10 @@ func (p *Peer) BuildSingleFileMessage(filename string, message []byte) ([]meowli
return msgs, nil
}
//
// Messages encryption and packaging
//
func (p *Peer) SerializeUserMessage(msg *meowlib.UserMessage) ([]byte, error) {
out, err := proto.Marshal(msg)
if err != nil {
@ -179,7 +142,7 @@ func (p *Peer) AsymDecryptMessage(Message []byte, Signature []byte) (DecryptedMe
return DecryptedMessage, err
}
// PackUserMessage will package the previously encrypted message for sending it to the peer in protobuff format
// PackUserMessage will package the previously encrypted message
func (p *Peer) PackUserMessage(message []byte, signature []byte) *meowlib.PackedUserMessage {
var msg meowlib.PackedUserMessage
msg.Destination = p.Contact.LookupPublicKey
@ -188,6 +151,7 @@ func (p *Peer) PackUserMessage(message []byte, signature []byte) *meowlib.Packed
return &msg
}
// UnPackUserMessage unpacks a user message
func (p *Peer) UnPackUserMessage(protoPackedMessage []byte) (payload []byte, signature []byte, err error) {
msg := &meowlib.PackedServerMessage{}
if err := proto.Unmarshal(protoPackedMessage, msg); err != nil {
@ -201,6 +165,7 @@ func (p *Peer) GetConversationRequest() *meowlib.ConversationRequest {
return &cr
}
// ProcessOutboundUserMessage is a helper function that serializes, encrypts and packs a user message
func (p *Peer) ProcessOutboundUserMessage(usermessage *meowlib.UserMessage) (*meowlib.PackedUserMessage, error) {
serializedMessage, err := p.SerializeUserMessage(usermessage)
if err != nil {
@ -213,10 +178,10 @@ func (p *Peer) ProcessOutboundUserMessage(usermessage *meowlib.UserMessage) (*me
}
// Packing it
packedMsg := p.PackUserMessage(enc.Data, enc.Signature)
return packedMsg, nil
}
// ProcessInboundUserMessage is a helper function that decrypts and deserializes a user message
func (p *Peer) ProcessInboundUserMessage(message []byte, signature []byte) (*meowlib.UserMessage, error) {
dec, err := p.AsymDecryptMessage(message, signature)
if err != nil {
@ -229,6 +194,11 @@ func (p *Peer) ProcessInboundUserMessage(message []byte, signature []byte) (*meo
return msg, nil
}
//
// Messages database
//
// SetDbPassword sets a specific password for a hidden user, it won't be saved, but kept in memory only for the next operations
func (p *Peer) SetDbPassword(password string) {
p.dbPassword = password
}

45
client/peerlist.go Normal file
View File

@ -0,0 +1,45 @@
package client
import (
"forge.redroom.link/yves/meowlib"
)
type PeerList []Peer
func (pl *PeerList) GetFromPublicKey(publickey string) *Peer {
for _, peer := range *pl {
if peer.Contact.ContactPublicKey == publickey {
return &peer
}
}
return nil
}
func (pl *PeerList) GetFromMyLookupKey(publickey string) *Peer {
for _, peer := range *pl {
if peer.MyLookupKp.Public == publickey {
return &peer
}
}
return nil
}
func (pl *PeerList) GetFromName(name string) *Peer {
for _, peer := range *pl {
if peer.Contact.Name == name {
return &peer
}
}
return nil
}
func (pl *PeerList) GetConversationRequests() []*meowlib.ConversationRequest {
var list []*meowlib.ConversationRequest
for _, peer := range *pl {
var cr meowlib.ConversationRequest
cr.LookupKey = peer.MyLookupKp.Public
// TODO Add key signature
list = append(list, &cr)
}
return list
}

View File

@ -9,16 +9,22 @@ import (
"google.golang.org/protobuf/proto"
)
// InternalServer manages server related operations
// - Sending messages for server usage
// - Two first steps of an invitation
// - User message sending
// - Messages lookup requests
// - Utility functions for packing/unpacking, encrypting/decrypting messages for server communication
type InternalServer struct {
ServerData meowlib.Server `json:"server_data,omitempty"`
Presence bool `json:"presence,omitempty"`
LastCheck time.Time `json:"last_check,omitempty"`
Uptime time.Duration `json:"uptime,omitempty"`
Login string `json:"login,omitempty"`
Password string `json:"password,omitempty"`
Me meowlib.KeyPair `json:"me,omitempty"`
Country string `json:"country,omitempty"`
AllowedDelay int `json:"allowed_delay,omitempty"`
ServerData meowlib.ServerCard `json:"server_data,omitempty"`
Presence bool `json:"presence,omitempty"`
LastCheck time.Time `json:"last_check,omitempty"`
Uptime time.Duration `json:"uptime,omitempty"`
Login string `json:"login,omitempty"`
Password string `json:"password,omitempty"`
Me meowlib.KeyPair `json:"me,omitempty"`
Country string `json:"country,omitempty"`
AllowedDelay int `json:"allowed_delay,omitempty"`
}
type InternalServerList struct {
@ -32,7 +38,7 @@ func InternalServerFromUrl(url string) *InternalServer {
return &is
}
func InternalServerFromServer(server *meowlib.Server) *InternalServer {
func InternalServerFromServer(server *meowlib.ServerCard) *InternalServer {
var is InternalServer
is.ServerData = *server
is.Me = meowlib.NewKeyPair()
@ -92,7 +98,6 @@ func (ints *InternalServer) BuildMessageRequestMessage(lookupKeys []string) ([]b
msg.Uuid = uuid.New().String()
msg.Type = "1"
msg.From = ints.Me.Public
out, err := proto.Marshal(&msg)
if err != nil {
return nil, err
@ -100,8 +105,8 @@ func (ints *InternalServer) BuildMessageRequestMessage(lookupKeys []string) ([]b
return out, nil
}
// BuildToServerMessageInvitation creates an invintatio message to server from a single packed user message and returns it as a meowlib.ToServerMessage
func (ints *InternalServer) BuildToServerMessageInvitation(invitation *meowlib.ContactCard, password string, timeout int, urllen int) (*meowlib.ToServerMessage, error) {
// BuildToServerMessageInvitation creates an invitation message to server and returns it as a meowlib.ToServerMessage
func (ints *InternalServer) BuildToServerMessageInvitationCreation(invitation *meowlib.ContactCard, password string, timeout int, urllen int) (*meowlib.ToServerMessage, error) {
var msg meowlib.ToServerMessage
var inv meowlib.Invitation
payload, err := invitation.Compress()
@ -110,6 +115,7 @@ func (ints *InternalServer) BuildToServerMessageInvitation(invitation *meowlib.C
}
msg.Type = "1"
msg.From = ints.Me.Public
inv.Step = 1
inv.Password = password
inv.Timeout = int32(timeout)
inv.Idlen = int32(urllen)
@ -118,6 +124,19 @@ func (ints *InternalServer) BuildToServerMessageInvitation(invitation *meowlib.C
return &msg, nil
}
// BuildToServerMessageInvitationRequest requests invitation with provided id from server and returns it as a meowlib.ToServerMessage
func (ints *InternalServer) BuildToServerMessageInvitationRequest(url string, password string) (*meowlib.ToServerMessage, error) {
var msg meowlib.ToServerMessage
var inv meowlib.Invitation
msg.Type = "1"
msg.From = ints.Me.Public
inv.Step = 2
inv.Password = password
inv.Id = url
msg.Invitation = &inv
return &msg, nil
}
func (ints *InternalServer) PackServerMessage(payload []byte, signature []byte) (protoPackedMessage []byte, err error) {
var msg meowlib.PackedServerMessage
msg.From = ints.Me.Public