Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b4dnewz/social-scanner
:bust_in_silhouette: A node utility to scan various social networks against username.
https://github.com/b4dnewz/social-scanner
osint scanner social-network social-scanner username-checker
Last synced: 3 months ago
JSON representation
:bust_in_silhouette: A node utility to scan various social networks against username.
- Host: GitHub
- URL: https://github.com/b4dnewz/social-scanner
- Owner: b4dnewz
- License: mit
- Created: 2017-09-19T18:14:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-13T07:26:19.000Z (over 5 years ago)
- Last Synced: 2024-08-09T10:53:53.150Z (6 months ago)
- Topics: osint, scanner, social-network, social-scanner, username-checker
- Language: JavaScript
- Homepage:
- Size: 787 KB
- Stars: 26
- Watchers: 5
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
node utility to scan various social networks to match a username
## Installation
You can install it via npm or yarn.
```bash
npm install social-scanner
yarn add social-scanner
```
## Looking for the cli?
You can use it from the command line installing the globally the [cli](https://github.com/b4dnewz/social-scanner-cli) repository.
```bash
npm install -g social-scanner-cli
yarn global add social-scanner-cli
```
---
## How it works?
The script can be used as a module and take specific options in order:
```javascript
socialScanner(username, options, callback)
```
By default it will perform an HTTP request for each [rule](./lib/rules.js) existing in the project against the given username, if the page exists (return 200 status code) and __depending by rule__, if different response content assertions succeeds is treated as positive.
```javascript
const socialScanner = require('../lib/index');
socialScanner('codekraft-studio', {}, (err, response) => {
if (err) {
console.log('Error:', JSON.stringify(err, null, 2));
return;
}
console.log('Response:', JSON.stringify(response, null, 2));
});
```
You can also capture the output in different formats. By default is __BASE64__, but you can use __PNG__ or many more using the __captureOptions__ object to pass options directly to [webpage-capture](https://github.com/b4dnewz/webpage-capture) which is the one you is in charge of web screenshots.
```javascript
// outputType: 'base64|png|pdf'
socialScanner('codekraft-studio', {
capture: true,
captureOptions: {
outputType: 'base64',
onlySuccess: true,
outputType: 'file'
}
}, (err, response) => {
// some code
});
```
To specify a custom path for the files you must pass it to __outputDir__ option like so:
```javascript
socialScanner('codekraft-studio', {
capture: true,
outputDir: '/home/user/Desktop'
});
```
## Options
This is the options object to customize the HTTP request behavior, is passed directly to request
* __requestOptions__: A object of options passed to [request](https://github.com/request/request)
The default values used by the script are:
```js
strictSSL: false,
followRedirect: true,
followAllRedirects: false,
maxRedirects: 2,
timeout: 3000
```
#### Filters
These are the options object properties dedicated to filter the rules to test against the given input.
* __restrict__: A list (or array) of social networks to scan
* __restrictCategories__: An array of restrict rule categories
By default no restrictions will be made and all the rules will be tested.
#### Output
* __onlySuccess__: Returns only results that matched the search
* __capture__: Take screenshot of the resulting page(s)
* __outputDir__: The output directory where place the screenshots
* __captureOptions__: A object of options passed directly to [webpage-capture](https://github.com/b4dnewz/webpage-capture)
* __crop__: If the screnshot should be cropped or not
* __onlySuccess__: Returns only results that matched the search
* __outputType__: Change the output format for the capture result
```js
onlySuccess: false,
capture: false,
captureOptions: {
outputType: 'base64',
onlySuccess: false,
crop: true
}
```
This are the default properties used by the script are listed below, for the full options list refer to webpage-capture github page. Please note this, __if the option on the child package has the same name in this package__ please don't use the option in the child because it's needed in this package to customize the operations.
---
## Examples
The code is very simple to use, the best way is just try it with your username to see in which services is already taken and where is you or not, if you find some response incongruences, for example the response say it's a match but obviously is not, please be kind and open a [new issue](https://github.com/b4dnewz/social-scanner/issues/new?title=Rule+request&labels=enhancement&template=new_rule.md) following this format.
###### Scan a username against all rules
Scan a username against various social networks, without taking screenshots.
```javascript
socialScanner(username, {}, (err, response) => { });
```
###### Scan a username against all rules taking screenshots to string (base64)
Scan a username against various social networks, taking screenshots.
```javascript
socialScanner(username, {
capture: true,
onlySuccess: true
}, (err, response) => { });
```
###### Scan a username against all rules taking screenshots to file (png)
Scan a username against various social networks, taking screenshots to file in the default PNG format, the files will be placed in a output subfolder called as the username for example, with my username, the output will be stored in: `./output/b4dnewz`.
```javascript
socialScanner(username, {
onlySuccess: true,
capture: true,
captureOptions: {
outputType: 'file'
}
}, (err, response) => { });
```
###### Filter the list of rules to scan by rule name
Scan username against some restricted social networks, the rules are filtered by rule name, you can see the full list in the [rules page](./lib/rules.js).
```javascript
socialScanner(username, {
restrict: ['facebook', 'github']
}, (err, response) => { });
```
###### Filter the list of rules to scan by rule category
Scan username against some restricted social categories, the rules are filtered by their category, if you use the cli tool there is a command to list all the categories, otherwise look at the [rules page](./lib/rules.js) or try to guess them, they are english words so pretty prevedible, for example: `tech, design, ...`.
```javascript
socialScanner(username, {
restrictCategories: ['community']
}, (err, response) => { });
```
---
## Adding rules
So you want to add a rule or a set of rules to the tool? Maybe you have tried it with your username and you haven't find listed your favorite social network or web service. There is a solution for this, simply open a [new issue](https://github.com/b4dnewz/social-scanner/issues/new?title=Rule+request&labels=enhancement&template=new_rule.md) asking what service you want to add and it will be integrated as soon as possible in the next releases.
#### What I need to know?
For example you want to integrate you favourite social network which is called `example.com` and you know the profile pages for that website are under the path: `example.com/profile/`, you also know this website doesn't allow some kind of characters for usernames, because during the registration process you have tried many different wrong usernames.
#### How to integrate?
Now you can open a [new issue](https://github.com/b4dnewz/social-scanner/issues/new?title=Rule+request&labels=enhancement&template=new_rule.md) following the template and describing as much as you can the website you want to add or you can fork the repository and add the rule yourself, take a look at the [rules](https://github.com/b4dnewz/social-scanner/blob/master/lib/rules.js) file than add your new rule object and submit a pull request.
---
## License
The __social-scanner__ is released under the MIT License by [b4dnewz](https://b4dnewz.github.io/).
## Contributing
1. Fork it ( https://github.com/b4dnewz/social-scanner/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
3. Write and run the tests (`npm run test`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request