Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
narbehaj committed Jun 16, 2024
1 parent be60001 commit 88e4656
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ You can simply go to [https://ssl-checker.io](https://ssl-checker.io) or use the

`curl https://ssl-checker.io/api/v1/check/example.com`


## Requirements

`pip install -r requirements.txt`

Or by pip installation:

`pip install python-ssl-checker`

## Usage

Expand Down Expand Up @@ -129,8 +130,6 @@ narbeh@narbeh-laptop:~/ssl-checker$ ./ssl_checker.py -H time.com github.com:443

NOTE: Keep in mind that if the certificate has less than 15 days of validity, the script will consider it as a warning in the summary.



## Censored?

No problem. Pass `-s/--socks` argument to the script with `HOST:PORT` format to connect through the SOCKS proxy.
Expand Down Expand Up @@ -266,11 +265,11 @@ cert_sn,338163108483756707389368573553026254634358

Finally, if you want to export JSON's output per host in a separate file, use `-J/--json-save`. This will export JSON's output per host.



# As a Python Module

Import the `ssl_checker.py` into your Python script and use it as a module.
Install with pip or import the `ssl_checker.py` into your Python script and use it as a module.

`pip install python-ssl-checker`

```python
from ssl_checker import SSLChecker
Expand All @@ -283,8 +282,6 @@ args = {
SSLChecker.show_result(SSLChecker.get_args(json_args=args))
```



# Docker

##### From the Docker Hub
Expand All @@ -308,4 +305,3 @@ $ docker run -it --rm ssl-checker -H twitter.com

- Make print_status cleaner and smarter
- Add certificate chain validation

0 comments on commit 88e4656

Please sign in to comment.