New Feature: API Key Access for /api/wireguard_status/!

[eduardogsilva]

Hey everyone,

I've got some good news! You can now access /api/wireguard_status/ using an API key. This makes it easier to connect our project with other systems for things like billing or monitoring.

Generating an API Key:

• Outside the Container:

cat /proc/sys/kernel/random/uuid > /var/lib/docker/volumes/wireguard_webadmin_wireguard/_data/api_key

• Inside the Container:

cat /proc/sys/kernel/random/uuid > /etc/wireguard/api_key

Remember, your api_key should be a valid UUID.

Accessing the API with the Key:

Once you have your API key, you can access the API by appending it to the URL like so:

/api/wireguard_status/?key=<your_uuid_here>

Disabling the API Key:

If you ever need to disable your API key, you can generate a new one or simply delete the api_key file.

I decided to make this feature public while working on an integration myself. Feel free to use it and share any cool stuff you do with it. Can't wait to see what you come up with!

Cheers!

[eduardogsilva]

Hi there! 👋

I'm sharing a straightforward use case of the API that displays WireGuard peer information. Whether you're fetching data by a peer's public key or a more memorable name, this app is user-friendly and easy to implement. Below, you’ll find instructions on setting up and running the Flask application, along with how to use it effectively.

Flask Application Setup

First, ensure Flask is installed in your environment. If not, install it using pip:

pip install Flask

Create a file named app.py in your project directory and paste the following Flask application code into it:

from flask import Flask, request
import requests

app = Flask(__name__)

# Example mapping data. Replace with an external source if necessary.
PEERS = [
    {"peer_name": "normanbates", "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    {"peer_name": "hanniballecter", "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    {"peer_name": "jacktorrance", "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    # Add more peers as needed
]

@app.route('/')
def wireguard_status():
    peer = request.args.get('peer')
    peer_name = request.args.get('peer_name')
    
    if peer_name:
        # Finds the public_key based on the peer's name
        peer = next((p['public_key'] for p in PEERS if p['peer_name'] == peer_name), None)
        if not peer:
            return "Peer not found", 404
    
    # Replace this URL with the real endpoint from where you are getting the WireGuard data
    wireguard_endpoint = 'https://example.com/api/wireguard_status/?key=<your_key>'
    response = requests.get(wireguard_endpoint)
    if response.status_code != 200:
        return "Error fetching WireGuard endpoint", 500
    
    data = response.json()
    
    # Attempting to find the data for a specific peer
    for interface, peers in data.items():
        peer_data = peers.get(peer)
        if peer_data:
            break
    else:
        return "Peer data not found", 404
    
    # Creating a simple HTML view
    html = "<h1>Peer Status</h1>"
    for key, value in peer_data.items():
        if isinstance(value, dict):  # For fields like 'transfer', which are dictionaries
            html += f"<p><b>{key.capitalize()}:</b><br>"
            for sub_key, sub_value in value.items():
                html += f"{sub_key.capitalize()}: {sub_value}<br>"
            html += "</p>"
        else:
            html += f"<p><b>{key.capitalize()}:</b> {value}</p>"
    
    return html

if __name__ == '__main__':
    app.run(debug=True)

Make sure to replace 'http://example.com/api/wireguard' with the actual endpoint URL from where you intend to fetch the WireGuard data.

Running the Application

To run the application, execute:

flask run

This command starts a local server, typically accessible at http://127.0.0.1:5000/.

Using the application

• Fetching Information by Public Key:

  http://127.0.0.1:5000/?peer=<public_key>
  

  Replace <public_key> with the actual peer's public key.

• Fetching Information by Custom Name:

  http://127.0.0.1:5000/?peer_name=<name>
  

  Replace <name> with the name you've associated with a peer in the PEERS list.

Create easy to remember peer name (optional)

To facilitate memorable URLs, map custom names to public keys within the PEERS list in the app.py:

PEERS = [
    {"peer_name": "normanbates", "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    {"peer_name": "hanniballecter", "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    {"peer_name": "jacktorrance", "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    # Add more peers as needed
]

This approach allows for friendly and convenient access to peer data without the need to remember or distribute public keys.

This small app is just a simple example of how to consume and use the endpoint.

Happy coding and networking! 🚀

Edit: I will not be actively supporting this app. It's just a simple example of how to use the api.