Skip to content

Commit

Permalink
This update docs and tests for workbook encryption
Browse files Browse the repository at this point in the history
  • Loading branch information
xuri committed May 31, 2022
1 parent d5f8618 commit a0396ed
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ test/Test*.xlsx
test/Test*.xltm
test/Test*.xltx
# generated files
test/BadEncrypt.xlsx
test/Encryption*.xlsx
test/BadWorkbook.SaveAsEmptyStruct.xlsx
test/*.png
test/excelize-*
Expand Down
27 changes: 11 additions & 16 deletions crypt.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,10 @@ func Decrypt(raw []byte, opt *Options) (packageBuf []byte, err error) {
if err != nil || mechanism == "extensible" {
return
}
switch mechanism {
case "agile":
if mechanism == "agile" {
return agileDecrypt(encryptionInfoBuf, encryptedPackageBuf, opt)
case "standard":
return standardDecrypt(encryptionInfoBuf, encryptedPackageBuf, opt)
default:
err = ErrUnsupportedEncryptMechanism
}
return
return standardDecrypt(encryptionInfoBuf, encryptedPackageBuf, opt)
}

// Encrypt API encrypt data with the password.
Expand Down Expand Up @@ -1112,7 +1107,7 @@ func (c *cfb) writeDirectoryEntry(propertyCount, customSectID, size int) []byte
return storage.stream
}

// writeMSAT provides a function to write compound file sector allocation
// writeMSAT provides a function to write compound file master sector allocation
// table.
func (c *cfb) writeMSAT(MSATBlocks, SATBlocks int, MSAT []int) []int {
if MSATBlocks > 0 {
Expand All @@ -1129,19 +1124,19 @@ func (c *cfb) writeMSAT(MSATBlocks, SATBlocks int, MSAT []int) []int {
}
MSAT = append(MSAT, -1)
}
} else {
for i := 0; i < 109; i++ {
if i < SATBlocks {
MSAT = append(MSAT, i)
continue
}
MSAT = append(MSAT, -1)
return MSAT
}
for i := 0; i < 109; i++ {
if i < SATBlocks {
MSAT = append(MSAT, i)
continue
}
MSAT = append(MSAT, -1)
}
return MSAT
}

// writeSAT provides a function to write compound file master sector allocation
// writeSAT provides a function to write compound file sector allocation
// table.
func (c *cfb) writeSAT(MSATBlocks, SATBlocks, SSATBlocks, directoryBlocks, fileBlocks, streamBlocks int, SAT []int) (int, []int) {
var blocks int
Expand Down
13 changes: 13 additions & 0 deletions crypt_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
package excelize

import (
"io/ioutil"
"path/filepath"
"strings"
"testing"
Expand All @@ -30,6 +31,13 @@ func TestEncrypt(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, "SECRET", cell)
assert.NoError(t, f.Close())
// Test decrypt spreadsheet with unsupported encrypt mechanism
raw, err := ioutil.ReadFile(filepath.Join("test", "encryptAES.xlsx"))
assert.NoError(t, err)
raw[2050] = 3
_, err = Decrypt(raw, &Options{Password: "password"})
assert.EqualError(t, err, ErrUnsupportedEncryptMechanism.Error())

// Test encrypt spreadsheet with invalid password
assert.EqualError(t, f.SaveAs(filepath.Join("test", "Encryption.xlsx"), Options{Password: strings.Repeat("*", MaxFieldLength+1)}), ErrPasswordLengthInvalid.Error())
// Test encrypt spreadsheet with new password
Expand All @@ -51,6 +59,11 @@ func TestEncryptionMechanism(t *testing.T) {
assert.EqualError(t, err, ErrUnknownEncryptMechanism.Error())
}

func TestEncryptionWriteDirectoryEntry(t *testing.T) {
cfb := cfb{}
assert.Equal(t, 1536, len(cfb.writeDirectoryEntry(0, 0, -1)))
}

func TestHashing(t *testing.T) {
assert.Equal(t, hashing("unsupportedHashAlgorithm", []byte{}), []byte(nil))
}
Expand Down
1 change: 1 addition & 0 deletions excelize.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ type Options struct {
// return
// }
//
// Close the file by Close function after opening the spreadsheet.
func OpenFile(filename string, opt ...Options) (*File, error) {
file, err := os.Open(filepath.Clean(filename))
if err != nil {
Expand Down
2 changes: 2 additions & 0 deletions stream_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ func TestStreamWriter(t *testing.T) {
}
assert.NoError(t, rows.Close())
assert.Equal(t, 2559558, cells)
// Save spreadsheet with password.
assert.NoError(t, file.SaveAs(filepath.Join("test", "EncryptionTestStreamWriter.xlsx"), Options{Password: "password"}))
assert.NoError(t, file.Close())
}

Expand Down

0 comments on commit a0396ed

Please sign in to comment.