1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
|
package proton
import (
"encoding/base64"
"encoding/json"
"errors"
"github.com/ProtonMail/gopenpgp/v2/crypto"
)
type LinkWalkFunc func([]string, Link, *crypto.KeyRing) error
// Link holds the tree structure, for the clients, they represent the files and folders of a given volume.
// They have a ParentLinkID that points to parent folders.
// Links also hold the file name (encrypted) and a hash of the name for name collisions.
// Link data is encrypted with its owning Share keyring.
type Link struct {
LinkID string // Encrypted file/folder ID
ParentLinkID string // Encrypted parent folder ID (LinkID). Root link has null ParentLinkID.
Type LinkType
Name string // Encrypted file name
NameSignatureEmail string // Signature email for link name
Hash string // HMAC of name encrypted with parent hash key
Size int64
State LinkState
MIMEType string
CreateTime int64 // Link creation time
ModifyTime int64 // Link modification time (on API, real modify date is stored in XAttr)
ExpirationTime int64 // Link expiration time
NodeKey string // The private NodeKey, used to decrypt any file/folder content.
NodePassphrase string // The passphrase used to unlock the NodeKey, encrypted by the owning Link/Share keyring.
NodePassphraseSignature string
SignatureEmail string // Signature email for the NodePassphraseSignature
FileProperties *FileProperties
FolderProperties *FolderProperties
}
type LinkState int
const (
LinkStateDraft LinkState = iota
LinkStateActive
LinkStateTrashed
LinkStateDeleted
LinkStateRestoring
)
func (l Link) GetName(parentNodeKR, addrKR *crypto.KeyRing) (string, error) {
encName, err := crypto.NewPGPMessageFromArmored(l.Name)
if err != nil {
return "", err
}
decName, err := parentNodeKR.Decrypt(encName, addrKR, crypto.GetUnixTime())
if err != nil {
return "", err
}
return decName.GetString(), nil
}
func (l Link) GetKeyRing(parentNodeKR, addrKR *crypto.KeyRing) (*crypto.KeyRing, error) {
enc, err := crypto.NewPGPMessageFromArmored(l.NodePassphrase)
if err != nil {
return nil, err
}
dec, err := parentNodeKR.Decrypt(enc, nil, crypto.GetUnixTime())
if err != nil {
return nil, err
}
sig, err := crypto.NewPGPSignatureFromArmored(l.NodePassphraseSignature)
if err != nil {
return nil, err
}
if err := addrKR.VerifyDetached(dec, sig, crypto.GetUnixTime()); err != nil {
return nil, err
}
lockedKey, err := crypto.NewKeyFromArmored(l.NodeKey)
if err != nil {
return nil, err
}
unlockedKey, err := lockedKey.Unlock(dec.GetBinary())
if err != nil {
return nil, err
}
return crypto.NewKeyRing(unlockedKey)
}
func (l Link) GetHashKey(parentNodeKey, addrKRs *crypto.KeyRing) ([]byte, error) {
if l.Type != LinkTypeFolder {
return nil, errors.New("link is not a folder")
}
enc, err := crypto.NewPGPMessageFromArmored(l.FolderProperties.NodeHashKey)
if err != nil {
return nil, err
}
_, ok := enc.GetSignatureKeyIDs()
var dec *crypto.PlainMessage
if ok {
dec, err = parentNodeKey.Decrypt(enc, addrKRs, crypto.GetUnixTime())
if err != nil {
return nil, err
}
} else {
dec, err = parentNodeKey.Decrypt(enc, nil, 0)
if err != nil {
return nil, err
}
}
return dec.GetBinary(), nil
}
func (l Link) GetSessionKey(nodeKR *crypto.KeyRing) (*crypto.SessionKey, error) {
if l.Type != LinkTypeFile {
return nil, errors.New("link is not a file")
}
dec, err := base64.StdEncoding.DecodeString(l.FileProperties.ContentKeyPacket)
if err != nil {
return nil, err
}
key, err := nodeKR.DecryptSessionKey(dec)
if err != nil {
return nil, err
}
sig, err := crypto.NewPGPSignatureFromArmored(l.FileProperties.ContentKeyPacketSignature)
if err != nil {
return nil, err
}
if err := nodeKR.VerifyDetached(crypto.NewPlainMessage(key.Key), sig, crypto.GetUnixTime()); err != nil {
return nil, err
}
return key, nil
}
type FileProperties struct {
ContentKeyPacket string // The block's key packet, encrypted with the node key.
ContentKeyPacketSignature string // Signature of the content key packet. Signature of the session key, signed with the NodeKey.
ActiveRevision RevisionMetadata // The active revision of the file.
}
type FolderProperties struct {
NodeHashKey string // HMAC key used to hash the folder's children names.
}
type LinkType int
const (
LinkTypeFolder LinkType = iota + 1
LinkTypeFile
)
type RevisionMetadata struct {
ID string // Encrypted Revision ID
CreateTime int64 // Unix timestamp of the revision creation time
Size int64 // Size of the revision in bytes
ManifestSignature string // Signature of the revision manifest, signed with user's address key of the share.
SignatureEmail string // Email of the user that signed the revision.
State RevisionState // State of revision
XAttr string // modification time and size from the file system
Thumbnail Bool // Whether the revision has a thumbnail
ThumbnailHash string // Hash of the thumbnail
}
func (revisionMetadata *RevisionMetadata) GetDecXAttrString(addrKR, nodeKR *crypto.KeyRing) (*RevisionXAttrCommon, error) {
if revisionMetadata.XAttr == "" {
return nil, nil
}
// decrypt the modification time and size
XAttrMsg, err := crypto.NewPGPMessageFromArmored(revisionMetadata.XAttr)
if err != nil {
return nil, err
}
decXAttr, err := nodeKR.Decrypt(XAttrMsg, addrKR, crypto.GetUnixTime())
if err != nil {
return nil, err
}
var data RevisionXAttr
err = json.Unmarshal(decXAttr.Data, &data)
if err != nil {
// TODO: if Unmarshal fails, maybe it's because the file system is missing the field?
return nil, err
}
return &data.Common, nil
}
// Revisions are only for files, they represent “versions” of files.
// Each file can have 1 active revision and n obsolete revisions.
type Revision struct {
RevisionMetadata
Blocks []Block
}
func (revision *Revision) GetDecXAttrString(addrKR, nodeKR *crypto.KeyRing) (*RevisionXAttrCommon, error) {
if revision.XAttr == "" {
return nil, nil
}
// decrypt the modification time and size
XAttrMsg, err := crypto.NewPGPMessageFromArmored(revision.XAttr)
if err != nil {
return nil, err
}
decXAttr, err := nodeKR.Decrypt(XAttrMsg, addrKR, crypto.GetUnixTime())
if err != nil {
return nil, err
}
var data RevisionXAttr
err = json.Unmarshal(decXAttr.Data, &data)
if err != nil {
// TODO: if Unmarshal fails, maybe it's because the file system is missing the field?
return nil, err
}
return &data.Common, nil
}
type RevisionState int
const (
RevisionStateDraft RevisionState = iota
RevisionStateActive
RevisionStateObsolete
RevisionStateDeleted
)
type CheckAvailableHashesReq struct {
Hashes []string
}
type PendingHashData struct {
Hash []string
RevisionID []string
LinkID []string
}
type CheckAvailableHashesRes struct {
AvailableHashes []string
PendingHashesData []PendingHashData
}
|