17 | */
18 |
19 | package hash
20 |
21 | import (
22 | "crypto/md5"
23 | "crypto/sha1"
24 | "crypto/sha256"
25 | "crypto/sha512"
26 | "encoding/hex"
27 | "io"
28 | "log"
29 |
30 | "golang.org/x/crypto/blake2b"
31 | "golang.org/x/crypto/blake2s"
32 | "golang.org/x/crypto/md4" //nolint:staticcheck
33 | "golang.org/x/crypto/ripemd160" //nolint:staticcheck
34 | "golang.org/x/crypto/sha3"
35 | )
36 |
37 | // GetMD4Hash : Return MD4 hash of input.
38 | func GetMD4Hash(text string) string {
39 | h := md4.New()
40 |
41 | _, err := io.WriteString(h, text)
42 | if err != nil {
43 | log.Fatal(err)
44 | }
45 |
46 | return hex.EncodeToString(h.Sum(nil))
47 | }
48 |
49 | // GetMD5Hash : Return MD5 hash of input.
50 | func GetMD5Hash(text string) string {
51 | hash := md5.Sum([]byte(text))
52 | return hex.EncodeToString(hash[:])
53 | }
54 |
55 | // GetSHA1Hash : Return SHA1 hash of input.
56 | func GetSHA1Hash(text string) string {
57 | hash := sha1.Sum([]byte(text))
58 | return hex.EncodeToString(hash[:])
59 | }
60 |
61 | // GetRipemd160Hash : Return Ripemd160 hash of input.
62 | func GetRipemd160Hash(text string) string {
63 | hasher := ripemd160.New()
64 | hasher.Write([]byte(text))
65 | hash := hasher.Sum(nil)
66 |
67 | return hex.EncodeToString(hash)
68 | }
69 |
70 | // GetSHA224Hash : Return SHA224 hash of input.
71 | func GetSHA224Hash(text string) string {
72 | hash := sha256.Sum224([]byte(text))
73 | return hex.EncodeToString(hash[:])
74 | }
75 |
76 | // GetSHA256Hash : Return SHA256 hash of input.
77 | func GetSHA256Hash(text string) string {
78 | hash := sha256.Sum256([]byte(text))
79 | return hex.EncodeToString(hash[:])
80 | }
81 |
82 | // GetSHA384Hash : Return SHA384 hash of input.
83 | func GetSHA384Hash(text string) string {
84 | hash := sha512.Sum384([]byte(text))
85 | return hex.EncodeToString(hash[:])
86 | }
87 |
88 | // GetSHA512Hash : Return SHA512 hash of input.
89 | func GetSHA512Hash(text string) string {
90 | hash := sha512.Sum512([]byte(text))
91 | return hex.EncodeToString(hash[:])
92 | }
93 |
94 | // GetSHA3224Hash : Return SHA3 224 hash of input.
95 | func GetSHA3224Hash(text string) string {
96 | hash := sha3.Sum224([]byte(text))
97 | return hex.EncodeToString(hash[:])
98 | }
99 |
100 | // GetSHA3256Hash : Return SHA3 256 hash of input.
101 | func GetSHA3256Hash(text string) string {
102 | hash := sha3.Sum256([]byte(text))
103 | return hex.EncodeToString(hash[:])
104 | }
105 |
106 | // GetSHA3384Hash : Return SHA3 384 hash of input.
107 | func GetSHA3384Hash(text string) string {
108 | hash := sha3.Sum384([]byte(text))
109 | return hex.EncodeToString(hash[:])
110 | }
111 |
112 | // GetSHA3512Hash : Return SHA3 512 hash of input.
113 | func GetSHA3512Hash(text string) string {
114 | hash := sha3.Sum512([]byte(text))
115 | return hex.EncodeToString(hash[:])
116 | }
117 |
118 | // GetBlake2b256Hash : Return Blake2b256 hash of input.
119 | func GetBlake2b256Hash(text string) string {
120 | hash := blake2b.Sum256([]byte(text))
121 | return hex.EncodeToString(hash[:])
122 | }
123 |
124 | // GetBlake2b384Hash : Return Blake2b384 hash of input.
125 | func GetBlake2b384Hash(text string) string {
126 | hash := blake2b.Sum384([]byte(text))
127 | return hex.EncodeToString(hash[:])
128 | }
129 |
130 | // GetBlake2b512Hash : Return Blake2b512 hash of input.
131 | func GetBlake2b512Hash(text string) string {
132 | hash := blake2b.Sum512([]byte(text))
133 | return hex.EncodeToString(hash[:])
134 | }
135 |
136 | // GetBlake2s256Hash : Return Blake2s256 hash of input.
137 | func GetBlake2s256Hash(text string) string {
138 | hash := blake2s.Sum256([]byte(text))
139 | return hex.EncodeToString(hash[:])
140 | }
141 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 | Command line tool that checks how much a password is safe
5 |
6 | Coded with 💙 by edoardottt.
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 | Get Started •
44 | Description •
45 | Scoring •
46 | Contributing •
47 | Changelog
48 |
49 |
50 |
51 | 
52 |
53 |
54 | **This tool doesn't store any information!**
55 | **Never use personal information in your password!**
56 |
57 | - Use a password manager (I recommend [bitwarden](https://bitwarden.com/))
58 | - Don't use the same password for different services
59 | - Enable 2FA wherever possible
60 |
61 |
62 |
63 | Get Started 🎉
64 | ----------
65 |
66 | ### Snap
67 |
68 | ```console
69 | sudo snap install pwdsafety
70 | ```
71 |
72 | ### Go1.17+
73 |
74 | ```console
75 | go install -v github.com/edoardottt/pwdsafety/cmd/pwdsafety@latest
76 | ```
77 |
78 | ### From source
79 |
80 | - First of all, clone the repo locally
81 |
82 | - `git clone https://github.com/edoardottt/pwdsafety.git`
83 |
84 | - pwdsafety has external dependencies, so they need to be pulled in:
85 |
86 | - `cd pwdsafety/cmd && go get && cd ..`
87 |
88 | - Linux (Requires high perms, run with sudo)
89 |
90 | - `make linux` (to install)
91 |
92 | - `make unlinux` (to uninstall)
93 |
94 | - Windows (executable works only in pwdsafety folder. Alias?)
95 |
96 | - `make windows` (to install)
97 |
98 | - `make unwindows` (to uninstall)
99 |
100 | Description 🔦
101 | ----------
102 |
103 | It reads from standard input the entered password.
104 | First, it searches if the password or the password reversed is a well known pwd.
105 | Then, just do little calculations, checking if the basic rules are respected, like if there are UPPERCASE CHARS, lowercase chars, numb3rs and symbols.
106 | It stores the length of the password and the ratio [unique different chars / total chars].
107 | It calculates then the entropy of a password.
108 | Password entropy is a measurement of how unpredictable a password is.
109 | The formula for entropy is:
110 | 
111 |
112 | Where:
113 |
114 | - E = password entropy
115 | - R = pool of unique characters
116 | - L = number of characters in your password
117 | - Then R^L = the number of possible passwords
118 |
119 | When the score <= 68(reasonable) it generates a random password.
120 |
121 | Scoring 💯
122 | ----------
123 |
124 | **Max score: 100**
125 |
126 | **Scores:**
127 |
128 | - Very weak: 0 - 35
129 | - Weak: 36 - 59
130 | - Reasonable: 60 - 68
131 | - Strong: 69 - 80
132 | - Very strong: 81 -100
133 |
134 | **Scoring parameters:**
135 |
136 | - Found in known password
137 | - Found in known password reversed
138 | - Password composition:
139 | - numbers
140 | - symbols
141 | - uppercase
142 | - lowercase
143 | - Unique different characters
144 | - Length
145 | - Entropy
146 |
147 | Contributing 🛠
148 | -------
149 |
150 | Just open an [issue](https://github.com/edoardottt/pwdsafety/issues) / [pull request](https://github.com/edoardottt/pwdsafety/pulls).
151 |
152 | Before opening a pull request, download [golangci-lint](https://golangci-lint.run/usage/install/) and run
153 |
154 | ```console
155 | golangci-lint run
156 | ```
157 |
158 | If there aren't errors, go ahead :)
159 |
160 | See also [CONTRIBUTING.md](https://github.com/edoardottt/pwdsafety/blob/master/CONTRIBUTING.md) and [CODE OF CONDUCT.md](https://github.com/edoardottt/pwdsafety/blob/master/CODE_OF_CONDUCT.md)
161 |
162 | Thanks to [fabaff](https://github.com/fabaff) and [ecnepsnai](https://github.com/ecnepsnai/pwnedpassword/blob/master/pwned.go).
163 |
164 | Changelog 📌
165 | -------
166 |
167 | Detailed changes for each release are documented in the [release notes](https://github.com/edoardottt/pwdsafety/releases).
168 |
169 | License 📝
170 | -------
171 |
172 | This repository is under [GNU General Public License v3.0](https://github.com/edoardottt/pwdsafety/blob/master/LICENSE).
173 | [edoardottt.com](https://edoardottt.com/) to contact me.
174 |
--------------------------------------------------------------------------------
/pkg/scoring/scoring_test.go:
--------------------------------------------------------------------------------
1 | /*
2 | * This program is free software: you can redistribute it and/or modify
3 | * it under the terms of the GNU Public License as published
4 | * by the Free Software Foundation, either version 3 of the License, or
5 | * (at your option) any later version.
6 | *
7 | * This program is distributed in the hope that it will be useful,
8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 | * GNU General Public License for more details.
11 | *
12 | * You should have received a copy of the GNU General Public License
13 | * along with this program. If not, see .
14 | *
15 | * Author:
16 | * Edoardo Ottavianelli
17 | */
18 |
19 | package scoring_test
20 |
21 | import (
22 | "fmt"
23 | "strconv"
24 | "testing"
25 |
26 | "github.com/edoardottt/pwdsafety/pkg/scoring"
27 | )
28 |
29 | // Test if two slices of bytes are equal.
30 | func testEqRune(a, b []rune) bool {
31 | // If one is nil, the other must also be nil.
32 | if (a == nil) != (b == nil) {
33 | return false
34 | }
35 |
36 | if len(a) != len(b) {
37 | return false
38 | }
39 |
40 | for i := range a {
41 | if a[i] != b[i] {
42 | return false
43 | }
44 | }
45 |
46 | return true
47 | }
48 |
49 | // Test the correct operation of GenerateSetString func.
50 | func TestGenerateSetString(t *testing.T) {
51 | var tests = []struct {
52 | input string
53 | expected []rune
54 | }{
55 | {"hellohello", []rune{'h', 'e', 'l', 'o'}},
56 | {"", []rune{}},
57 | {"abcdefghijklmnopqrstuvwxyz", []rune{'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k',
58 | 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'}},
59 | {"blablablablabla", []rune{'b', 'l', 'a'}},
60 | {" !#$%&()*", []rune{' ', '!', '#', '$', '%', '&', '(', ')', '*'}},
61 | {"+,-./:;`{|}~_", []rune{'=', '>', '`', '{', '|', '}', '~', '_'}},
63 | }
64 |
65 | for _, test := range tests {
66 | if output := scoring.GenerateSetString(test.input); !testEqRune(test.expected, output) {
67 | errorString := fmt.Sprintf("Test Failed: %s inputted, %d expected, received: %d", test.input, test.expected, output)
68 | t.Error(errorString)
69 | }
70 | }
71 | }
72 |
73 | // Test the correct operation of HowManyDifferents func.
74 | func TestHowManyDifferents(t *testing.T) {
75 | var tests = []struct {
76 | input string
77 | expected int
78 | }{
79 | {"hellohello", 4},
80 | {"", 0},
81 | {"abcdefghijklmnopqrstuvwxyz", 26},
82 | {"blablablablabla", 3},
83 | {".,:;-_à#ç@", 10},
84 | }
85 |
86 | for _, test := range tests {
87 | if output := scoring.HowManyDifferents(test.input); output != test.expected {
88 | errorString := fmt.Sprintf("Test Failed: %s inputted, %d expected, received: %d", test.input, test.expected, output)
89 | t.Error(errorString)
90 | }
91 | }
92 | }
93 |
94 | // Test the correct operation of IsThereUpperCase func.
95 | func TestIsThereUpperCase(t *testing.T) {
96 | var tests = []struct {
97 | input string
98 | expected bool
99 | }{
100 | {"hellohello", false},
101 | {"", false},
102 | {"abcdefghijklmnopqrstuvwxyz", false},
103 | {"blablaBlablablB", true},
104 | {".,:;-A_à#ç@", true},
105 | }
106 |
107 | for _, test := range tests {
108 | if output := scoring.IsThereUpperCase(test.input); output != test.expected {
109 | errorString := fmt.Sprintf("Test Failed: %s inputted, %s expected, received: %s",
110 | test.input, strconv.FormatBool(test.expected), strconv.FormatBool(output))
111 | t.Error(errorString)
112 | }
113 | }
114 | }
115 |
116 | // Test the correct operation of IsThereLowerCase func.
117 | func TestIsThereLowerCase(t *testing.T) {
118 | var tests = []struct {
119 | input string
120 | expected bool
121 | }{
122 | {"hellohello", true},
123 | {"", false},
124 | {"ABCDEFGHIJKLMNOPQRSTUVWXYZ", false},
125 | {"blablaBlablablB", true},
126 | {".,:;-A_à#ç@", false},
127 | }
128 |
129 | for _, test := range tests {
130 | if output := scoring.IsThereLowerCase(test.input); output != test.expected {
131 | errorString := fmt.Sprintf("Test Failed: %s inputted, %s expected, received: %s",
132 | test.input, strconv.FormatBool(test.expected), strconv.FormatBool(output))
133 | t.Error(errorString)
134 | }
135 | }
136 | }
137 |
138 | // Test the correct operation of IsThereSymbol func.
139 | func TestIsThereSymbol(t *testing.T) {
140 | var tests = []struct {
141 | input string
142 | expected bool
143 | }{
144 | {"hellohello", false},
145 | {"", false},
146 | {"ABCDEFGHIJKLMNOPQRSTUVWXYZ", false},
147 | {"blablaBlabl,ablB", true},
148 | {".,:;-A_à#ç@", true},
149 | }
150 |
151 | for _, test := range tests {
152 | if output := scoring.IsThereSymbol(test.input); output != test.expected {
153 | errorString := fmt.Sprintf("Test Failed: %s inputted, %s expected, received: %s",
154 | test.input, strconv.FormatBool(test.expected), strconv.FormatBool(output))
155 | t.Error(errorString)
156 | }
157 | }
158 | }
159 |
160 | // Test the correct operation of IsThereNumber func.
161 | func TestIsThereNumber(t *testing.T) {
162 | var tests = []struct {
163 | input string
164 | expected bool
165 | }{
166 | {"hellohello", false},
167 | {"", false},
168 | {"ABCDEFGHIJKLMNOPQRSTUVWXYZ", false},
169 | {"blabla0Blabl,ablB", true},
170 | {".,:;-A_à#ç@", false},
171 | }
172 |
173 | for _, test := range tests {
174 | if output := scoring.IsThereNumber(test.input); output != test.expected {
175 | errorString := fmt.Sprintf("Test Failed: %s inputted, %s expected, received: %s",
176 | test.input, strconv.FormatBool(test.expected), strconv.FormatBool(output))
177 | t.Error(errorString)
178 | }
179 | }
180 | }
181 |
182 | // Test the correct operation of HowManyTypes func.
183 | func TestHowManyTypes(t *testing.T) {
184 | var tests = []struct {
185 | input string
186 | expected int
187 | }{
188 | {"hellohello", 1},
189 | {"", 0},
190 | {"ABCDEFGHIJKLMNOPQRSTUVWXYZ", 1},
191 | {"blabla0Blabl,ablB", 4},
192 | {".,:;-A1_à#ç@", 3},
193 | }
194 |
195 | for _, test := range tests {
196 | if output := scoring.HowManyTypes(test.input); output != test.expected {
197 | errorString := fmt.Sprintf("Test Failed: %s inputted, %d expected, received: %d",
198 | test.input, test.expected, output)
199 | t.Error(errorString)
200 | }
201 | }
202 | }
203 |
--------------------------------------------------------------------------------
/pkg/scoring/scoring.go:
--------------------------------------------------------------------------------
1 | /*
2 | * This program is free software: you can redistribute it and/or modify
3 | * it under the terms of the GNU Public License as published
4 | * by the Free Software Foundation, either version 3 of the License, or
5 | * (at your option) any later version.
6 | *
7 | * This program is distributed in the hope that it will be useful,
8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 | * GNU General Public License for more details.
11 | *
12 | * You should have received a copy of the GNU General Public License
13 | * along with this program. If not, see .
14 | *
15 | * Author:
16 | * Edoardo Ottavianelli
17 | */
18 |
19 | package scoring
20 |
21 | import (
22 | "crypto/sha1"
23 | "fmt"
24 | "io"
25 | "math"
26 | "math/rand"
27 | "net/http"
28 | "os"
29 | "strconv"
30 | "strings"
31 | "time"
32 | "unicode/utf8"
33 | )
34 |
35 | const (
36 | centurySeconds float64 = 3110400000
37 | decadeSeconds float64 = 311040000
38 | yearSeconds float64 = 31104000
39 | monthSeconds float64 = 2592000
40 | daySeconds float64 = 86400
41 | hourSeconds float64 = 3600
42 | minuteSeconds float64 = 60
43 | )
44 |
45 | // GenerateSetString : Generates a set of unique characters in the input string.
46 | func GenerateSetString(input string) []rune {
47 | set := map[rune]bool{}
48 | result := []rune{}
49 |
50 | for len(input) > 0 {
51 | char, size := utf8.DecodeRuneInString(input)
52 | existence := set[char]
53 |
54 | if !existence {
55 | set[char] = true // add element
56 | result = append(result, char)
57 | }
58 |
59 | input = input[size:]
60 | }
61 |
62 | return result
63 | }
64 |
65 | // HowManyDifferents : Returns the number of differents characters used in password.
66 | func HowManyDifferents(password string) int {
67 | return len(GenerateSetString(password))
68 | }
69 |
70 | // IsThereUpperCase : Checks if there is at least one UPPERCASE character.
71 | func IsThereUpperCase(password string) bool {
72 | for _, r := range password {
73 | if r >= 'A' && r <= 'Z' {
74 | return true
75 | }
76 | }
77 |
78 | return false
79 | }
80 |
81 | // IsThereLowerCase : Checks if there is at least one lowercase character.
82 | func IsThereLowerCase(password string) bool {
83 | for _, r := range password {
84 | if r >= 'a' && r <= 'z' {
85 | return true
86 | }
87 | }
88 |
89 | return false
90 | }
91 |
92 | // IsThereSymbol : Checks if there is at least one symbol.
93 | func IsThereSymbol(password string) bool {
94 | for _, r := range password {
95 | if (r < 'A' || r > 'z') && (r < '0' || r > '9') {
96 | return true
97 | }
98 | }
99 |
100 | return false
101 | }
102 |
103 | // IsThereNumber : Checks if there is at least one number.
104 | func IsThereNumber(password string) bool {
105 | for _, r := range password {
106 | if r >= '0' && r <= '9' {
107 | return true
108 | }
109 | }
110 |
111 | return false
112 | }
113 |
114 | // HowManyTypes : Returns how many different types there are in the password.
115 | func HowManyTypes(password string) int {
116 | var howMany int
117 | if IsThereNumber(password) {
118 | howMany++
119 | }
120 |
121 | if IsThereUpperCase(password) {
122 | howMany++
123 | }
124 |
125 | if IsThereLowerCase(password) {
126 | howMany++
127 | }
128 |
129 | if IsThereSymbol(password) {
130 | howMany++
131 | }
132 |
133 | return howMany
134 | }
135 |
136 | // Entropy computes the entropy of a password.
137 | func Entropy(password string) float64 {
138 | var E float64
139 |
140 | var pool float64 = 95
141 |
142 | length := float64(len(password))
143 | E = -(math.Log2(1 / (math.Pow(pool, length))))
144 |
145 | return E
146 | }
147 |
148 | // CountTypeElements : Counts the different types in password.
149 | func CountTypeElements(input string) map[string]float64 {
150 | res := map[string]float64{"lower": 0, "number": 0, "symbol": 0, "upper": 0}
151 |
152 | for i := 0; i < len(input); i++ {
153 | r := input[i]
154 | if r >= 'A' && r <= 'Z' { // IF UPPERCASE.
155 | res["upper"]++
156 | }
157 |
158 | if r >= 'a' && r <= 'z' { // if lowercase.
159 | res["lower"]++
160 | }
161 |
162 | if (r < 'A' || r > 'z') && (r < '0' || r > '9') { // if numb3r.
163 | res["symbol"]++
164 | }
165 |
166 | if r >= '0' && r <= '9' { // if symbol.
167 | res["number"]++
168 | }
169 | }
170 |
171 | return res
172 | }
173 |
174 | // Round : Round in a clever way float64 numbers.
175 | func Round(input string) float64 {
176 | value, err := strconv.ParseFloat(input, 64)
177 | if err != nil {
178 | panic(err)
179 | }
180 |
181 | if math.Mod(value, 1) == 0 {
182 | v, err := strconv.ParseFloat(fmt.Sprintf("%.0f", value), 64)
183 | if err != nil {
184 | panic(err)
185 | }
186 |
187 | value = v
188 | }
189 |
190 | return value
191 | }
192 |
193 | // CrackTime : Returns the seconds needed to crack the password.
194 | func CrackTime(password string) float64 {
195 | const GPU float64 = 1000000000
196 |
197 | var (
198 | bots float64 = 15000
199 | pool float64 = 0
200 | KPS = bots * GPU
201 | )
202 |
203 | var combinations float64
204 |
205 | length := float64(len(password))
206 |
207 | if IsThereLowerCase(password) {
208 | pool += 26
209 | }
210 |
211 | if IsThereUpperCase(password) {
212 | pool += 26
213 | }
214 |
215 | if IsThereNumber(password) {
216 | pool += 10
217 | }
218 |
219 | if IsThereSymbol(password) {
220 | pool += 33
221 | }
222 |
223 | combinations = math.Pow(pool, length)
224 |
225 | return combinations / KPS
226 | }
227 |
228 | // ShowCrackTime : Beautify the crack time (from seconds to human readable string).
229 | func ShowCrackTime(crackTime float64) string {
230 | if crackTime <= 1 {
231 | return "less than one second."
232 | }
233 |
234 | var (
235 | Result string
236 | remainder float64
237 | seconds float64
238 | minutes float64
239 | hours float64
240 | days float64
241 | months float64
242 | years float64
243 | decades float64
244 | centuries float64
245 | secondsStr string
246 | minutesStr string
247 | hoursStr string
248 | daysStr string
249 | monthsStr string
250 | yearsStr string
251 | decadesStr string
252 | centuriesStr string
253 | )
254 |
255 | centuries = crackTime / centurySeconds
256 | remainder = math.Mod(crackTime, centurySeconds)
257 | decades = remainder / decadeSeconds
258 | remainder = math.Mod(remainder, decadeSeconds)
259 | years = remainder / yearSeconds
260 | remainder = math.Mod(remainder, yearSeconds)
261 | months = remainder / monthSeconds
262 | remainder = math.Mod(remainder, monthSeconds)
263 | days = remainder / daySeconds
264 | remainder = math.Mod(remainder, daySeconds)
265 | hours = remainder / hourSeconds
266 | remainder = math.Mod(remainder, hourSeconds)
267 | minutes = remainder / minuteSeconds
268 | seconds = math.Mod(remainder, minuteSeconds)
269 |
270 | if centuries > 1 {
271 | centuriesStr = strconv.Itoa(int(centuries)) + " Centuries, "
272 | Result += centuriesStr
273 | }
274 |
275 | if decades > 1 {
276 | decadesStr = strconv.Itoa(int(decades)) + " Decades, "
277 | Result += decadesStr
278 | }
279 |
280 | if years > 1 {
281 | yearsStr = strconv.Itoa(int(years)) + " Years, "
282 | Result += yearsStr
283 | }
284 |
285 | if months > 1 {
286 | monthsStr = strconv.Itoa(int(months)) + " Months, "
287 | Result += monthsStr
288 | }
289 |
290 | if days > 1 {
291 | daysStr = strconv.Itoa(int(days)) + " Days, "
292 | Result += daysStr
293 | }
294 |
295 | if hours > 1 {
296 | hoursStr = strconv.Itoa(int(hours)) + " Hours, "
297 | Result += hoursStr
298 | }
299 |
300 | if minutes > 1 {
301 | minutesStr = strconv.Itoa(int(minutes)) + " Minutes, "
302 | Result += minutesStr
303 | }
304 |
305 | if seconds > 1 {
306 | secondsStr = strconv.Itoa(int(seconds)) + " Seconds, "
307 | Result += secondsStr
308 | }
309 |
310 | runes := []rune(Result)
311 | Result = string(runes[0 : len(Result)-2])
312 |
313 | return Result + "."
314 | }
315 |
316 | // Result describes a result from the Pwned Password service.
317 | type Result struct {
318 | // Pwned has the password been seen at least once. A value of false doesn't mean the password is any good though.
319 | Pwned bool
320 | // TimesObserved the number of times this password has been seen by the pwned password service.
321 | TimesObserved uint64
322 | }
323 |
324 | type pwnedHash struct {
325 | Hash string
326 | Range string
327 | }
328 |
329 | // IsPwned will synchronously check if the provided password has been pwned.
330 | func IsPwned(password string) (*Result, error) {
331 | if password == "" {
332 | return nil, fmt.Errorf("%w", ErrEmptyPwd)
333 | }
334 |
335 | hash, err := getHash(password)
336 | if err != nil {
337 | return nil, err
338 | }
339 |
340 | resp, err := http.Get("https://api.pwnedpasswords.com/range/" + hash.Range)
341 | if err != nil {
342 | return nil, err
343 | }
344 |
345 | defer resp.Body.Close()
346 |
347 | body, err := io.ReadAll(resp.Body)
348 | if err != nil {
349 | return nil, err
350 | }
351 |
352 | lines := strings.Split(string(body), "\r\n")
353 | for _, line := range lines {
354 | components := strings.Split(line, ":")
355 | if len(components) != 2 {
356 | return nil, fmt.Errorf("%w", ErrInvalidPwnedAPIResponse)
357 | }
358 |
359 | resultHash := components[0]
360 | countStr := components[1]
361 |
362 | if hash.Range+resultHash == hash.Hash {
363 | count, err := strconv.ParseUint(countStr, 10, 64)
364 | if err != nil {
365 | return nil, err
366 | }
367 |
368 | ret := Result{
369 | Pwned: true,
370 | TimesObserved: count,
371 | }
372 |
373 | return &ret, nil
374 | }
375 | }
376 |
377 | ret := Result{
378 | Pwned: false,
379 | TimesObserved: 0,
380 | }
381 |
382 | return &ret, nil
383 | }
384 |
385 | func getHash(password string) (*pwnedHash, error) {
386 | h := sha1.New()
387 |
388 | _, err := io.WriteString(h, password)
389 | if err != nil {
390 | return nil, err
391 | }
392 |
393 | hash := fmt.Sprintf("%x", h.Sum(nil))
394 | hash = strings.ToUpper(hash)
395 |
396 | minHasLength := 5
397 | if len(hash) < minHasLength {
398 | return nil, fmt.Errorf("%w", ErrUnableHashPwd)
399 | }
400 |
401 | result := pwnedHash{
402 | Hash: hash,
403 | Range: hash[0:5],
404 | }
405 |
406 | return &result, nil
407 | }
408 |
409 | // Reverse : Reverse the input string.
410 | func Reverse(s string) string {
411 | runes := []rune(s)
412 | for i, j := 0, len(runes)-1; i < j; i, j = i+1, j-1 {
413 | runes[i], runes[j] = runes[j], runes[i]
414 | }
415 |
416 | return string(runes)
417 | }
418 |
419 | // GenerateRandom : Generate a strong random password.
420 | func GenerateRandom(length int) string {
421 | var (
422 | lowerCharSet = "abcdefghijklmnopqrstuvwxyz"
423 | upperCharSet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
424 | specialCharSet = "!@#$%&*-_+-=)("
425 | numberSet = "0123456789"
426 | )
427 |
428 | r := rand.New(rand.NewSource(time.Now().UnixNano()))
429 |
430 | var (
431 | randomPwd = ""
432 | choices = 4
433 | )
434 |
435 | for i := 0; i < length; i++ {
436 | switch choice := r.Intn(choices); choice {
437 | case 0:
438 | leng := len(lowerCharSet)
439 | index := r.Intn(leng)
440 | elem := lowerCharSet[index]
441 | randomPwd += string(elem)
442 | case 1:
443 | leng := len(upperCharSet)
444 | index := r.Intn(leng)
445 | elem := upperCharSet[index]
446 | randomPwd += string(elem)
447 | case 2:
448 | leng := len(specialCharSet)
449 | index := r.Intn(leng)
450 | elem := specialCharSet[index]
451 | randomPwd += string(elem)
452 | case 3:
453 | leng := len(numberSet)
454 | index := r.Intn(leng)
455 | elem := numberSet[index]
456 | randomPwd += string(elem)
457 | default:
458 | leng := len(lowerCharSet)
459 | index := r.Intn(leng)
460 | elem := lowerCharSet[index]
461 | randomPwd += string(elem)
462 | }
463 | }
464 |
465 | return randomPwd
466 | }
467 |
468 | /*
469 | LengthScore :
470 | Scores password's length
471 |
472 | total = 30
473 | length<=7 = 0
474 | length==8 = 4
475 | length==9 = 10
476 | 10 <= length <= 15 = 15
477 | 16 <= length <= 19 = 21
478 | 20 <= length <= 24 = 26
479 | length >=25 = 30.
480 | */
481 | func LengthScore(password string) float64 {
482 | length := len(password)
483 | if length <= 7 {
484 | return 0
485 | }
486 |
487 | if length == 8 {
488 | return 4
489 | }
490 |
491 | if length == 9 {
492 | return 10
493 | }
494 |
495 | if length > 9 && length < 16 {
496 | return 15
497 | }
498 |
499 | if length > 15 && length < 20 {
500 | return 21
501 | }
502 |
503 | if length > 19 && length < 25 {
504 | return 26
505 | }
506 |
507 | return 30
508 | }
509 |
510 | /*
511 | CompositionPwdScore :
512 | Scores password's composition
513 |
514 | total = 20
515 | There is numbers = 5
516 | There is symbol = 5
517 | There is uppercase = 5
518 | There is lowercase = 5.
519 | */
520 | func CompositionPwdScore(password string) float64 {
521 | var result int
522 |
523 | numbers := IsThereNumber(password)
524 | upper := IsThereUpperCase(password)
525 | lower := IsThereLowerCase(password)
526 | symbols := IsThereSymbol(password)
527 |
528 | if numbers {
529 | result += 5
530 | }
531 |
532 | if upper {
533 | result += 5
534 | }
535 |
536 | if lower {
537 | result += 5
538 | }
539 |
540 | if symbols {
541 | result += 5
542 | }
543 |
544 | return float64(result)
545 | }
546 |
547 | /*
548 | DifferentCharScore :
549 | Scores How many different chars in relation to the length
550 |
551 | total = 15
552 | n = (different_chars*total)/total_chars
553 | */
554 | func DifferentCharScore(password string) float64 {
555 | diffChars := HowManyDifferents(password)
556 | total := len(password)
557 |
558 | if total == 0 {
559 | return 0
560 | }
561 |
562 | return float64((diffChars * 15) / total)
563 | }
564 |
565 | /*
566 | EntropyScore :
567 | Scores Entropy's password
568 |
569 | total = 35
570 | < 28 bits = 3
571 | 28 - 35 bits = 8
572 | 36 - 59 bits = 20
573 | 60 - 80 bits = 24
574 | 81 - 120 bits = 28
575 | 120+ bits = 35.
576 | */
577 | func EntropyScore(password string) float64 {
578 | entropy := Entropy(password)
579 | entropyScore := (entropy * 35) / 130
580 |
581 | if entropyScore > 35 {
582 | return 35
583 | }
584 |
585 | return entropyScore
586 | }
587 |
588 | /*
589 | pwnedPwds returns the scores for pwned password and
590 | reversed password.
591 |
592 | Found : -30
593 | Not Found : 0
594 |
595 | Found (Reversed): -10
596 | Not Found (Reversed): 0.
597 | */
598 | func pwnedPwds(password string) (float64, float64) {
599 | var (
600 | scoreKnownPwd, scoreKnownPwdReverse float64
601 | knownPwd, knownPwdReverse *Result
602 | )
603 |
604 | // check if password is into known leaked passwords
605 | knownPwd, err := IsPwned(password)
606 | if err != nil {
607 | fmt.Println("Error while retrieving data on password...")
608 | os.Exit(1)
609 | }
610 |
611 | knownPwdReverse, err = IsPwned(Reverse(password))
612 | if err != nil {
613 | fmt.Println("Error while retrieving data on password...")
614 | os.Exit(1)
615 | }
616 |
617 | if knownPwd.Pwned {
618 | scoreKnownPwd = -30
619 | } else {
620 | scoreKnownPwd = 0
621 | }
622 |
623 | if knownPwdReverse.Pwned {
624 | scoreKnownPwdReverse = -10
625 | } else {
626 | scoreKnownPwdReverse = 0
627 | }
628 |
629 | return scoreKnownPwd, scoreKnownPwdReverse
630 | }
631 |
632 | // Grader : Return the score of the password.
633 | func Grader(words [][]string, password string) float64 {
634 | var (
635 | optimalLength = 27
636 | optimalDifferentCharScore float64 = 7
637 | knownStr string
638 | knownStrReverse string
639 | scoreKnownPwd float64
640 | scoreKnownPwdReverse float64
641 | )
642 |
643 | scoreKnownPwd, scoreKnownPwdReverse = pwnedPwds(password)
644 | lengthScore := LengthScore(password)
645 | compositionPwdScore := CompositionPwdScore(password)
646 | differentCharScore := DifferentCharScore(password)
647 | entropyScore := EntropyScore(password)
648 |
649 | // Printing results.
650 | if scoreKnownPwd != 0 {
651 | knownStr = "Yes (-30)"
652 | } else {
653 | knownStr = "No"
654 | }
655 |
656 | if scoreKnownPwdReverse != 0 {
657 | knownStrReverse = "Yes (-10)"
658 | } else {
659 | knownStrReverse = "No"
660 | }
661 |
662 | fmt.Println("[%] Password found in known leaked passwords: " + knownStr)
663 | fmt.Println("[%] Password (reversed) found in known leaked passwords: " + knownStrReverse)
664 | fmt.Println("[%] Length Score: " + fmt.Sprint(lengthScore) + "/30")
665 | fmt.Println("[%] Composition Score: " + fmt.Sprint(compositionPwdScore) + "/20")
666 | fmt.Println("[%] Unique chars Score: " + fmt.Sprint(differentCharScore) + "/15")
667 |
668 | entropyRounded := Round(fmt.Sprintf("%.2f", entropyScore))
669 | fmt.Println("[%] Entropy Score: " + fmt.Sprint(entropyRounded) + "/35")
670 |
671 | score := scoreKnownPwd + scoreKnownPwdReverse + lengthScore + compositionPwdScore + differentCharScore + entropyScore
672 |
673 | // if it's an optimal password by very high length and good different/unique ratio score.
674 | if differentCharScore >= optimalDifferentCharScore && len(password) > optimalLength {
675 | return 100
676 | }
677 |
678 | if score > 0 {
679 | return score
680 | }
681 |
682 | return 0
683 | }
684 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------