Skip to content

Commit ec14f97

Browse files
eciavattaeciavatta
committed
Merge branch 'develop' into main
2 parents b54cee5 + 81ca96a commit ec14f97

40 files changed

+2280
-922
lines changed

‎.github/workflows/test.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
on: [ push, pull_request ]
2+
name: tests
3+
jobs:
4+
test:
5+
strategy:
6+
matrix:
7+
go-version: [ 1.15.x ]
8+
os: [ ubuntu-latest, macos-latest, windows-latest ]
9+
runs-on: ${{ matrix.os }}
10+
steps:
11+
- name: Install Go
12+
uses: actions/setup-go@v2
13+
with:
14+
go-version: ${{ matrix.go-version }}
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
- name: Run tests
18+
run: make test
19+
- name: Upload coverage to Codecov
20+
uses: codecov/codecov-action@v1
21+
if: matrix.os == 'ubuntu-latest' && matrix.go-version == '1.15.x'
22+
with:
23+
files: coverage.txt

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
.idea/
2+
dist/
3+
coverage.txt

‎LICENSE

+208
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+
203+
---------------
204+
205+
This software is a translation of sdhash into the golang language,
206+
which was originally written by Vassil Roussev and Candice Quates
207+
in 2013. The original license of sdhash has been inserted into the root
208+
of the project, under the name of SDHASH_LICENSE.

‎Makefile

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
VERSION := 4.0
2+
NAME := sdhash
3+
BUILDSTRING := $(shell git log --pretty=format:'%h' -n 1)
4+
VERSIONSTRING := $(VERSION)+$(BUILDSTRING)
5+
OUTPUT = dist/$(NAME)
6+
LDFLAGS := "-X \"main.Version=$(VERSIONSTRING)\""
7+
GOFILES := $(wildcard app/*.go)
8+
9+
default: build
10+
11+
.PHONY: build
12+
build: $(OUTPUT)
13+
14+
.PHONY: dist/$(NAME)
15+
$(OUTPUT):
16+
@mkdir -p dist/
17+
go build -o $(OUTPUT) -ldflags=$(LDFLAGS) -v $(GOFILES)
18+
19+
clean:
20+
rm -rf dist/
21+
22+
build_release: clean
23+
GOOS=darwin GOARCH=amd64 go build -o "dist/$(NAME)-darwin-amd64" -ldflags=$(LDFLAGS) $(GOFILES)
24+
GOOS=linux GOARCH=amd64 go build -o "dist/$(NAME)-linux-amd64" -ldflags=$(LDFLAGS) $(GOFILES)
25+
GOOS=windows GOARCH=amd64 go build -o "dist/$(NAME)-windows-amd64" -ldflags=$(LDFLAGS) $(GOFILES)
26+
27+
test:
28+
go test -v -coverprofile=coverage.txt -covermode=atomic .
29+
30+
coverage: test
31+
go tool cover -html=coverage.txt

‎README.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# sdhash
2+
3+
[![Tests](https://github.com/eciavatta/sdhash/workflows/tests/badge.svg)](https://github.com/eciavatta/sdhash/actions)
4+
[![codecov](https://codecov.io/gh/eciavatta/sdhash/branch/main/graph/badge.svg)](https://codecov.io/gh/eciavatta/sdhash)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/eciavatta/sdhash)](https://goreportcard.com/report/github.com/eciavatta/sdhash)
6+
[![GoDoc](https://pkg.go.dev/badge/github.com/eciavatta/sdhash?status.svg)](https://pkg.go.dev/github.com/eciavatta/sdhash?tab=doc)
7+
[![Release](https://img.shields.io/github/release/eciavatta/sdhash.svg)](https://github.com/eciavatta/sdhash/releases)
8+
![Language](https://img.shields.io/badge/language-go-blue)
9+
![License](https://img.shields.io/github/license/eciavatta/sdhash)
10+
11+
sdhash is a tool that processes binary data and produces similarity digests using bloom filters. Two binary files with
12+
common parts produces two similar digests. sdhash is able to compare the similarity digests to produce a score. A score
13+
close to 0 means that two file are very different, a score equals to 100 means that two file are equal.
14+
15+
## Features
16+
17+
- calculate similarity digests of many files in a short time
18+
- compare a large amount of digests using precalculated indexes
19+
- the comparison can also be made during the digest process
20+
- same results of original sdhash with similar performance, but entirely rewritten in go language
21+
22+
## Getting started
23+
24+
The sdhash package is available as binaries and as a library.
25+
26+
### Binaries
27+
28+
The binaries for all platforms are available on the [Releases](https://github.com/eciavatta/sdhash/releases) page.
29+
30+
### Library
31+
32+
1. Install sdhash package with the command below
33+
34+
```sh
35+
$ go get -u github.com/eciavatta/sdhash
36+
```
37+
38+
2. Import it in your code and start play around
39+
40+
```go
41+
package main
42+
43+
import (
44+
"fmt"
45+
"github.com/eciavatta/sdhash"
46+
)
47+
48+
func main() {
49+
factoryA, _ := sdhash.CreateSdbfFromFilename("a.bin")
50+
sdbfA := factoryA.Compute()
51+
52+
factoryB, _ := sdhash.CreateSdbfFromFilename("b.bin")
53+
sdbfB := factoryB.Compute()
54+
55+
fmt.Println(sdbfA.String())
56+
fmt.Println(sdbfB.String())
57+
fmt.Println(sdbfA.Compare(sdbfB))
58+
}
59+
```
60+
61+
## Documentation
62+
63+
The library documentation is published
64+
at [pkg.go.dev/github.com/eciavatta/sdhash](https://pkg.go.dev/github.com/eciavatta/sdhash). How sdhash works is
65+
described in [this paper](http://roussev.net/pubs/2010-IFIP--sdhash-design.pdf),
66+
and [here](http://roussev.net/sdhash/tutorial/sdhash-tutorial.html) you can find a tutorial of the original version of
67+
sdhash.
68+
69+
## License
70+
71+
sdhash is originally created by Vassil Roussev and Candice Quates and is licensed
72+
under [Apache-2.0 License](SDHASH_LICENSE). The implementation in golang was made
73+
by [Emiliano Ciavatta](https://eciavatta.dev) and is also licensed under
74+
[Apache-2.0 License](SDHASH_LICENSE).

0 commit comments

Comments
 (0)