iproxy 0.3.0

Proxy server for IP geolocation. Use external services to get the geolocation of an IP address.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

<p align="center" >
    <img src="img/world-map.svg" alt="logo" width="250"/>
<h3 align="center">iproxy</h3>
<p align="center">Built your own IPV4 geolocation database</p>
<p align="center">Built with ❤ in Rust</p>
</p>

<!-- START OF TOC !DO NOT EDIT THIS CONTENT MANUALLY-->
**Table of Contents**  *generated with [mtoc](https://github.com/containerscrew/mtoc)*
- [Badges](#badges)
- [Introduction](#introduction)
- [How works](#how-works)
- [Example](#example)
- [Using the API](#using-the-api)
  - [Config.toml](#config.toml)
  - [Launch the `docker-compose`](#launch-the-`docker-compose`)
  - [Installing the binary](#installing-the-binary)
  - [Run your first query](#run-your-first-query)
  - [Api alive?](#api-alive?)
  - [Stop the stack](#stop-the-stack)
- [Local development](#local-development)
  - [Stop local mongodb](#stop-local-mongodb)
- [Visualize data](#visualize-data)
- [Import from local mongodb to mongodb atlas](#import-from-local-mongodb-to-mongodb-atlas)
  - [Install mongodb tools](#install-mongodb-tools)
  - [Dump local database](#dump-local-database)
  - [Import local database to mongodb atlas](#import-local-database-to-mongodb-atlas)
- [TO DO](#to-do)
- [Pending to fix](#pending-to-fix)
- [Useful Links](#useful-links)
- [LICENSE](#license)
<!-- END OF TOC -->

# Badges
![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
[![License](https://img.shields.io/github/license/containerscrew/iproxy)](/LICENSE)
![Code Size](https://img.shields.io/github/languages/code-size/containerscrew/mtoc)
![Crates.io Version](https://img.shields.io/crates/v/iproxy)
![Latest Tag](https://img.shields.io/github/v/tag/containerscrew/iproxy?sort=semver)

# Introduction

So imagine that you want to start indexing public IPv4 geolocation data. There are paid services, others free but requiring registration, that offer this type of content.
By consulting one of these services you will obtain the data you need.

I do not know exactly all the public services that offer this data, in my case I have used the public database of **[ip-api.com](http://ip-api.com)**

> Without this external service this tool does not work, it would be necessary to refactor and use another API and map the responses.

Other possible solutions (not implemented):
* https://www.maxmind.com/en/home
* https://ipstack.com/
* https://ip.guide

# How works

You will make a request to your API endpoint, for example, `curl http://localhost:8080/1.1.1.1`, and the API will first check if the data exists in the database. If it does not exist, it will retrieve the information from the external website mentioned above. The next time you query the same IP, the data will be retrieved from MongoDB, avoiding the external query.

# Example

![example](./img/example.png)

> API logs can be retrieved executing `docker logs -f iproxy` once the API is running. Plase visit the next step.

# Using the API

The setup is configured to work with docker-compose locally.

## Config.toml

With [this file](./config.toml) located in the root of this repository, you will be able to change some parameters.

## Launch the `docker-compose`

| :warning: WARNING           |
|:----------------------------|
| Before start the docker-compose, change the password for mongodb root user. Change it in `config.toml` and `compose.yml`.    |

```bash
make compose-up-build
```

This will starts the `iproxy` container and `mongodb` and `nginx-proxy`.

## Installing the binary

You can install the binary using cargo:

```bash
cargo install iproxy
# Then run the command iproxy (config.toml is neccesary in the same dir)
```

## Run your first query

```bash
curl http://127.0.0.1:8000/api/v1/1.1.1.1
```

> http://ip:port/api/v1/ip-to-query

## Api alive?

```bash
curl http://127.0.0.1:8000/api/v1/health
```

## Stop the stack

```bash
make compose-down
```

# Local development

```shell
cargo install cargo-watch systemfd
docker network create iproxy
make local-development
```

## Stop local mongodb

```shell
make local-development-down
```

# Visualize data

Using [mongodb compass](https://www.mongodb.com/products/tools/compass) you can visualize your data from the collection `ips`

![data](img/mongo_data.png)

# Import from local mongodb to mongodb atlas

Import data from localhost to mongodb atlas

## Install mongodb tools

Visit the official webpage https://www.mongodb.com/docs/database-tools/installation/installation/.


## Dump local database

```shell
mongodump --uri="mongodb://admin:admin@localhost:27017/?maxPoolSize=20&w=majority"
```

This command will create a new `dump/` directory with the backup

## Import local database to mongodb atlas

> The uri of this command is the remote uri (mongodb atlas)

```shell
mongorestore --uri="mongodb+srv://USERNAME:PASSWORD@XXXXX.XXXX.mongodb.net/?retryWrites=true&w=majority" --db="ipfinder" --collection="ips" dump/iproxy/ips.bson
```

# TO DO

* Testing and error handling with custom errors ([MyErrors](./src/error.rs))
* Generate possible public ipv4 https://www.criminalip.io/ip-ranges
* Prometheus metrics
* JWT token
* Build takes too long due to `openssl` dependency
* Create `/me` endpoint to retrieve user geolocation ip data

# Pending to fix

* When the ip is private, the process crashes.

# Useful Links

* [Github](https://github.com/tokio-rs/axum)
* [API example](https://github.com/wpcodevo/simple-api-rust-axum)
* [API example mongodb](https://github.com/wpcodevo/rust-axum-mongodb)

# LICENSE

`iproxy` is distributed under the terms of the [`GNU AFFERO GENERAL PUBLIC LICENSE`](./LICENSE).