Skip to content

Commit

Permalink
Merge pull request #1105 from sundowndev/refact/docs
Browse files Browse the repository at this point in the history
Improve documentation website
  • Loading branch information
sundowndev authored Jul 26, 2022
2 parents da891b8 + 13f2107 commit 29d2593
Show file tree
Hide file tree
Showing 11 changed files with 55 additions and 41 deletions.
11 changes: 6 additions & 5 deletions docs/contribute.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Contribute

This page describe the project structure and gives you a bit of help to start contributing.
---
hide:
- navigation
---

The project is maintained by a single person: [sundowndev](https://github.com/sundowndev). Contributions are welcome !
# Contribute

!!! tip "Want to contribute ? Clone the project and open some pull requests !"
This page describe the project structure and gives you a bit of context to start contributing to the project.

## Project

Expand Down
4 changes: 2 additions & 2 deletions docs/formatting.md → docs/getting-started/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ E.164 formatting for phone numbers entails the following:

For example, here’s a US-based number in standard local formatting: (415) 555-2671

![](https://i.imgur.com/0e2SMdL.png)
![](/images/0e2SMdL.png)

Here’s the same phone number in E.164 formatting: +14155552671

![](https://i.imgur.com/KfrvacR.png)
![](/images/KfrvacR.png)

In the UK, and many other countries internationally, local dialing may require the addition of a '0' in front of the subscriber number. With E.164 formatting, this '0' must usually be removed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,23 @@ package main

import (
"fmt"
"log"

"github.com/sundowndev/phoneinfoga/v2/lib/number"
"github.com/sundowndev/phoneinfoga/v2/lib/remote"
)

func main() {
n, _ := number.NewNumber("...")
s := remote.NewGoogleSearchScanner()

res, _ := s.Scan(n)

n, err := number.NewNumber("...")
if err != nil {
log.Fatal(err)
}

res, err := remote.NewGoogleSearchScanner().Scan(n)
if err != nil {
log.Fatal(err)
}

links := res.(remote.GoogleSearchResponse)
for _, link := range links.Individuals {
fmt.Println(link.URL) // Google search link to scan
Expand Down
File renamed without changes.
File renamed without changes.
23 changes: 12 additions & 11 deletions docs/scanners.md → docs/getting-started/scanners.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scanners

PhoneInfoga provide several scanners to extract as much information as possible from a given phone number. Those scanners may require authentication, so they're automatically skipped when no authentication credentials are found. Note that all scanners use environment variables to find credentials.
PhoneInfoga provide several scanners to extract as much information as possible from a given phone number. Those scanners may require authentication, so they're automatically skipped when no authentication credentials are found. Note that all scanners use environment variables for configuration values.

## Building your own scanner

Expand All @@ -11,19 +11,19 @@ $ phoneinfoga scan -n +4176418xxxx --plugin ./custom_scanner.so
```

!!! info
For now, plugins are only supported through the CLI.
Plugins are written with the [Go programming language](https://golang.org/).

To get started, [see this example](https://github.com/sundowndev/phoneinfoga/tree/master/examples/plugin).
For now, plugins are only supported through the CLI. To get started, [see this example plugin](https://github.com/sundowndev/phoneinfoga/tree/master/examples/plugin).

## Local

The local scan is probably the simplest scan of PhoneInfoga. By default, the tool statically parse the phone number and convert it to several formats, it also tries to recognize the country and the carrier. Those information are passed to all scanners in order to provide further analysis. The local scanner simply return those information to the end user so they can exploit it as well.

=== "Configuration"
??? info "Configuration"

There is no configuration required for this scanner.

=== "Example"
??? example "Output example"

```shell
$ phoneinfoga scan -n +4176418xxxx
Expand All @@ -40,13 +40,14 @@ The local scan is probably the simplest scan of PhoneInfoga. By default, the too

Numverify provide standard but useful information such as country code, location, line type and carrier. This scanners requires an API-key which you can get on their website after creating an account. You can use a free API key as long as you don't exceed the monthly quota.

=== "Configuration"
??? info "Configuration"

| Environment variable | Default | Description |
|----------------------|---------|------------------------------------------------------------------------|
| NUMVERIFY_API_KEY | | API key to authenticate to the Numverify API. |
| NUMVERIFY_ENABLE_SSL | false | Whether to use HTTPS or plain HTTP for requests to the Numverify API. |
=== "Example"

??? example "Output example"

```shell
$ NUMVERIFY_API_KEY=<key> phoneinfoga scan -n +4176418xxxx
Expand All @@ -70,11 +71,11 @@ Googlesearch uses the Google search engine and [Google Dorks](https://en.wikiped

You can however, use this scanner through the REST API in addition with another tool to fetch the result automatically.

=== "Configuration"
??? info "Configuration"

There is no configuration required for this scanner.

=== "Example"
??? example "Output example"

```shell
$ phoneinfoga scan -n +4176418xxxx
Expand Down Expand Up @@ -176,11 +177,11 @@ You can however, use this scanner through the REST API in addition with another

OVH, besides being a web and cloud hosting company, is a telecom provider with several VoIP numbers in Europe. Thanks to their API-key free REST API, we are able to tell if a number is owned by OVH Telecom or not.

=== "Configuration"
??? info "Configuration"

There is no configuration required for this scanner.

=== "Example"
??? example "Output example"

```shell
$ phoneinfoga scan -n +3336517xxxx
Expand Down
4 changes: 3 additions & 1 deletion docs/usage.md → docs/getting-started/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,11 @@ phoneinfoga recon -n +42837544833

## Available scanners

PhoneInfoga embed a bunch of scanners that will provide information about the given phone number. Some of them will request external services, and so might require authentication. By default, unconfigured scanners won't run. The information gathered can then be used for a deeper manual analysis.

See page related to [scanners](scanners.md).

## Launching the server
## Launching the web server

PhoneInfoga integrates a REST API along with a web client that you can deploy anywhere. The API has been written in Go and web client in Vue.js. The application is stateless, so it doesn't require any persistent storage.

Expand Down
Binary file added docs/images/0e2SMdL.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/KfrvacR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 7 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Welcome to the PhoneInfoga documentation
---
hide:
- navigation
---

# Welcome to the PhoneInfoga documentation website

PhoneInfoga is one of the most advanced tools to scan international phone numbers. It allows you to first gather standard information such as country, area, carrier and line type on any international phone number, then search for footprints on search engines to try to find the VoIP provider or identify the owner.

### [Read the related blog post](https://medium.com/@SundownDEV/phone-number-scanning-osint-recon-tool-6ad8f0cac27b)
[Read the related blog post](https://medium.com/@SundownDEV/phone-number-scanning-osint-recon-tool-6ad8f0cac27b){ .md-button .md-button--primary }

## Features

Expand All @@ -19,11 +24,3 @@ PhoneInfoga is one of the most advanced tools to scan international phone number
- Does not allow to "track" a phone or its owner in real time
- Does not allow to get the precise phone location
- Does not allow to hack a phone
----

!!! bug
Found a bug ? Feel free to [open an issue](https://github.com/sundowndev/phoneinfoga/issues).

You can also [reach me on Twitter](https://twitter.com/sundowndev) or at raphael(at)crvx.fr.

PGP: [B64687AB97F268F43E67B97A8916203E540C65A4](https://crvx.fr/publickey.asc)
21 changes: 14 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ site_description: 'Advanced information gathering & OSINT tool for phone numbers
site_author: 'Sundowndev'
copyright: 'PhoneInfoga was developed by sundowndev and is licensed under GPL-3.0.'
nav:
- 'Introduction': index.md
- 'Installation': install.md
- 'Usage': usage.md
- 'Scanners': scanners.md
- 'Formatting phone numbers': formatting.md
- 'Go module usage': go-module-usage.md
- 'Resources': resources.md
- 'Home': index.md
- 'Getting Started':
- 'Installation': getting-started/install.md
- 'Usage': getting-started/usage.md
- 'Formatting phone numbers': getting-started/formatting.md
- 'Scanners': getting-started/scanners.md
- 'Go module usage': getting-started/go-module-usage.md
- 'Additional resources': getting-started/resources.md
- 'Contribute': contribute.md
theme:
name: material
Expand All @@ -32,6 +33,9 @@ theme:
name: Switch to light mode
features:
- content.tabs.link
- navigation.instant
- navigation.sections
- navigation.tabs
extra:
social:
- icon: fontawesome/brands/github-alt
Expand All @@ -45,6 +49,9 @@ markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- attr_list
- admonition
- pymdownx.details
plugins:
- search
- minify:
Expand Down

0 comments on commit 29d2593

Please sign in to comment.