Skip to content

Commit e021f7e

Browse files
committed
cleanup in preparation for public release:
- change signature to take password instead of callback - use native buffer operations instead of python-struct (much faster) - remove useless dependencies - add MIT license - cleanup files actually packed in package - other details
1 parent f77a122 commit e021f7e

9 files changed

+1270
-1959
lines changed

.gitlab-ci.yml

+1-6
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@ stages:
55
image: node:10
66

77
before_script:
8-
- echo "//nexus.tardis.seald.io/repository/npm/:_authToken=${AUTH_TOKEN}" > .npmrc
9-
- echo "//nexus.tardis.seald.io/repository/npm-hosted/:_authToken=${AUTH_TOKEN}" >> .npmrc
10-
- echo "registry=https://nexus.tardis.seald.io/repository/npm/" >> .npmrc
11-
- echo "@seald:registry=https://nexus.tardis.seald.io/repository/npm-hosted/" >> .npmrc
12-
- echo "always-auth=true" >> .npmrc
138
- npm ci --silent
149

1510
test:
@@ -27,4 +22,4 @@ deploy:
2722
- npm publish
2823
only:
2924
- tags
30-
allow_failure: false
25+
allow_failure: false

LICENSE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Seald
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
6+
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
7+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
8+
persons to whom the Software is furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
11+
Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
14+
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
15+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
16+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Waxing
2+
3+
`waxing` is a JS packages that decrypts password-protected Office documents.
4+
5+
## `decryptOLEDoc(buffer: Buffer, password: String): Promise<Buffer>`
6+
7+
This function takes a Buffer representing a password-protected Office document, a String containing the password, and
8+
returns a Buffer corresponding to the decrypted document.
9+
10+
In case the input Buffer corresponds to a non-encrypted Office document, it is returned as is.
11+
12+
In case the input Buffer is not an Office document at all, the promise is rejected with an Error.
13+
14+
## `isOLEDoc(buffer: Buffer): Boolean`
15+
16+
This function takes a Buffer, and returns a Boolean indicating whether or not this is an encrypted Office document.

0 commit comments

Comments
 (0)