https://github.com/spatie/mixed-content-scanner-cli
A cli tool to check your site for mixed content
https://github.com/spatie/mixed-content-scanner-cli
command-line developer-tools mixed-content-error security ssl
Last synced: about 1 year ago
JSON representation
A cli tool to check your site for mixed content
- Host: GitHub
- URL: https://github.com/spatie/mixed-content-scanner-cli
- Owner: spatie
- License: mit
- Created: 2017-07-30T06:13:55.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2022-09-07T08:42:02.000Z (almost 4 years ago)
- Last Synced: 2024-05-09T22:22:48.084Z (about 2 years ago)
- Topics: command-line, developer-tools, mixed-content-error, security, ssl
- Language: PHP
- Homepage: https://spatie.be/opensource
- Size: 337 KB
- Stars: 85
- Watchers: 5
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# A CLI tool to check sites for mixed content
[](https://packagist.org/packages/spatie/mixed-content-scanner-cli)
[](https://scrutinizer-ci.com/g/spatie/mixed-content-scanner-cli)
[](https://packagist.org/packages/spatie/mixed-content-scanner-cli)
This repo contains a tool called `mixed-content-scanner` that can help you find pieces of mixed content on your site. This is how you can use it:
```bash
mixed-content-scanner scan https://spatie.be
```
And of course our company site reports no mixed content.
Here's an example of a local test server that does contain some mixed content:
## Support us
[
](https://spatie.be/github-ad-click/mixed-content-scanner-cli)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer global require spatie/mixed-content-scanner-cli
```
## How it works under the hood
When scanning a site, the tool will crawl every page. On all html retrieved, these elements and attributes will be checked:
- `audio`: `src`
- `embed`: `src`
- `form`: `action`
- `link`: `href`
- `iframe`: `src`
- `img`: `src`, `srcset`
- `object`: `data`
- `param`: `value`
- `script`: `src`
- `source`: `src`, `srcset`
- `video`: `src`
If any of those attributes start with `http://` the element will be regarded as mixed content.
The tool does not scan linked `.css` or `.js` files. Inline `` or `<style>` are not taken into consideration.
## Usage
You can scan a site by using the `scan` command followed by the url
```bash
mixed-content-scanner scan https://example.com
```
## Options
### SSL verification
You might want to check your site for mixed content before actually launching it. It's quite common your site doesn't have an ssl certificate installed yet at that point. That's why by default the tool will not verify ssl certificates.
If you want to turn on ssl verification just use the `verify-ssl option`
```bash
mixed-content-scanner scan https://self-signed.badssl.com/ --verify-ssl
```
That examples will result in non responding urls because the host does not have a valid ssl certificate
### Filtering and ignoring urls
You can filter which urls are going to be crawled by passing regex to the `filter` and `ignore` options.
In this example we are only going to crawl pages starting with `/en`.
```bash
mixed-content-scanner scan https://spatie.be --filter="^\/en"
```
You can use multiple filters:
```bash
mixed-content-scanner scan https://spatie.be --filter="^\/en" --filter="^\/nl"
```
You can also ignore certain urls. Here we are going to ignore all url's that contain the word `opensource`.
```bash
mixed-content-scanner scan https://spatie.be --ignore="opensource"
```
Of course you can also combine filters and ignores:
```bash
mixed-content-scanner scan https://spatie.be --filter="^\/en" --ignore="opensource"
```
### Ignoring robots
By default, the crawler will respect robots data. You can ignore them though with the `--ignore-robots` option.
```bash
mixed-content-scanner scan https://example.com --ignore-robots
```
### Custom User agent
By default, the crawler uses the underlying guzzle client for the user agent. You can override this value with the `--user-agent` option.
```bash
mixed-content-scanner scan https://example.com --user-agent='MyCustomCrawler'
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.
## Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
The scanner is inspired by [mixed-content-scan](https://github.com/bramus/mixed-content-scan) by [Bram Van Damme](https://github.com/bramus). Parts of his readme and code were used.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.