Skip to content

Commit b5e2da6

Browse files
committed
refactor: change default branch to main
1 parent 46f20ac commit b5e2da6

3 files changed

Lines changed: 40 additions & 22 deletions

File tree

.github/workflows/python_lint_test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: Run tests and lint
55

66
on:
77
push:
8-
branches: [ master, dev ]
8+
branches: [ main, dev ]
99
pull_request:
10-
branches: [ master ]
10+
branches: [ main ]
1111

1212
jobs:
1313
test-and-lint:

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
[![certleak logo created by https://t.me/AboutTheDot](https://raw.githubusercontent.com/d-Rickyy-b/certleak/master/docs/certleak_logo.png)](https://github.com/d-Rickyy-b/certleak)
1+
[![certleak logo created by https://t.me/AboutTheDot](https://raw.githubusercontent.com/d-Rickyy-b/certleak/main/docs/certleak_logo.png)](https://github.com/d-Rickyy-b/certleak)
22

33
# certleak - Cert-Monitoring Python Framework
44

55
[![Run tests and lint](https://github.com/d-Rickyy-b/certleak/workflows/Run%20tests%20and%20lint/badge.svg)](https://github.com/d-Rickyy-b/certleak/actions?query=workflow%3A%22Run+tests+and+lint%22)
66
[![PyPI version](https://badge.fury.io/py/certleak.svg)](https://pypi.org/project/certleak/)
7-
[![Coverage Status](https://coveralls.io/repos/github/d-Rickyy-b/certleak/badge.svg?branch=master)](https://coveralls.io/github/d-Rickyy-b/certleak?branch=master)
7+
[![Coverage Status](https://coveralls.io/repos/github/d-Rickyy-b/certleak/badge.svg?branch=main)](https://coveralls.io/github/d-Rickyy-b/certleak?branch=main)
88

99
Certleak is a tool to monitor and analyze TLS certificates as they are issued.
1010
It is heavily inspired by [Phishing Catcher](https://github.com/x0rz/phishing_catcher) by [x0rz](https://twitter.com/x0rz).
@@ -22,7 +22,7 @@ There is no way to use this tool to analyze certificates that have been issued i
2222

2323
Creating new analyzers or actions is as easy as creating a new python file.
2424
Certleak is built with extensibility in mind.
25-
Check the [analyzer docs](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/README.md) as well as the [actions docs](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/actions/README.md).
25+
Check the [analyzer docs](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/README.md) as well as the [actions docs](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/actions/README.md).
2626

2727
## Installation
2828

@@ -80,7 +80,7 @@ certleak.add_analyzer(letsencrypt_analyzer)
8080
certleak.start()
8181
```
8282

83-
You can find [full example files](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/examples) in this repo as well.
83+
You can find [full example files](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/examples) in this repo as well.
8484

8585
### License
8686

certleak/analyzers/README.md

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,79 @@
11
# Analyzers
2+
23
When CertStream found a new certificate update, it will be passed to all the registered analyzers.
34
Each analyzer either returns a boolean value, or a list of matches.
45

56
## Available Analyzers
67

7-
### [AlwaysTrueAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/alwaystrueanalyzer.py)
8+
### [AlwaysTrueAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/alwaystrueanalyzer.py)
9+
810
Analyzer that returns `True` for every certificate update
911

10-
### [BasicAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/basicanalyzer.py)
12+
### [BasicAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/basicanalyzer.py)
13+
1114
Base class for all analyzers
1215

13-
### [CAFingerprintAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/master/certleak/analyzers/cafingerprintanalyzer.py)
16+
### [CAFingerprintAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/main/certleak/analyzers/cafingerprintanalyzer.py)
17+
1418
Finds certificate updates that are signed by a CA with a specified fingerprint.
1519

16-
### [DNSTwistAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/dnstwistanalyzer.py)
20+
### [DNSTwistAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/dnstwistanalyzer.py)
21+
1722
Built on top of [dnstwist](https://github.com/elceef/dnstwist), this analyzer generates lists of permutated domans and matches the domains in each certificate update against them.
1823

19-
### [DomainRegexAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/domainregexanalyzer.py)
24+
### [DomainRegexAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/domainregexanalyzer.py)
25+
2026
Matches a given regex pattern against all the domain names contained in the certificate.
2127

22-
### [FullDomainAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/master/certleak/analyzers/fulldomainanalyzer.py)
28+
### [FullDomainAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/main/certleak/analyzers/fulldomainanalyzer.py)
29+
2330
Matches certificate updates that contain a specified word.
2431

25-
### [LetsEncryptAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/master/certleak/analyzers/letsencryptanalyzer.py)
32+
### [LetsEncryptAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/main/certleak/analyzers/letsencryptanalyzer.py)
33+
2634
Analyzer for finding certificate updates that are signed by Let's Encrypt.
2735

28-
### [PreCertAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/master/certleak/analyzers/precertanalyzer.py)
36+
### [PreCertAnalyzer](https://github.com/d-Rickyy-b/certleak/blob/main/certleak/analyzers/precertanalyzer.py)
37+
2938
Finds pre certificate updates. Can be used to exclude precerts.
3039

31-
### [RegexDomainAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/regexdomainanalyzer.py)
40+
### [RegexDomainAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/regexdomainanalyzer.py)
41+
3242
Probably the same as "DomainRegexAnalyzer" - TBD
3343

34-
### [SubDomainAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/subdomainanalyzer.py)
44+
### [SubDomainAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/subdomainanalyzer.py)
45+
3546
Filters certificate updates for certain subdomains. For example the subdomains `imap.` or `blog.`
3647

37-
### [TLDAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/tldanalyzer.py)
48+
### [TLDAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/tldanalyzer.py)
49+
3850
Finds certificate updates for domains of given TLDs. For example all domains ending with `.com`.
3951

40-
### [WildcardCertAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/wildcardcertanalyzer.py)
52+
### [WildcardCertAnalyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/wildcardcertanalyzer.py)
53+
4154
Finds all certificate updates with wildcard domains - For example `*.example.com`.
4255

43-
### [x509Analyzer](https://github.com/d-Rickyy-b/certleak/tree/master/certleak/analyzers/x509analyzer.py)
56+
### [x509Analyzer](https://github.com/d-Rickyy-b/certleak/tree/main/certleak/analyzers/x509analyzer.py)
57+
4458
Not all the certificates are x509 certs. This analyzer fiulters them. Best to be used in combination with other analyzers.
4559

4660
## Combining analyzers
47-
You can combine analyzers logically via AND, OR and a NOT operator.
61+
62+
You can combine analyzers logically via AND, OR and a NOT operator.
4863

4964
### AND
65+
5066
Use the ampersand (`&`) char to combine two analyzers with the logical AND operator.
5167

5268
### OR
69+
5370
Use the pipe (`|`) char to combine two analyzers with the logical OR operator.
5471

5572
### NOT
56-
Us the tilde (`~`) char to negate the result of an analyzer.
57-
73+
74+
Us the tilde (`~`) char to negate the result of an analyzer.
5875
For example: you want all matches of the TLD `.com` but not the ones matching `example.com`.
76+
5977
```python
6078
dotcomAnalyzer = TLDAnalyzer(actions, ".com")
6179
examplecomAnalyzer = FullDomainAnalyzer(actions=None, contained_words="example.com"):

0 commit comments

Comments
 (0)