Release v3.0.0rc2

Fix issue with asyncio.Queue

.coveragerc

@@ -0,0 +1,2 @@
+[paths]
+source = gns3server

.gitattributes

@@ -0,0 +1,2 @@
+gns3server/version.py merge=ours
+

.github/workflows/add-new-issues-to-project.yml

@@ -0,0 +1,16 @@
+name: Add new issues to GNS3 project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v1.0.1
+        with:
+          project-url: https://github.com/orgs/GNS3/projects/3
+          github-token: ${{ secrets.ADD_NEW_ISSUES_TO_PROJECT }}

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,93 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: '21 12 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: python
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/publish-api-documentation.yml

@@ -0,0 +1,40 @@
+name: publish-api-documentation
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - v3.*
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        ref: "gh-pages"
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.8
+    - name: Merge changes from 3.0 branch
+      run: |
+        git config user.name github-actions
+        git config user.email github-actions@github.com
+        git merge origin/3.0 -X theirs
+    - name: Install GNS3 server and dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .
+    - name: Generate the API documentation
+      run: |
+        cd scripts
+        python3 publish_api_documentation.py
+    - name: Publish the API documentation
+      run: |
+        git add docs
+        git status
+        git commit -m "Publish API documentation"
+        git push

.github/workflows/testing.yml

@@ -0,0 +1,55 @@
+name: testing
+
+on:
+  push:
+    branches:
+      - master
+      - 3.0
+  pull_request:
+    branches:
+      - master
+      - 3.0
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: ["ubuntu-latest"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        #include:
+          # only test with Python 3.10 on Windows
+        #  - os: windows-latest
+        #    python-version: "3.10"
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .[dev]
+
+    - name: Install Windows specific dependencies
+      if: runner.os == 'Windows'
+      run: |
+        python -m pip install -r win-requirements.txt
+        curl -O "http://www.win10pcap.org/download/Win10Pcap-v10.2-5002.msi"
+        msiexec /i "Win10Pcap-v10.2-5002.msi" /qn /norestart
+
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        python -m pytest -vv

.gitignore

@@ -1,4 +1,15 @@
 *.py[cod]
+__pycache__
+.pytest_cache
+
+#py.test
+.cache
+
+# environment file
+.env
+
+# hypothesis files
+.hypothesis
 
 # C extensions
 *.so
@@ -10,7 +21,6 @@ dist
 build
 eggs
 parts
-bin
 var
 sdist
 develop-eggs
@@ -23,7 +33,9 @@ pip-log.txt
 
 # Unit test / coverage reports
 .coverage
+.coverage*
 .tox
+.cache
 nosetests.xml
 
 # Translations
@@ -34,9 +46,24 @@ nosetests.xml
 .project
 .pydevproject
 .settings
+.vscode
 
 # Pycharm
 .idea
 
 # Gedit Backup Files
 *~
+
+#Documentation build
+docs/_build
+
+#VPCS
+vpcs.hist
+startup.vpcs
+.gns3_shell_history
+
+# Virtualenv
+env
+venv
+*venv
+.ropeproject

.travis.yml

@@ -1,29 +0,0 @@
-language: python
-
-env:
-  - TOX_ENV=py33
-  - TOX_ENV=py34
-
-before_install:
-  - sudo add-apt-repository ppa:gns3/ppa -y
-  - sudo apt-get update -q
-
-install:
-  - pip install tox
-  - sudo apt-get install vpcs dynamips
-
-script:
-  - tox -e $TOX_ENV
-
-branches:
-  only:
-    - master
-
-notifications:
-  email: false
-  irc:
-    channels:
-      - "chat.freenode.net#gns3"
-    on_success: change
-    on_failure: always
-

.whitesource

@@ -0,0 +1,14 @@
+{
+  "scanSettings": {
+    "configMode": "AUTO",
+    "configExternalURL": "",
+    "projectToken" : "",
+    "baseBranches": ["master", "2.2", "3.0"]
+  },
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

AUTHORS

@@ -1 +0,0 @@
-Jeremy Grossmann

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing to GNS3
+
+We welcome contributions and bugs reports from everyone.
+We are friendly so don't be afraid to ask questions.
+
+## Bug reports
+
+Before reporting an issue:
+* check our website over at https://gns3.com
+* check if an issue already exists on https://github.com/GNS3/gns3-gui
+* check if an issue already exists on https://github.com/GNS3/gns3-server
+
+Please post on our community website if you are unsure you found a bug,
+you will get faster support and be able to exchange with more users.
+
+If you are unsure which project you should create an issue for, just do 
+it on https://github.com/GNS3/gns3-gui we will take care of the triage.
+
+For bugs specific to the GNS3 VM, please report on https://github.com/GNS3/gns3-vm
+
+## Security issues
+
+For security issues please keep it private and send an email to developers@gns3.net
+
+## Asking for new features
+
+The best is to start a discussion on the community website in order to get feedback
+from the whole community.
+
+
+## Contributing code
+
+We welcome code contribution from everyone including beginners.
+Don't be afraid to submit a half finished or mediocre contribution and we will help you.
+
+Don't hesitate to share your plans before starting working on a contribution, we can help
+you to find the best approach.
+
+### Contributors License Agreements
+
+We at GNS3 are eager to work with you. For small changes — little bugfixes, correcting typos, and the like — please just submit pull requests to any of our projects. For larger changes, though, we have to ask you to jump through a little hoop.
+
+In particular, in order for us to accept any major patches from you, you will have to electronically sign a statement that indicates two things:
+
+- You are willingly licensing your contributions under the terms of the open source license of the project that you’re contributing to.
+- You are legally able to license your contributions as stated.
+
+The reason we do this is to ensure, to the extent possible, that we don’t “taint” the projects we manage with contributions that turn out to be improper. This protects everyone who wants to use the projects, including you!
+
+More information there: https://github.com/GNS3/cla
+
+### Pull requests
+
+Creating a pull request is the easiest way to contribute code. Do not hesitate to create one early when  contributing for new feature in order to get our feedback.

Dockerfile

@@ -0,0 +1,37 @@
+FROM ubuntu:focal
+
+WORKDIR /gns3server
+
+RUN apt update && DEBIAN_FRONTEND=noninteractive apt install -y \
+    locales \
+    locales-all
+
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+COPY ./requirements.txt /gns3server/requirements.txt
+
+RUN DEBIAN_FRONTEND=noninteractive apt install -y \
+    locales \
+    software-properties-common \
+    python3-pip \
+    python3-all \
+    python3-setuptools \
+    python3-dev \
+    busybox-static \
+    gcc \
+    qemu-kvm \
+    libvirt-daemon-system
+
+RUN add-apt-repository ppa:gns3/ppa && apt update && DEBIAN_FRONTEND=noninteractive apt install -y \
+    vpcs \
+    ubridge \
+    dynamips
+
+COPY . /gns3server
+
+RUN mkdir -p ~/.config/GNS3/3.0/
+RUN cp scripts/gns3_server.conf ~/.config/GNS3/3.0/
+
+RUN python3 -m pip install .

MANIFEST.in

@@ -1,11 +1,7 @@
-include README.rst
-include AUTHORS
-include INSTALL
+include README.md
 include LICENSE
-include MANIFEST.in
-include tox.ini
-recursive-exclude tests *
-recursive-include docs *
+include CHANGELOG
 recursive-include gns3server *
+recursive-exclude docs *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

README.md

@@ -0,0 +1,134 @@
+# GNS3 server repository
+
+[![Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![GitHub Actions tests](https://github.com/GNS3/gns3-server/workflows/testing/badge.svg?branch=3.0)](https://github.com/GNS3/gns3-server/actions?query=workflow%3Atesting+branch%3A3.0)
+[![Latest PyPi version](https://img.shields.io/pypi/v/gns3-server.svg)](https://pypi.python.org/pypi/gns3-server)
+[![Snyk scanning](https://snyk.io/test/github/GNS3/gns3-server/badge.svg)](https://snyk.io/test/github/GNS3/gns3-server)
+
+The GNS3 server manages emulators and other virtualization software such as Dynamips, Qemu/KVM, Docker, VPCS, VirtualBox and VMware Workstation.
+Clients like the [GNS3 GUI](https://github.com/GNS3/gns3-gui/) and the [GNS3 Web UI](https://github.com/GNS3/gns3-web-ui/) control the server using a HTTP REST API.
+
+## Installation
+
+These instructions are for using GNS3, please see below for development.
+
+### Windows & macOS
+
+Please use our [Windows installer or DMG package](https://gns3.com/software/download) to install the stable build along with the GNS3 VM.
+Note that as of GNS3 version above 3.0, you must run the server using the GNS3 VM or on a Linux system (remote, cloud or virtual machine).
+
+### Linux
+
+#### Ubuntu based distributions
+
+We build and test packages for actively supported Ubuntu versions.
+Other distros based on Ubuntu, like Mint, should also be supported.
+
+Packages can be installed from our Personal Package Archives (PPA) repository:
+
+```shell
+sudo apt update
+sudo apt install software-properties-common
+sudo add-apt-repository ppa:gns3/ppa
+sudo apt update                                
+sudo apt install gns3-gui gns3-server
+```
+
+#### Other Linux distributions
+
+GNS3 is often packaged for other distributions by third-parties:
+
+* [Gentoo](https://packages.gentoo.org/package/net-misc/gns3-server)
+* [Alpine](https://pkgs.alpinelinux.org/package/v3.10/community/x86_64/gns3-server)
+* [NixOS](https://search.nixos.org/packages?channel=21.11&from=0&size=50&sort=relevance&type=packages&query=gns3-server)
+
+#### PyPi
+
+You may use PyPi in case no package is provided, or you would like to do a manual installation:
+
+* https://pypi.org/project/gns3-server/
+* https://pypi.org/project/gns3-gui/
+
+```shell
+python3 -m pip install gns3-gui
+python3 -m pip install gns3-server
+```
+
+The downside of this method is you will have to manually install all dependencies (see below).
+
+Please see our [documentation](https://docs.gns3.com/docs/getting-started/installation/linux) for more details.
+
+### Software dependencies
+
+In addition to Python dependencies, other software may be required, recommended or optional.
+
+* [uBridge](https://github.com/GNS3/ubridge/) is required, it interconnects the nodes.
+* [Dynamips](https://github.com/GNS3/dynamips/) is required for running IOS routers (using real IOS images) as well as the internal switches and hubs.
+* [VPCS](https://github.com/GNS3/vpcs/) is recommended, it is a builtin node simulating a very simple computer to perform connectivity tests using ping, traceroute etc.
+* Qemu is strongly recommended as most node types are based on Qemu, for example Cisco IOSv and Arista vEOS.
+* libvirt is recommended as it's needed for the NAT cloud.
+* Docker is optional, some nodes are based on Docker.
+* mtools is recommended to support data transfer to/from QEMU VMs using virtual disks.
+* i386-libraries of libc and libcrypto are optional, they are only needed to run IOU based nodes.
+
+Note that Docker needs the script program (`bsdutils` or `util-linux` package), when running a Docker VM and a static busybox during installation (python3 setup.py install / pip3 install / package creation).
+
+## Development
+
+### Setting up
+
+These commands will install the server as well as all Python dependencies:
+
+```shell
+git clone https://github.com/GNS3/gns3-server
+cd gns3-server
+git checkout 3.0
+python3 -m venv venv-gns3server
+source venv-gns3server/bin/activate
+python3 -m pip install .
+python3 -m gns3server
+```
+
+You will have to manually install other software dependencies (see above), for Dynamips, VPCS and uBridge the easiest is to install from our PPA.
+
+### Docker container
+
+Alternatively, you can run the GNS3 server in a container
+
+```shell
+bash scripts/docker_dev_server.sh
+```
+
+### Running tests
+
+First, install the development dependencies:
+
+```shell
+python3 -m pip install -r dev-requirements.txt
+```
+
+Then run the tests using pytest:
+
+```shell
+python3 -m pytest -vv tests/
+```
+
+### API documentation
+
+The API documentation can be accessed when running the server locally:
+
+* On `http://IP:PORT/docs` to see with Swagger UI (i.e. `http://localhost:3080/docs`)
+* On `http://IP:PORT/redoc` to see with ReDoc (i.e. `http://localhost:3080/redoc`)
+
+The documentation can also be viewed [online](http://apiv3.gns3.net) however it may not be the most up-to-date version since it needs manually synchronization with the current code. Also, you cannot use this to interact with a GNS3 server.
+
+### Branches
+
+#### master
+
+master is the next stable release, you can test it in your day-to -day activities.
+Bug fixes or small improvements pull requests go here.
+
+3.x development brand for the next major release.
+
+**Never** use this branch for production. Pull requests for major new features go here.

README.rst

@@ -1,64 +0,0 @@
-GNS3-server
-===========
-
-This is the GNS3 server repository.
-
-The GNS3 server manages emulators such as Dynamips, VirtualBox or Qemu/KVM.
-Clients like the GNS3 GUI controls the server using a JSON-RPC API over Websockets.
-
-You will need the GNS3 GUI (gns3-gui repository) to control the server.
-
-Linux (Debian based)
---------------------
-
-The following instructions have been tested with Ubuntu and Mint.
-You must be connected to the Internet in order to install the dependencies.
-
-Dependencies:
-
-- Python 3.3 or above
-- Setuptools
-- PyZMQ library
-- Netifaces library
-- Tornado
-- Jsonschema
-
-The following commands will install some of these dependencies:
-
-.. code:: bash
-
-   sudo apt-get install python3-setuptools
-   sudo apt-get install python3-zmq
-   sudo apt-get install python3-netifaces
-
-Finally these commands will install the server as well as the rest of the dependencies:
-
-.. code:: bash
-
-   cd gns3-server-master
-   sudo python3 setup.py install
-   gns3server
-
-Windows
--------
-
-Please use our all-in-one installer.
-
-Mac OS X
---------
-
-Please use our DMG package for a simple installation.
-
-If you want to test the current git version or contribute to the project.
-
-You can follow this instructions with virtualenwrapper: http://virtualenvwrapper.readthedocs.org/
-and homebrew: http://brew.sh/.
-
-.. code:: bash
-
-   brew install python3
-   mkvirtualenv gns3-server --python=/usr/local/bin/python3.4
-   python3 setup.py install
-   gns3server
-
-

SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+These are the versions of the GNS3 server that are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 3.x.x   | :white_check_mark: |
+| 2.2.x   | :white_check_mark: |
+| 2.1.x   | :x:                |
+| 1.x.x   | :x:                |
+
+## Reporting a Vulnerability
+
+Please use GitHub's report a vulnerability feature. More information can be found in https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability

cloud-image/.novarc

@@ -1,5 +0,0 @@
-export OS_USERNAME=username
-export OS_PASSWORD=""
-export OS_TENANT_NAME=000000
-export OS_AUTH_URL=https://identity.api.rackspacecloud.com/v2.0/
-export OS_REGION_NAME=ord

cloud-image/create_image.py

@@ -1,243 +0,0 @@
-""" Create a new GNS3 Server Rackspace image with the provided options. """
-
-import argparse
-import getpass
-import os
-import sys
-import uuid
-from fabric.api import env
-from fabric.contrib.files import exists
-from github import Github
-from novaclient.v1_1 import client
-from string import Template
-from time import sleep
-
-POLL_SEC = 20
-GNS3_REPO = 'gns3/gns3-server'
-PLANC_REPO = 'planctechnologies/gns3-server'
-OS_AUTH_URL = 'https://identity.api.rackspacecloud.com/v2.0/'
-UBUNTU_BASE_ID = '5cc098a5-7286-4b96-b3a2-49f4c4f82537'
-
-
-def main():
-    """
-    Get the user options and perform the image creation.
-
-    Creates a new instance, installs the required software, creates an image
-    from the instance, and then deletes the instance.
-    """
-
-    github = Github()
-
-    args = get_cli_args()
-    if args.username:
-        username = args.username
-    else:
-        if 'OS_USERNAME' in os.environ:
-            username = os.environ.get('OS_USERNAME')
-        else:
-            username = raw_input('Enter Rackspace username: ')
-
-    if args.password:
-        password = args.password
-    else:
-        if 'OS_PASSWORD' in os.environ:
-            password = os.environ.get('OS_PASSWORD')
-        else:
-            password = getpass.getpass('Enter Rackspace password: ')
-
-    if args.tenant:
-        tenant = args.tenant
-    else:
-        if 'OS_TENANT_NAME' in os.environ:
-            tenant = os.environ.get('OS_TENANT_NAME')
-        else:
-            tenant = raw_input('Enter Rackspace Tenant ID: ')
-
-    if args.region:
-        region = args.region
-    else:
-        if 'OS_REGION_NAME' in os.environ:
-            region = os.environ.get('OS_REGION_NAME')
-        else:
-            region = raw_input('Enter Rackspace Region Name: ')
-
-    if args.source == 'release':
-        # get the list of releases, present them to the user, save the url
-        repo = github.get_repo(GNS3_REPO)
-        keyword = "tag"
-        i = 1
-        branch_opts = {}
-        for tag in repo.get_tags():
-            branch_opts[i] = tag.name
-            i += 1
-    elif args.source == 'dev':
-        # get the list of dev branches, present them to the user, save the url
-        repo = github.get_repo(PLANC_REPO)
-        keyword = "branch"
-        i = 1
-        branch_opts = {}
-        for branch in repo.get_branches():
-            branch_opts[i] = branch.name
-            i += 1
-
-    prompt_text = "Select a %s" % keyword
-    selected_branch = prompt_user_select(branch_opts, prompt_text)
-
-    if args.image_name:
-        image_name = args.image_name
-    else:
-        image_name = "gns3-%s-%s-%s" % (args.source, selected_branch,
-                                        uuid.uuid4().hex[0:4])
-
-    if args.on_boot:
-        on_boot = True
-    else:
-        on_boot = False
-
-    startup_script = create_script(repo.svn_url, selected_branch, on_boot)
-    server_name = uuid.uuid4().hex
-    instance = create_instance(username, password, tenant, region, server_name,
-                               startup_script)
-    passwd = uuid.uuid4().hex
-    instance.change_password(passwd)
-    # wait for the password change to be processed.  Continuing while
-    # a password change is processing will cause image creation to fail.
-    sleep(POLL_SEC*6)
-
-    env.host_string = str(instance.accessIPv4)
-    env.user = "root"
-    env.password = passwd
-
-    sys.stdout.write("Installing software...")
-    sys.stdout.flush()
-
-    while True:
-        if exists('/tmp/gns-install-complete'):
-            break
-
-        sleep(POLL_SEC)
-        sys.stdout.write(".")
-        sys.stdout.flush()
-
-    print("Done.")
-
-    image_id = create_image(username, password, tenant, region, instance,
-                            image_name)
-    instance.delete()
-
-
-def prompt_user_select(opts, text="Please select"):
-    """ Ask the user to select an option from the provided list. """
-
-    print("%s" % text)
-    print("=" * len(text))
-    for o in opts:
-        print("(%s)\t%s" % (o, opts[o]))
-
-    while True:
-        selected = raw_input("Select: ")
-        try:
-            return opts[int(selected)]
-        except (KeyError, ValueError):
-            print("Invalid selection.  Try again")
-
-
-def create_instance(username, password, tenant, region, server_name, script,
-                    auth_url=OS_AUTH_URL):
-    """ Create a new instance. """
-
-    sys.stdout.write("Creating instance...")
-    sys.stdout.flush()
-
-    nc = client.Client(username, password, tenant, auth_url,
-                       region_name=region)
-    server = nc.servers.create(server_name, UBUNTU_BASE_ID, 2,
-                               config_drive=True, userdata=script)
-
-    while True:
-        server = nc.servers.get(server.id)
-        if server.status == 'ACTIVE':
-            break
-
-        sleep(POLL_SEC)
-        sys.stdout.write(".")
-        sys.stdout.flush()
-
-    print("Done.")
-
-    return server
-
-
-def create_script(git_url, git_branch, on_boot):
-    """ Create the start-up script. """
-
-    script_template = Template(open('script_template', 'r').read())
-
-    params = {'git_url': git_url, 'git_branch': git_branch, 'rc_local': ''}
-
-    if on_boot:
-        params['rc_local'] = "echo '/usr/local/bin/gns3-server' >> /etc/rc.local"
-
-    return script_template.substitute(params)
-
-
-def create_image(username, password, tenant, region, server,
-                 image_name, auth_url=OS_AUTH_URL):
-    """ Create a Rackspace image based on the server instance. """
-
-    nc = client.Client(username, password, tenant, auth_url,
-                       region_name=region)
-
-    sys.stdout.write("Creating image %s..." % image_name)
-    sys.stdout.flush()
-
-    image_id = server.create_image(image_name)
-
-    while True:
-        server = nc.servers.get(server.id)
-        if getattr(server, 'OS-EXT-STS:task_state') is None:
-            break
-
-        sleep(POLL_SEC)
-        sys.stdout.write(".")
-        sys.stdout.flush()
-
-    print("Done.")
-
-    return image_id
-
-
-def get_cli_args():
-    """ Parse the CLI input. """
-
-    parser = argparse.ArgumentParser(
-        description='Create a new GNS3 image',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-    parser.add_argument(
-        '--rackspace_username', dest='username', action='store')
-    parser.add_argument(
-        '--rackspace_password', dest='password', action='store')
-    parser.add_argument(
-        '--rackspace_tenant', dest='tenant', action='store')
-    parser.add_argument(
-        '--rackspace_region', dest='region', action='store')
-    parser.add_argument(
-        '--source', dest='source', action='store', choices=['release', 'dev'],
-        default='release', help='specify the gns3-server source location')
-    parser.add_argument(
-        '--branch', dest='branch', action='store',
-        help='specify the branch/tag')
-    parser.add_argument(
-        '--start-on-boot', dest='on_boot', action='store_true',
-        default=False, help='start the GNS3-server when the image boots')
-    parser.add_argument(
-        '--image-name', dest='image_name', action='store',
-        help='the name of the image to be created')
-
-    return parser.parse_args()
-
-
-if __name__ == "__main__":
-    main()

cloud-image/dependencies.txt

@@ -1,3 +0,0 @@
-fabric
-pygithub
-python-novaclient

cloud-image/readme.txt

@@ -1,10 +0,0 @@
-create_image.py:
-
-- uses fabric, which doesn't support Python 3
-
-- prompts for Rackspace credentials if environment variables not set
-  - see .novarc for example env variables
-    - note that the novaclient library uses the Rackspace password and -not-
-      the API key
-
-- use '--help' for help with arguments

cloud-image/script_template

@@ -1,19 +0,0 @@
-#!/bin/bash
-export DEBIAN_FRONTEND=noninteractive
-apt-get -y update
-apt-get -o Dpkg::Options::="--force-confnew" --force-yes -fuy dist-upgrade
-apt-get -y install git
-apt-get -y install python3-setuptools
-apt-get -y install python3-netifaces
-apt-get -y install python3-pip
-
-mkdir -p /opt/gns3
-pushd /opt/gns3
-git clone --branch ${git_branch} ${git_url}
-cd gns3-server
-pip3 install -r dev-requirements.txt
-python3 ./setup.py install
-
-${rc_local}
-
-touch /tmp/gns-install-complete

dev-requirements.txt

@@ -1,4 +1,7 @@
--rrequirements.txt
-
-pytest
-ws4py
+pytest==8.3.3
+flake8==7.1.1
+pytest-timeout==2.3.1
+pytest-asyncio==0.21.2
+requests==2.32.3
+httpx==0.27.2 # version 0.24.1 is required by httpx_ws
+httpx_ws==0.6.2

docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3.7'
+
+services:
+  gns3server:
+    privileged: true
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ./gns3server:/server/
+      - /var/run/docker.sock:/var/run/docker.sock
+    command: python3 -m gns3server --local --port 3080
+    ports:
+      - 3080:3080
+      - 5000-5100:5000-5100

docs/CNAME

@@ -0,0 +1 @@
+apiv3.gns3.net

docs/index.html

@@ -0,0 +1,28 @@
+
+    <!DOCTYPE html>
+    <html>
+    <head>
+    <title>GNS3 controller API - ReDoc</title>
+    <!-- needed for adaptive design -->
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    
+    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+    
+    <link rel="shortcut icon" href="https://fastapi.tiangolo.com/img/favicon.png">
+    <!--
+    ReDoc doesn't change outer page styles
+    -->
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+    </head>
+    <body>
+    <redoc spec-url="openapi.json"></redoc>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+    </body>
+    </html>
+    

docs/redoc.html

@@ -0,0 +1,31 @@
+
+    <!DOCTYPE html>
+    <html>
+    <head>
+    <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3.30.0/swagger-ui.css">
+    <link rel="shortcut icon" href="https://fastapi.tiangolo.com/img/favicon.png">
+    <title>GNS3 controller API - Swagger UI</title>
+    </head>
+    <body>
+    <div id="swagger-ui">
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3.30.0/swagger-ui-bundle.js"></script>
+    <!-- `SwaggerUIBundle` is now available on the page -->
+    <script>
+    const ui = SwaggerUIBundle({
+        url: 'openapi.json',
+    oauth2RedirectUrl: window.location.origin + '/docs/oauth2-redirect',
+        dom_id: '#swagger-ui',
+        presets: [
+        SwaggerUIBundle.presets.apis,
+        SwaggerUIBundle.SwaggerUIStandalonePreset
+        ],
+        layout: "BaseLayout",
+        deepLinking: true,
+        showExtensions: true,
+        showCommonExtensions: true
+    })
+    </script>
+    </body>
+    </html>
+    

gns3dms/cloud/base_cloud_ctrl.py

@@ -1,289 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2014 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-"""
-Base cloud controller class.
-
-Base class for interacting with Cloud APIs to create and manage cloud
-instances.
-
-"""
-from collections import namedtuple
-import hashlib
-import os
-import logging
-from io import StringIO, BytesIO
-
-from libcloud.compute.base import NodeAuthSSHKey
-from libcloud.storage.types import ContainerAlreadyExistsError, ContainerDoesNotExistError
-
-from .exceptions import ItemNotFound, KeyPairExists, MethodNotAllowed
-from .exceptions import OverLimit, BadRequest, ServiceUnavailable
-from .exceptions import Unauthorized, ApiError
-
-
-KeyPair = namedtuple("KeyPair", ['name'], verbose=False)
-log = logging.getLogger(__name__)
-
-
-def parse_exception(exception):
-    """
-    Parse the exception to separate the HTTP status code from the text.
-
-    Libcloud raises many exceptions of the form:
-        Exception("<http status code> <http error> <reponse body>")
-
-    in lieu of raising specific incident-based exceptions.
-
-    """
-
-    e_str = str(exception)
-
-    try:
-        status = int(e_str[0:3])
-        error_text = e_str[3:]
-
-    except ValueError:
-        status = None
-        error_text = e_str
-
-    return status, error_text
-
-
-class BaseCloudCtrl(object):
-
-    """ Base class for interacting with a cloud provider API. """
-
-    http_status_to_exception = {
-        400: BadRequest,
-        401: Unauthorized,
-        404: ItemNotFound,
-        405: MethodNotAllowed,
-        413: OverLimit,
-        500: ApiError,
-        503: ServiceUnavailable
-    }
-
-    GNS3_CONTAINER_NAME = 'GNS3'
-
-    def __init__(self, username, api_key):
-        self.username = username
-        self.api_key = api_key
-
-    def _handle_exception(self, status, error_text, response_overrides=None):
-        """ Raise an exception based on the HTTP status. """
-
-        if response_overrides:
-            if status in response_overrides:
-                raise response_overrides[status](error_text)
-
-        raise self.http_status_to_exception[status](error_text)
-
-    def authenticate(self):
-        """ Validate cloud account credentials.  Return boolean. """
-        raise NotImplementedError
-
-    def list_sizes(self):
-        """ Return a list of NodeSize objects. """
-
-        return self.driver.list_sizes()
-
-    def list_flavors(self):
-        """ Return an iterable of flavors """
-
-        raise NotImplementedError
-
-    def create_instance(self, name, size_id, image_id, keypair):
-        """
-        Create a new instance with the supplied attributes.
-
-        Return a Node object.
-
-        """
-        try:
-            image = self.get_image(image_id)
-            if image is None:
-                raise ItemNotFound("Image not found")
-
-            size = self.driver.ex_get_size(size_id)
-
-            args = {
-                "name": name,
-                "size": size,
-                "image": image,
-            }
-
-            if keypair is not None:
-                auth_key = NodeAuthSSHKey(keypair.public_key)
-                args["auth"] = auth_key
-                args["ex_keyname"] = name
-
-            return self.driver.create_node(**args)
-
-        except Exception as e:
-            status, error_text = parse_exception(e)
-
-            if status:
-                self._handle_exception(status, error_text)
-            else:
-                log.error("create_instance method raised an exception: {}".format(e))
-                log.error('image id {}'.format(image))
-
-    def delete_instance(self, instance):
-        """ Delete the specified instance.  Returns True or False. """
-
-        try:
-            return self.driver.destroy_node(instance)
-
-        except Exception as e:
-
-            status, error_text = parse_exception(e)
-
-            if status:
-                self._handle_exception(status, error_text)
-            else:
-                raise e
-
-    def get_instance(self, instance):
-        """ Return a Node object representing the requested instance. """
-
-        for i in self.driver.list_nodes():
-            if i.id == instance.id:
-                return i
-
-        raise ItemNotFound("Instance not found")
-
-    def list_instances(self):
-        """ Return a list of instances in the current region. """
-
-        try:
-            return self.driver.list_nodes()
-        except Exception as e:
-            log.error("list_instances returned an error: {}".format(e))
-
-
-    def create_key_pair(self, name):
-        """ Create and return a new Key Pair. """
-
-        response_overrides = {
-            409: KeyPairExists
-        }
-        try:
-            return self.driver.create_key_pair(name)
-
-        except Exception as e:
-            status, error_text = parse_exception(e)
-            if status:
-                self._handle_exception(status, error_text, response_overrides)
-            else:
-                raise e
-
-    def delete_key_pair(self, keypair):
-        """ Delete the keypair. Returns True or False. """
-
-        try:
-            return self.driver.delete_key_pair(keypair)
-
-        except Exception as e:
-            status, error_text = parse_exception(e)
-            if status:
-                self._handle_exception(status, error_text)
-            else:
-                raise e
-
-    def delete_key_pair_by_name(self, keypair_name):
-        """ Utility method to incapsulate boilerplate code """
-
-        kp = KeyPair(name=keypair_name)
-        return self.delete_key_pair(kp)
-
-    def list_key_pairs(self):
-        """ Return a list of Key Pairs. """
-
-        return self.driver.list_key_pairs()
-
-    def upload_file(self, file_path, folder):
-        """
-        Uploads file to cloud storage (if it is not identical to a file already in cloud storage).
-        :param file_path: path to file to upload
-        :param folder: folder in cloud storage to save file in
-        :return: True if file was uploaded, False if it was skipped because it already existed and was identical
-        """
-        try:
-            gns3_container = self.storage_driver.create_container(self.GNS3_CONTAINER_NAME)
-        except ContainerAlreadyExistsError:
-            gns3_container = self.storage_driver.get_container(self.GNS3_CONTAINER_NAME)
-
-        with open(file_path, 'rb') as file:
-            local_file_hash = hashlib.md5(file.read()).hexdigest()
-
-            cloud_object_name = folder + '/' + os.path.basename(file_path)
-            cloud_hash_name = cloud_object_name + '.md5'
-            cloud_objects = [obj.name for obj in gns3_container.list_objects()]
-
-            # if the file and its hash are in object storage, and the local and storage file hashes match
-            # do not upload the file, otherwise upload it
-            if cloud_object_name in cloud_objects and cloud_hash_name in cloud_objects:
-                hash_object = gns3_container.get_object(cloud_hash_name)
-                cloud_object_hash = ''
-                for chunk in hash_object.as_stream():
-                    cloud_object_hash += chunk.decode('utf8')
-
-                if cloud_object_hash == local_file_hash:
-                    return False
-
-            file.seek(0)
-            self.storage_driver.upload_object_via_stream(file, gns3_container, cloud_object_name)
-            self.storage_driver.upload_object_via_stream(StringIO(local_file_hash), gns3_container, cloud_hash_name)
-            return True
-
-    def list_projects(self):
-        """
-        Lists projects in cloud storage
-        :return: List of (project name, object name in storage)
-        """
-
-        try:
-            gns3_container = self.storage_driver.get_container(self.GNS3_CONTAINER_NAME)
-            projects = [
-                (obj.name.replace('projects/', '').replace('.zip', ''), obj.name)
-                for obj in gns3_container.list_objects()
-                if obj.name.startswith('projects/') and obj.name[-4:] == '.zip'
-            ]
-            return projects
-        except ContainerDoesNotExistError:
-            return []
-
-    def download_file(self, file_name, destination=None):
-        """
-        Downloads file from cloud storage
-        :param file_name: name of file in cloud storage to download
-        :param destination: local path to save file to (if None, returns file contents as a file-like object)
-        :return: A file-like object if file contents are returned, or None if file is saved to filesystem
-        """
-
-        gns3_container = self.storage_driver.get_container(self.GNS3_CONTAINER_NAME)
-        storage_object = gns3_container.get_object(file_name)
-        if destination is not None:
-            storage_object.download(destination)
-        else:
-            contents = b''
-
-            for chunk in storage_object.as_stream():
-                contents += chunk
-
-            return BytesIO(contents)

gns3dms/cloud/exceptions.py

@@ -1,45 +0,0 @@
-""" Exception classes for CloudCtrl classes. """
-
-class ApiError(Exception):
-    """ Raised when the server returns 500 Compute Error. """
-    pass
-
-class BadRequest(Exception):
-    """ Raised when the server returns 400 Bad Request. """
-    pass
-
-class ComputeFault(Exception):
-    """ Raised when the server returns 400|500 Compute Fault. """
-    pass
-
-class Forbidden(Exception):
-    """ Raised when the server returns 403 Forbidden. """
-    pass
-
-class ItemNotFound(Exception):
-    """ Raised when the server returns 404 Not Found. """
-    pass
-
-class KeyPairExists(Exception):
-    """ Raised when the server returns 409 Conflict Key pair exists. """
-    pass
-
-class MethodNotAllowed(Exception):
-    """ Raised when the server returns 405 Method Not Allowed. """
-    pass
-
-class OverLimit(Exception):
-    """ Raised when the server returns 413 Over Limit. """
-    pass
-
-class ServerCapacityUnavailable(Exception):
-    """ Raised when the server returns 503 Server Capacity Uavailable. """
-    pass
-
-class ServiceUnavailable(Exception):
-    """ Raised when the server returns 503 Service Unavailable. """
-    pass
-
-class Unauthorized(Exception):
-    """ Raised when the server returns 401 Unauthorized. """
-    pass

gns3dms/cloud/rackspace_ctrl.py

@@ -1,311 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2014 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-""" Interacts with Rackspace API to create and manage cloud instances. """
-
-from .base_cloud_ctrl import BaseCloudCtrl
-import json
-import requests
-from libcloud.compute.drivers.rackspace import ENDPOINT_ARGS_MAP
-from libcloud.compute.providers import get_driver
-from libcloud.compute.types import Provider
-from libcloud.storage.providers import get_driver as get_storage_driver
-from libcloud.storage.types import Provider as StorageProvider
-
-from .exceptions import ItemNotFound, ApiError
-from ..version import __version__
-
-from collections import OrderedDict
-
-import logging
-log = logging.getLogger(__name__)
-
-RACKSPACE_REGIONS = [{ENDPOINT_ARGS_MAP[k]['region']: k} for k in
-                     ENDPOINT_ARGS_MAP]
-
-
-class RackspaceCtrl(BaseCloudCtrl):
-
-    """ Controller class for interacting with Rackspace API. """
-
-    def __init__(self, username, api_key, gns3_ias_url):
-        super(RackspaceCtrl, self).__init__(username, api_key)
-
-        self.gns3_ias_url = gns3_ias_url
-
-        # set this up so it can be swapped out with a mock for testing
-        self.post_fn = requests.post
-        self.driver_cls = get_driver(Provider.RACKSPACE)
-        self.storage_driver_cls = get_storage_driver(StorageProvider.CLOUDFILES)
-
-        self.driver = None
-        self.storage_driver = None
-        self.region = None
-        self.instances = {}
-
-        self.authenticated = False
-        self.identity_ep = \
-            "https://identity.api.rackspacecloud.com/v2.0/tokens"
-
-        self.regions = []
-        self.token = None
-        self.tenant_id = None
-        self.flavor_ep = "https://dfw.servers.api.rackspacecloud.com/v2/{username}/flavors"
-        self._flavors = OrderedDict([
-            ('2', '512MB, 1 VCPU'),
-            ('3', '1GB, 1 VCPU'),
-            ('4', '2GB, 2 VCPUs'),
-            ('5', '4GB, 2 VCPUs'),
-            ('6', '8GB, 4 VCPUs'),
-            ('7', '15GB, 6 VCPUs'),
-            ('8', '30GB, 8 VCPUs'),
-            ('performance1-1', '1GB Performance, 1 VCPU'),
-            ('performance1-2', '2GB Performance, 2 VCPUs'),
-            ('performance1-4', '4GB Performance, 4 VCPUs'),
-            ('performance1-8', '8GB Performance, 8 VCPUs'),
-            ('performance2-15', '15GB Performance, 4 VCPUs'),
-            ('performance2-30', '30GB Performance, 8 VCPUs'),
-            ('performance2-60', '60GB Performance, 16 VCPUs'),
-            ('performance2-90', '90GB Performance, 24 VCPUs'),
-            ('performance2-120', '120GB Performance, 32 VCPUs',)
-        ])
-
-    def authenticate(self):
-        """
-        Submit username and api key to API service.
-
-        If authentication is successful, set self.regions and self.token.
-        Return boolean.
-
-        """
-
-        self.authenticated = False
-
-        if len(self.username) < 1:
-            return False
-
-        if len(self.api_key) < 1:
-            return False
-
-        data = json.dumps({
-            "auth": {
-                "RAX-KSKEY:apiKeyCredentials": {
-                    "username": self.username,
-                    "apiKey": self.api_key
-                }
-            }
-        })
-
-        headers = {
-            'Content-type': 'application/json',
-            'Accept': 'application/json'
-        }
-
-        response = self.post_fn(self.identity_ep, data=data, headers=headers)
-
-        if response.status_code == 200:
-
-            api_data = response.json()
-            self.token = self._parse_token(api_data)
-
-            if self.token:
-                self.authenticated = True
-                user_regions = self._parse_endpoints(api_data)
-                self.regions = self._make_region_list(user_regions)
-                self.tenant_id = self._parse_tenant_id(api_data)
-
-        else:
-            self.regions = []
-            self.token = None
-
-        response.connection.close()
-
-        return self.authenticated
-
-    def list_regions(self):
-        """ Return a list the regions available to the user. """
-
-        return self.regions
-
-    def list_flavors(self):
-        """ Return the dictionary containing flavors id and names """
-
-        return self._flavors
-
-    def _parse_endpoints(self, api_data):
-        """
-        Parse the JSON-encoded data returned by the Identity Service API.
-
-        Return a list of regions available for Compute v2.
-
-        """
-
-        region_codes = []
-
-        for ep_type in api_data['access']['serviceCatalog']:
-            if ep_type['name'] == "cloudServersOpenStack" \
-                    and ep_type['type'] == "compute":
-
-                for ep in ep_type['endpoints']:
-                    if ep['versionId'] == "2":
-                        region_codes.append(ep['region'])
-
-        return region_codes
-
-    def _parse_token(self, api_data):
-        """ Parse the token from the JSON-encoded data returned by the API. """
-
-        try:
-            token = api_data['access']['token']['id']
-        except KeyError:
-            return None
-
-        return token
-
-    def _parse_tenant_id(self, api_data):
-        """  """
-        try:
-            roles = api_data['access']['user']['roles']
-            for role in roles:
-                if 'tenantId' in role and role['name'] == 'compute:default':
-                    return role['tenantId']
-            return None
-        except KeyError:
-            return None
-
-    def _make_region_list(self, region_codes):
-        """
-        Make a list of regions for use in the GUI.
-
-        Returns a list of key-value pairs in the form:
-            <API's Region Name>: <libcloud's Region Name>
-            eg,
-            [
-                {'DFW': 'dfw'}
-                {'ORD': 'ord'},
-                ...
-            ]
-
-        """
-
-        region_list = []
-
-        for ep in ENDPOINT_ARGS_MAP:
-            if ENDPOINT_ARGS_MAP[ep]['region'] in region_codes:
-                region_list.append({ENDPOINT_ARGS_MAP[ep]['region']: ep})
-
-        return region_list
-
-    def set_region(self, region):
-        """ Set self.region and self.driver. Returns True or False. """
-
-        try:
-            self.driver = self.driver_cls(self.username, self.api_key,
-                                          region=region)
-            self.storage_driver = self.storage_driver_cls(self.username, self.api_key,
-                                                          region=region)
-
-        except ValueError:
-            return False
-
-        self.region = region
-        return True
-
-    def _get_shared_images(self, username, region, gns3_version):
-        """
-        Given a GNS3 version, ask gns3-ias to share compatible images
-
-        Response:
-            [{"created_at": "", "schema": "", "status": "", "member_id": "", "image_id": "", "updated_at": ""},]
-            or, if access was already asked
-            [{"image_id": "", "member_id": "", "status": "ALREADYREQUESTED"},]
-        """
-        endpoint = self.gns3_ias_url+"/images/grant_access"
-        params = {
-            "user_id": username,
-            "user_region": region.upper(),
-            "gns3_version": gns3_version,
-        }
-        try:
-            response = requests.get(endpoint, params=params)
-        except requests.ConnectionError:
-            raise ApiError("Unable to connect to IAS")
-
-        status = response.status_code
-
-        if status == 200:
-            return response.json()
-        elif status == 404:
-            raise ItemNotFound()
-        else:
-            raise ApiError("IAS status code: %d" % status)
-
-    def list_images(self):
-        """
-        Return a dictionary containing RackSpace server images
-        retrieved from gns3-ias server
-        """
-        if not (self.tenant_id and self.region):
-            return {}
-
-        try:
-            shared_images = self._get_shared_images(self.tenant_id, self.region, __version__)
-            images = {}
-            for i in shared_images:
-                images[i['image_id']] = i['image_name']
-            return images
-        except ItemNotFound:
-            return {}
-        except ApiError as e:
-            log.error('Error while retrieving image list: %s' % e)
-            return {}
-
-    def get_image(self, image_id):
-        return self.driver.get_image(image_id)
-
-
-def get_provider(cloud_settings):
-    """
-    Utility function to retrieve a cloud provider instance already authenticated and with the
-    region set
-
-    :param cloud_settings: cloud settings dictionary
-    :return: a provider instance or None on errors
-    """
-    try:
-        username = cloud_settings['cloud_user_name']
-        apikey = cloud_settings['cloud_api_key']
-        region = cloud_settings['cloud_region']
-        ias_url = cloud_settings.get('gns3_ias_url', '')
-    except KeyError as e:
-        log.error("Unable to create cloud provider: {}".format(e))
-        return
-
-    provider = RackspaceCtrl(username, apikey, ias_url)
-
-    if not provider.authenticate():
-        log.error("Authentication failed for cloud provider")
-        return
-
-    if not region:
-        region = provider.list_regions().values()[0]
-
-    if not provider.set_region(region):
-        log.error("Unable to set cloud provider region")
-        return
-
-    return provider

gns3dms/main.py

@@ -1,401 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# __version__ is a human-readable version number.
-
-# __version_info__ is a four-tuple for programmatic comparison. The first
-# three numbers are the components of the version number. The fourth
-# is zero for an official release, positive for a development branch,
-# or negative for a release candidate or beta (after the base version
-# number has been incremented)
-
-"""
-Monitors communication with the GNS3 client via tmp file. Will terminate the instance if
-communication is lost.
-"""
-
-import os
-import sys
-import time
-import getopt
-import datetime
-import logging
-import signal
-import configparser
-from logging.handlers import *
-from os.path import expanduser
-
-SCRIPT_NAME = os.path.basename(__file__)
-
-#Is the full path when used as an import
-SCRIPT_PATH = os.path.dirname(__file__)
-
-if not SCRIPT_PATH:
-    SCRIPT_PATH = os.path.join(os.path.dirname(os.path.abspath(
-        sys.argv[0])))
-
-
-EXTRA_LIB = "%s/modules" % (SCRIPT_PATH)
-sys.path.append(EXTRA_LIB)
-
-from . import cloud
-from rackspace_cloud import Rackspace
-
-LOG_NAME = "gns3dms"
-log = None
-
-sys.path.append(EXTRA_LIB)
-
-import daemon
-
-my_daemon = None
-
-usage = """
-USAGE: %s
-
-Options:
-
-  -d, --debug         Enable debugging
-  -v, --verbose       Enable verbose logging
-  -h, --help          Display this menu :)
-
-  --cloud_api_key <api_key>  Rackspace API key
-  --cloud_user_name
-
-  --instance_id       ID of the Rackspace instance to terminate
-  --cloud_region      Region of instance
-
-  --deadtime          How long in seconds can the communication lose exist before we
-                      shutdown this instance.
-                      Default:
-                      Example --deadtime=3600 (60 minutes)
-
-  --check-interval    Defaults to --deadtime, used for debugging
-
-  --init-wait         Inital wait time, how long before we start pulling the file.
-                      Default: 300 (5 min)
-                      Example --init-wait=300
-
-  --file              The file we monitor for updates
-
-  -k                  Kill previous instance running in background
-  --background        Run in background
-
-""" % (SCRIPT_NAME)
-
-# Parse cmd line options
-def parse_cmd_line(argv):
-    """
-    Parse command line arguments
-
-    argv: Pass in cmd line arguments
-    """
-
-    short_args = "dvhk"
-    long_args = ("debug",
-                    "verbose",
-                    "help",
-                    "cloud_user_name=",
-                    "cloud_api_key=",
-                    "instance_id=",
-                    "region=",
-                    "deadtime=",
-                    "init-wait=",
-                    "check-interval=",
-                    "file=",
-                    "background",
-                    )
-    try:
-        opts, extra_opts = getopt.getopt(argv[1:], short_args, long_args)
-    except getopt.GetoptError as e:
-        print("Unrecognized command line option or missing required argument: %s" %(e))
-        print(usage)
-        sys.exit(2)
-
-    cmd_line_option_list = {}
-    cmd_line_option_list["debug"] = False
-    cmd_line_option_list["verbose"] = True
-    cmd_line_option_list["cloud_user_name"] = None
-    cmd_line_option_list["cloud_api_key"] = None
-    cmd_line_option_list["instance_id"] = None
-    cmd_line_option_list["region"] = None
-    cmd_line_option_list["deadtime"] = 60 * 60 #minutes
-    cmd_line_option_list["check-interval"] = None
-    cmd_line_option_list["init-wait"] = 5 * 60
-    cmd_line_option_list["file"] = None
-    cmd_line_option_list["shutdown"] = False
-    cmd_line_option_list["daemon"] = False
-    cmd_line_option_list['starttime'] = datetime.datetime.now()
-
-    if sys.platform == "linux":
-        cmd_line_option_list['syslog'] = "/dev/log"
-    elif sys.platform == "osx":
-        cmd_line_option_list['syslog'] = "/var/run/syslog"
-    else:
-        cmd_line_option_list['syslog'] = ('localhost',514)
-
-
-    get_gns3secrets(cmd_line_option_list)
-
-    for opt, val in opts:
-        if (opt in ("-h", "--help")):
-            print(usage)
-            sys.exit(0)
-        elif (opt in ("-d", "--debug")):
-            cmd_line_option_list["debug"] = True
-        elif (opt in ("-v", "--verbose")):
-            cmd_line_option_list["verbose"] = True
-        elif (opt in ("--cloud_user_name")):
-            cmd_line_option_list["cloud_user_name"] = val
-        elif (opt in ("--cloud_api_key")):
-            cmd_line_option_list["cloud_api_key"] = val
-        elif (opt in ("--instance_id")):
-            cmd_line_option_list["instance_id"] = val
-        elif (opt in ("--region")):
-            cmd_line_option_list["region"] = val
-        elif (opt in ("--deadtime")):
-            cmd_line_option_list["deadtime"] = int(val)
-        elif (opt in ("--check-interval")):
-            cmd_line_option_list["check-interval"] = int(val)
-        elif (opt in ("--init-wait")):
-            cmd_line_option_list["init-wait"] = int(val)
-        elif (opt in ("--file")):
-            cmd_line_option_list["file"] = val
-        elif (opt in ("-k")):
-            cmd_line_option_list["shutdown"] = True
-        elif (opt in ("--background")):
-            cmd_line_option_list["daemon"] = True
-
-    if cmd_line_option_list["shutdown"] == False:
-
-        if cmd_line_option_list["check-interval"] is None:
-            cmd_line_option_list["check-interval"] = cmd_line_option_list["deadtime"] + 120
-
-        if cmd_line_option_list["cloud_user_name"] is None:
-            print("You need to specify a username!!!!")
-            print(usage)
-            sys.exit(2)
-
-        if cmd_line_option_list["cloud_api_key"] is None:
-            print("You need to specify an apikey!!!!")
-            print(usage)
-            sys.exit(2)
-
-        if cmd_line_option_list["file"] is None:
-            print("You need to specify a file to watch!!!!")
-            print(usage)
-            sys.exit(2)
-
-        if cmd_line_option_list["instance_id"] is None:
-            print("You need to specify an instance_id")
-            print(usage)
-            sys.exit(2)
-
-        if cmd_line_option_list["cloud_region"] is None:
-            print("You need to specify a cloud_region")
-            print(usage)
-            sys.exit(2)
-
-
-    return cmd_line_option_list
-
-def get_gns3secrets(cmd_line_option_list):
-    """
-    Load cloud credentials from .gns3secrets
-    """
-
-    gns3secret_paths = [
-        os.path.join(os.path.expanduser("~"), '.config', 'GNS3'),
-        SCRIPT_PATH,
-    ]
-
-    config = configparser.ConfigParser()
-
-    for gns3secret_path in gns3secret_paths:
-        gns3secret_file = "%s/cloud.conf" % (gns3secret_path)
-        if os.path.isfile(gns3secret_file):
-            config.read(gns3secret_file)
-
-    try:
-        for key, value in config.items("CLOUD_SERVER"):
-            cmd_line_option_list[key] = value.strip()
-    except configparser.NoSectionError:
-        pass
-
-
-def set_logging(cmd_options):
-    """
-    Setup logging and format output for console and syslog
-
-    Syslog is using the KERN facility
-    """
-    log = logging.getLogger("%s" % (LOG_NAME))
-    log_level = logging.INFO
-    log_level_console = logging.WARNING
-
-    if cmd_options['verbose'] == True:
-        log_level_console = logging.INFO
-
-    if cmd_options['debug'] == True:
-        log_level_console = logging.DEBUG
-        log_level = logging.DEBUG
-
-    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-    sys_formatter = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
-
-    console_log = logging.StreamHandler()
-    console_log.setLevel(log_level_console)
-    console_log.setFormatter(formatter)
-
-    syslog_hndlr = SysLogHandler(
-        address=cmd_options['syslog'],
-        facility=SysLogHandler.LOG_KERN
-    )
-
-    syslog_hndlr.setFormatter(sys_formatter)
-
-    log.setLevel(log_level)
-    log.addHandler(console_log)
-    log.addHandler(syslog_hndlr)
-
-    return log
-
-def send_shutdown(pid_file):
-    """
-    Sends the daemon process a kill signal
-    """
-    try:
-        with open(pid_file, 'r') as pidf:
-            pid = int(pidf.readline().strip())
-            pidf.close()
-            os.kill(pid, 15)
-    except:
-        log.info("No running instance found!!!")
-        log.info("Missing PID file: %s" % (pid_file))
-
-
-def _get_file_age(filename):
-    return datetime.datetime.fromtimestamp(
-                os.path.getmtime(filename)
-            )
-
-def monitor_loop(options):
-    """
-    Checks the options["file"] modification time against an interval. If the
-    modification time is too old we terminate the instance.
-    """
-
-    log.debug("Waiting for init-wait to pass: %s" % (options["init-wait"]))
-    time.sleep(options["init-wait"])
-
-    log.info("Starting monitor_loop")
-
-    terminate_attempts = 0
-
-    while options['shutdown'] == False:
-        log.debug("In monitor_loop for : %s" % (
-            datetime.datetime.now() - options['starttime'])
-        )
-
-        file_last_modified = _get_file_age(options["file"])
-        now = datetime.datetime.now()
-
-        delta = now - file_last_modified
-        log.debug("File last updated: %s seconds ago" % (delta.seconds))
-
-        if delta.seconds > options["deadtime"]:
-            log.warning("Deadtime exceeded, terminating instance ...")
-            #Terminate involes many layers of HTTP / API calls, lots of
-            #different errors types could occur here.
-            try:
-                rksp = Rackspace(options)
-                rksp.terminate()
-            except Exception as e:
-                log.critical("Exception during terminate: %s" % (e))
-
-            terminate_attempts+=1
-            log.warning("Termination sent, attempt: %s" % (terminate_attempts))
-            time.sleep(600)
-        else:
-            time.sleep(options["check-interval"])
-
-    log.info("Leaving monitor_loop")
-    log.info("Shutting down")
-
-
-def main():
-
-    global log
-    global my_daemon
-    options = parse_cmd_line(sys.argv)
-    log = set_logging(options)
-
-    def _shutdown(signalnum=None, frame=None):
-        """
-        Handles the SIGINT and SIGTERM event, inside of main so it has access to
-        the log vars.
-        """
-
-        log.info("Received shutdown signal")
-        options["shutdown"] = True
-
-    pid_file = "%s/.gns3dms.pid" % (expanduser("~"))
-
-    if options["shutdown"]:
-        send_shutdown(pid_file)
-        sys.exit(0)
-
-    if options["daemon"]:
-        my_daemon = MyDaemon(pid_file, options)
-
-    # Setup signal to catch Control-C / SIGINT and SIGTERM
-    signal.signal(signal.SIGINT, _shutdown)
-    signal.signal(signal.SIGTERM, _shutdown)
-
-    log.info("Starting ...")
-    log.debug("Using settings:")
-    for key, value in iter(sorted(options.items())):
-        log.debug("%s : %s" % (key, value))
-
-
-    log.debug("Checking file ....")
-    if os.path.isfile(options["file"]) == False:
-        log.critical("File does not exist!!!")
-        sys.exit(1)
-
-    test_acess = _get_file_age(options["file"])
-    if type(test_acess) is not datetime.datetime:
-        log.critical("Can't get file modification time!!!")
-        sys.exit(1)
-
-    if my_daemon:
-        my_daemon.start()
-    else:
-        monitor_loop(options)
-
-
-class MyDaemon(daemon.daemon):
-    def run(self):
-        monitor_loop(self.options)
-
-
-
-if __name__ == "__main__":
-    result = main()
-    sys.exit(result)
-
-

gns3dms/modules/__init__.py

@@ -1,24 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# __version__ is a human-readable version number.
-
-# __version_info__ is a four-tuple for programmatic comparison. The first
-# three numbers are the components of the version number. The fourth
-# is zero for an official release, positive for a development branch,
-# or negative for a release candidate or beta (after the base version
-# number has been incremented)

gns3dms/modules/daemon.py

@@ -1,138 +0,0 @@
-"""Generic linux daemon base class for python 3.x."""
-
-import sys, os, time, atexit, signal
-
-class daemon:
-    """A generic daemon class.
-
-    Usage: subclass the daemon class and override the run() method."""
-
-    def __init__(self, pidfile, options):
-        self.pidfile = pidfile
-        self.options = options
-
-    def daemonize(self):
-        """Deamonize class. UNIX double fork mechanism."""
-
-        try:
-            pid = os.fork()
-            if pid > 0:
-                # exit first parent
-                sys.exit(0)
-        except OSError as err:
-            sys.stderr.write('fork #1 failed: {0}\n'.format(err))
-            sys.exit(1)
-
-        # decouple from parent environment
-        os.chdir('/')
-        os.setsid()
-        os.umask(0)
-
-        # do second fork
-        try:
-            pid = os.fork()
-            if pid > 0:
-
-                # exit from second parent
-                sys.exit(0)
-        except OSError as err:
-            sys.stderr.write('fork #2 failed: {0}\n'.format(err))
-            sys.exit(1)
-
-        # redirect standard file descriptors
-        sys.stdout.flush()
-        sys.stderr.flush()
-        si = open(os.devnull, 'r')
-        so = open(os.devnull, 'a+')
-        se = open(os.devnull, 'a+')
-
-        os.dup2(si.fileno(), sys.stdin.fileno())
-        os.dup2(so.fileno(), sys.stdout.fileno())
-        os.dup2(se.fileno(), sys.stderr.fileno())
-
-        # write pidfile
-        atexit.register(self.delpid)
-
-        pid = str(os.getpid())
-        with open(self.pidfile,'w+') as f:
-            f.write(pid + '\n')
-
-    def delpid(self):
-        os.remove(self.pidfile)
-
-    def check_pid(self, pid):
-        """ Check For the existence of a unix pid. """
-        try:
-            os.kill(pid, 0)
-        except OSError:
-            return False
-        else:
-            return True
-
-    def start(self):
-        """Start the daemon."""
-
-        # Check for a pidfile to see if the daemon already runs
-        try:
-            with open(self.pidfile,'r') as pf:
-
-                pid = int(pf.read().strip())
-        except IOError:
-            pid = None
-
-        if pid:
-            pid_exist = self.check_pid(pid)
-
-            if pid_exist:
-                message = "Already running: %s\n" % (pid)
-                sys.stderr.write(message)
-                sys.exit(1)
-            else:
-                message = "pidfile {0} already exist. " + \
-                    "but process is dead\n"
-            sys.stderr.write(message.format(self.pidfile))
-
-        # Start the daemon
-        self.daemonize()
-        self.run()
-
-    def stop(self):
-        """Stop the daemon."""
-
-        # Get the pid from the pidfile
-        try:
-            with open(self.pidfile,'r') as pf:
-                pid = int(pf.read().strip())
-        except IOError:
-            pid = None
-
-        if not pid:
-            message = "pidfile {0} does not exist. " + \
-                    "Daemon not running?\n"
-            sys.stderr.write(message.format(self.pidfile))
-            return # not an error in a restart
-
-        # Try killing the daemon process
-        try:
-            while 1:
-                os.kill(pid, signal.SIGTERM)
-                time.sleep(0.1)
-        except OSError as err:
-            e = str(err.args)
-            if e.find("No such process") > 0:
-                if os.path.exists(self.pidfile):
-                    os.remove(self.pidfile)
-            else:
-                print (str(err.args))
-                sys.exit(1)
-
-    def restart(self):
-        """Restart the daemon."""
-        self.stop()
-        self.start()
-
-    def run(self):
-        """You should override this method when you subclass Daemon.
-
-        It will be called after the process has been daemonized by
-        start() or restart()."""

gns3dms/modules/rackspace_cloud.py

@@ -1,70 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# __version__ is a human-readable version number.
-
-# __version_info__ is a four-tuple for programmatic comparison. The first
-# three numbers are the components of the version number. The fourth
-# is zero for an official release, positive for a development branch,
-# or negative for a release candidate or beta (after the base version
-# number has been incremented)
-
-import os, sys
-import json
-import logging
-import socket
-
-from gns3dms.cloud.rackspace_ctrl import RackspaceCtrl
-
-
-LOG_NAME = "gns3dms.rksp"
-log = logging.getLogger("%s" % (LOG_NAME))
-
-class Rackspace(object):
-    def __init__(self, options):
-        self.username = options["cloud_user_name"]
-        self.apikey = options["cloud_api_key"]
-        self.authenticated = False
-        self.hostname = socket.gethostname()
-        self.instance_id = options["instance_id"]
-        self.region = options["region"]
-
-        log.debug("Authenticating with Rackspace")
-        log.debug("My hostname: %s" % (self.hostname))
-        self.rksp = RackspaceCtrl(self.username, self.apikey)
-        self.authenticated = self.rksp.authenticate()
-
-    def _find_my_instance(self):
-        if self.authenticated == False:
-            log.critical("Not authenticated against rackspace!!!!")
-
-        for region in self.rksp.list_regions():
-            log.debug("Rackspace regions: %s" % (region))
-            
-        log.debug("Checking region: %s" % (self.region))
-        self.rksp.set_region(self.region)
-        for server in self.rksp.list_instances():
-            log.debug("Checking server: %s" % (server.name))
-            if server.name.lower() == self.hostname.lower() and server.id == self.instance_id:
-                log.info("Found matching instance: %s" % (server.id))
-                log.info("Startup id: %s" % (self.instance_id))
-                return server
-
-    def terminate(self):
-        server = self._find_my_instance()
-        log.warning("Sending termination")
-        self.rksp.delete_instance(server)

gns3dms/version.py

@@ -1,27 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# __version__ is a human-readable version number.
-
-# __version_info__ is a four-tuple for programmatic comparison. The first
-# three numbers are the components of the version number. The fourth
-# is zero for an official release, positive for a development branch,
-# or negative for a release candidate or beta (after the base version
-# number has been incremented)
-
-__version__ = "0.1"
-__version_info__ = (0, 0, 1, -99)

gns3server.bat

@@ -0,0 +1,2 @@
+SET PYTHONPATH=%~dp0
+python.exe %~dp0/gns3server/main.py --debug --local

gns3server/__init__.py

@@ -1,6 +1,5 @@
-# -*- coding: utf-8 -*-
 #
-# Copyright (C) 2013 GNS3 Technologies Inc.
+# Copyright (C) 2015 GNS3 Technologies Inc.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -15,14 +14,4 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# __version__ is a human-readable version number.
-
-# __version_info__ is a four-tuple for programmatic comparison. The first
-# three numbers are the components of the version number. The fourth
-# is zero for an official release, positive for a development branch,
-# or negative for a release candidate or beta (after the base version
-# number has been incremented)
-
-#from .module_manager import ModuleManager
-#from .server import Server
 from .version import __version__

gns3server/__main__.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from .main import main
+
+main()

gns3server/_compat.py

@@ -1,36 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import sys
-
-PY2 = sys.version_info[0] == 2
-
-if not PY2:
-    unichr = chr
-    range_type = range
-    text_type = str
-    string_types = (str,)
-else:
-    unichr = unichr
-    text_type = unicode  # @UndefinedVariable
-    range_type = xrange  # @UndefinedVariable
-    string_types = (str, unicode)  # @UndefinedVariable
-
-try:
-    from urllib.parse import urlencode
-except ImportError:
-    from urllib import urlencode

gns3server/alembic.ini

@@ -0,0 +1,103 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = db_migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to db_migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:db_migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url =
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

gns3server/api/routes/compute/__init__.py

@@ -0,0 +1,267 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+from fastapi import FastAPI, Request, Depends
+from fastapi.responses import JSONResponse
+from starlette.exceptions import HTTPException as StarletteHTTPException
+from gns3server.controller.gns3vm.gns3_vm_error import GNS3VMError
+from gns3server.compute.error import ImageMissingError, NodeError
+from gns3server.compute.ubridge.ubridge_error import UbridgeError
+
+from .dependencies.authentication import compute_authentication
+
+from gns3server.compute.compute_error import (
+    ComputeError,
+    ComputeNotFoundError,
+    ComputeTimeoutError,
+    ComputeForbiddenError,
+    ComputeUnauthorizedError,
+)
+
+from . import capabilities
+from . import compute
+from . import projects
+from . import notifications
+from . import images
+from . import atm_switch_nodes
+from . import cloud_nodes
+from . import docker_nodes
+from . import dynamips_nodes
+from . import ethernet_hub_nodes
+from . import ethernet_switch_nodes
+from . import frame_relay_switch_nodes
+from . import iou_nodes
+from . import nat_nodes
+from . import qemu_nodes
+from . import virtualbox_nodes
+from . import vmware_nodes
+from . import vpcs_nodes
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+compute_api = FastAPI(
+    title="GNS3 compute API",
+    description="This page describes the private compute API for GNS3. PLEASE DO NOT USE DIRECTLY!",
+    version="v3",
+)
+
+compute_api.state.controller_host = None
+
+
+@compute_api.exception_handler(ComputeError)
+async def compute_error_handler(request: Request, exc: ComputeError):
+    log.error(f"Compute error: {exc}")
+    return JSONResponse(
+        status_code=409,
+        content={"message": str(exc)},
+    )
+
+
+@compute_api.exception_handler(ComputeTimeoutError)
+async def compute_timeout_error_handler(request: Request, exc: ComputeTimeoutError):
+    log.error(f"Compute timeout error: {exc}")
+    return JSONResponse(
+        status_code=408,
+        content={"message": str(exc)},
+    )
+
+
+@compute_api.exception_handler(ComputeUnauthorizedError)
+async def compute_unauthorized_error_handler(request: Request, exc: ComputeUnauthorizedError):
+    log.error(f"Compute unauthorized error: {exc}")
+    return JSONResponse(
+        status_code=401,
+        content={"message": str(exc)},
+    )
+
+
+@compute_api.exception_handler(ComputeForbiddenError)
+async def compute_forbidden_error_handler(request: Request, exc: ComputeForbiddenError):
+    log.error(f"Compute forbidden error: {exc}")
+    return JSONResponse(
+        status_code=403,
+        content={"message": str(exc)},
+    )
+
+
+@compute_api.exception_handler(ComputeNotFoundError)
+async def compute_not_found_error_handler(request: Request, exc: ComputeNotFoundError):
+    log.error(f"Compute not found error: {exc}")
+    return JSONResponse(
+        status_code=404,
+        content={"message": str(exc)},
+    )
+
+
+@compute_api.exception_handler(GNS3VMError)
+async def compute_gns3vm_error_handler(request: Request, exc: GNS3VMError):
+    log.error(f"Compute GNS3 VM error: {exc}")
+    return JSONResponse(
+        status_code=409,
+        content={"message": str(exc)},
+    )
+
+
+@compute_api.exception_handler(ImageMissingError)
+async def image_missing_error_handler(request: Request, exc: ImageMissingError):
+    log.error(f"Compute image missing error: {exc}")
+    return JSONResponse(
+        status_code=409,
+        content={"message": str(exc), "image": exc.image, "exception": exc.__class__.__name__},
+    )
+
+
+@compute_api.exception_handler(NodeError)
+async def node_error_handler(request: Request, exc: NodeError):
+    log.error(f"Compute node error: {exc}")
+    return JSONResponse(
+        status_code=409,
+        content={"message": str(exc), "exception": exc.__class__.__name__},
+    )
+
+
+@compute_api.exception_handler(UbridgeError)
+async def ubridge_error_handler(request: Request, exc: UbridgeError):
+    log.error(f"Compute uBridge error: {exc}")
+    return JSONResponse(
+        status_code=409,
+        content={"message": str(exc), "exception": exc.__class__.__name__},
+    )
+
+
+# make sure the content key is "message", not "detail" per default
+@compute_api.exception_handler(StarletteHTTPException)
+async def http_exception_handler(request: Request, exc: StarletteHTTPException):
+    return JSONResponse(
+        status_code=exc.status_code,
+        content={"message": exc.detail},
+    )
+
+
+compute_api.include_router(
+    capabilities.router,
+    dependencies=[Depends(compute_authentication)],
+    tags=["Capabilities"]
+)
+
+compute_api.include_router(
+    compute.router,
+    dependencies=[Depends(compute_authentication)],
+    tags=["Compute"]
+)
+
+compute_api.include_router(
+    notifications.router,
+    tags=["Notifications"]
+)
+
+compute_api.include_router(
+    projects.router,
+    dependencies=[Depends(compute_authentication)],
+    tags=["Projects"]
+)
+
+compute_api.include_router(
+    images.router,
+    dependencies=[Depends(compute_authentication)],
+    tags=["Images"]
+)
+
+compute_api.include_router(
+    atm_switch_nodes.router,
+    dependencies=[Depends(compute_authentication)],
+    prefix="/projects/{project_id}/atm_switch/nodes",
+    tags=["ATM switch"]
+)
+compute_api.include_router(
+    cloud_nodes.router,
+    dependencies=[Depends(compute_authentication)],
+    prefix="/projects/{project_id}/cloud/nodes",
+    tags=["Cloud nodes"]
+)
+
+compute_api.include_router(
+    docker_nodes.router,
+    prefix="/projects/{project_id}/docker/nodes",
+    tags=["Docker nodes"]
+)
+
+compute_api.include_router(
+    dynamips_nodes.router,
+    prefix="/projects/{project_id}/dynamips/nodes",
+    tags=["Dynamips nodes"]
+)
+
+compute_api.include_router(
+    ethernet_hub_nodes.router,
+    dependencies=[Depends(compute_authentication)],
+    prefix="/projects/{project_id}/ethernet_hub/nodes",
+    tags=["Ethernet hub nodes"]
+)
+
+compute_api.include_router(
+    ethernet_switch_nodes.router,
+    dependencies=[Depends(compute_authentication)],
+    prefix="/projects/{project_id}/ethernet_switch/nodes",
+    tags=["Ethernet switch nodes"]
+)
+
+compute_api.include_router(
+    frame_relay_switch_nodes.router,
+    dependencies=[Depends(compute_authentication)],
+    prefix="/projects/{project_id}/frame_relay_switch/nodes",
+    tags=["Frame Relay switch nodes"]
+)
+
+compute_api.include_router(
+    iou_nodes.router,
+    prefix="/projects/{project_id}/iou/nodes",
+    tags=["IOU nodes"])
+
+compute_api.include_router(
+    nat_nodes.router,
+    dependencies=[Depends(compute_authentication)],
+    prefix="/projects/{project_id}/nat/nodes",
+    tags=["NAT nodes"]
+)
+
+compute_api.include_router(
+    qemu_nodes.router,
+    prefix="/projects/{project_id}/qemu/nodes",
+    tags=["Qemu nodes"]
+)
+
+compute_api.include_router(
+    virtualbox_nodes.router,
+    prefix="/projects/{project_id}/virtualbox/nodes",
+    tags=["VirtualBox nodes"]
+)
+
+compute_api.include_router(
+    vmware_nodes.router,
+    prefix="/projects/{project_id}/vmware/nodes",
+    tags=["VMware nodes"]
+)
+
+compute_api.include_router(
+    vpcs_nodes.router,
+    prefix="/projects/{project_id}/vpcs/nodes",
+    tags=["VPCS nodes"]
+)

gns3server/api/routes/compute/atm_switch_nodes.py

@@ -0,0 +1,233 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for ATM switch nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Body, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.dynamips import Dynamips
+from gns3server.compute.dynamips.nodes.atm_switch import ATMSwitch
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or ATM switch node"}}
+
+router = APIRouter(responses=responses)
+
+
+async def dep_node(project_id: UUID, node_id: UUID) -> ATMSwitch:
+    """
+    Dependency to retrieve a node.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    node = dynamips_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.ATMSwitch,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create ATM switch node"}},
+)
+async def create_atm_switch(project_id: UUID, node_data: schemas.ATMSwitchCreate) -> schemas.ATMSwitch:
+    """
+    Create a new ATM switch node.
+    """
+
+    # Use the Dynamips ATM switch to simulate this node
+    dynamips_manager = Dynamips.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await dynamips_manager.create_node(
+        node_data.get("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_type="atm_switch",
+        mappings=node_data.get("mappings"),
+    )
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.ATMSwitch)
+def get_atm_switch(node: ATMSwitch = Depends(dep_node)) -> schemas.ATMSwitch:
+    """
+    Return an ATM switch node.
+    """
+
+    return node.asdict()
+
+
+@router.post("/{node_id}/duplicate", response_model=schemas.ATMSwitch, status_code=status.HTTP_201_CREATED)
+async def duplicate_atm_switch(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: ATMSwitch = Depends(dep_node)
+) -> schemas.ATMSwitch:
+    """
+    Duplicate an ATM switch node.
+    """
+
+    new_node = await Dynamips.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.ATMSwitch)
+async def update_atm_switch(
+        node_data: schemas.ATMSwitchUpdate,
+        node: ATMSwitch = Depends(dep_node)
+) -> schemas.ATMSwitch:
+    """
+    Update an ATM switch node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    if "name" in node_data and node.name != node_data["name"]:
+        await node.set_name(node_data["name"])
+    if "mappings" in node_data:
+        node.mappings = node_data["mappings"]
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_atm_switch_node(node: ATMSwitch = Depends(dep_node)) -> None:
+    """
+    Delete an ATM switch node.
+    """
+
+    await Dynamips.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+def start_atm_switch(node: ATMSwitch = Depends(dep_node)) -> None:
+    """
+    Start an ATM switch node.
+    This endpoint results in no action since ATM switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+def stop_atm_switch(node: ATMSwitch = Depends(dep_node)) -> None:
+    """
+    Stop an ATM switch node.
+    This endpoint results in no action since ATM switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+def suspend_atm_switch(node: ATMSwitch = Depends(dep_node)) -> None:
+    """
+    Suspend an ATM switch node.
+    This endpoint results in no action since ATM switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+)
+async def create_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: ATMSwitch = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = await Dynamips.instance().create_nio(node, jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_nio(adapter_number: int, port_number: int, node: ATMSwitch = Depends(dep_node)) -> None:
+    """
+    Remove a NIO (Network Input/Output) from the node.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = await node.remove_nio(port_number)
+    await nio.delete()
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: ATMSwitch = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the switch is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop_capture",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+async def stop_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: ATMSwitch = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the switch is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: ATMSwitch = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Dynamips.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/capabilities.py

@@ -0,0 +1,51 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for capabilities
+"""
+
+import sys
+import psutil
+
+from fastapi import APIRouter, Request
+
+from gns3server.version import __version__
+from gns3server.compute import MODULES
+from gns3server.utils.path import get_default_project_directory
+from gns3server import schemas
+
+router = APIRouter()
+
+
+@router.get("/capabilities", response_model=schemas.Capabilities)
+def get_capabilities(request: Request) -> dict:
+
+    node_types = []
+    for module in MODULES:
+        node_types.extend(module.node_types())
+
+    # record the controller hostname or IP address
+    request.app.state.controller_host = request.client.host
+
+    return {
+        "version": __version__,
+        "platform": sys.platform,
+        "cpus": psutil.cpu_count(logical=True),
+        "memory": psutil.virtual_memory().total,
+        "disk_size": psutil.disk_usage(get_default_project_directory()).total,
+        "node_types": node_types,
+    }

gns3server/api/routes/compute/cloud_nodes.py

@@ -0,0 +1,249 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for cloud nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import Union
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.builtin import Builtin
+from gns3server.compute.builtin.nodes.cloud import Cloud
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or cloud node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> Cloud:
+    """
+    Dependency to retrieve a node.
+    """
+
+    builtin_manager = Builtin.instance()
+    node = builtin_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.Cloud,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create cloud node"}},
+)
+async def create_cloud(project_id: UUID, node_data: schemas.CloudCreate) -> schemas.Cloud:
+    """
+    Create a new cloud node.
+    """
+
+    builtin_manager = Builtin.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await builtin_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_type="cloud",
+        ports=node_data.get("ports_mapping"),
+    )
+
+    # add the remote console settings
+    node.remote_console_host = node_data.get("remote_console_host", node.remote_console_host)
+    node.remote_console_port = node_data.get("remote_console_port", node.remote_console_port)
+    node.remote_console_type = node_data.get("remote_console_type", node.remote_console_type)
+    node.remote_console_http_path = node_data.get("remote_console_http_path", node.remote_console_http_path)
+    node.usage = node_data.get("usage", "")
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.Cloud)
+def get_cloud(node: Cloud = Depends(dep_node)) -> schemas.Cloud:
+    """
+    Return a cloud node.
+    """
+
+    return node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.Cloud)
+async def update_cloud(node_data: schemas.CloudUpdate, node: Cloud = Depends(dep_node)) -> schemas.Cloud:
+    """
+    Update a cloud node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Delete a cloud node.
+    """
+
+    await Builtin.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+async def start_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Start a cloud node.
+    """
+
+    await node.start()
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+async def stop_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Stop a cloud node.
+    This endpoint results in no action since cloud nodes cannot be stopped.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+async def suspend_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Suspend a cloud node.
+    This endpoint results in no action since cloud nodes cannot be suspended.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+)
+async def create_cloud_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+        node: Cloud = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = Builtin.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+)
+async def update_cloud_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+        node: Cloud = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Update a NIO (Network Input/Output) to the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.update_nio(port_number, nio)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_cloud_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Cloud = Depends(dep_node)
+) -> None:
+    """
+    Remove a NIO (Network Input/Output) from the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    await node.remove_nio(port_number)
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_cloud_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: Cloud = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
+)
+async def stop_cloud_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Cloud = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/pcap")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Cloud = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Builtin.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/compute.py

@@ -0,0 +1,143 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""
+API routes for compute.
+"""
+
+import os
+import psutil
+
+from gns3server.config import Config
+from gns3server.utils.cpu_percent import CpuPercent
+from gns3server.version import __version__
+from gns3server.utils.path import get_default_project_directory, is_safe_path
+from gns3server.compute.port_manager import PortManager
+from gns3server.compute.project_manager import ProjectManager
+from gns3server.utils.interfaces import interfaces
+from gns3server.compute.qemu import Qemu
+from gns3server.compute.virtualbox import VirtualBox
+from gns3server.compute.vmware import VMware
+from gns3server import schemas
+
+from fastapi import APIRouter, HTTPException, Body, Response, status
+from fastapi.encoders import jsonable_encoder
+from uuid import UUID
+from typing import Optional, List
+
+router = APIRouter()
+
+
+@router.post("/projects/{project_id}/ports/udp", status_code=status.HTTP_201_CREATED)
+def allocate_udp_port(project_id: UUID) -> dict:
+    """
+    Allocate a UDP port on the compute.
+    """
+
+    pm = ProjectManager.instance()
+    project = pm.get_project(str(project_id))
+    m = PortManager.instance()
+    udp_port = m.get_free_udp_port(project)
+    return {"udp_port": udp_port}
+
+
+@router.get("/network/interfaces")
+def network_interfaces() -> List[dict]:
+    """
+    List all the network interfaces available on the compute"
+    """
+
+    network_interfaces = interfaces()
+    return network_interfaces
+
+
+@router.get("/network/ports")
+def network_ports() -> dict:
+    """
+    List all the ports used on the compute"
+    """
+
+    m = PortManager.instance()
+    return m.asdict()
+
+
+@router.get("/version")
+def compute_version() -> dict:
+    """
+    Retrieve the server version number.
+    """
+
+    return {"version": __version__}
+
+
+@router.get("/statistics")
+def compute_statistics() -> dict:
+    """
+    Retrieve the server version number.
+    """
+
+    try:
+        memory_total = psutil.virtual_memory().total
+        memory_free = psutil.virtual_memory().available
+        memory_used = memory_total - memory_free  # actual memory usage in a cross platform fashion
+        swap_total = psutil.swap_memory().total
+        swap_free = psutil.swap_memory().free
+        swap_used = psutil.swap_memory().used
+        cpu_percent = int(CpuPercent.get())
+        load_average_percent = [int(x / psutil.cpu_count() * 100) for x in psutil.getloadavg()]
+        memory_percent = int(psutil.virtual_memory().percent)
+        swap_percent = int(psutil.swap_memory().percent)
+        disk_usage_percent = int(psutil.disk_usage(get_default_project_directory()).percent)
+    except psutil.Error as e:
+        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR)
+        # raise HTTPConflict(text="Psutil error detected: {}".format(e))
+
+    return {
+        "memory_total": memory_total,
+        "memory_free": memory_free,
+        "memory_used": memory_used,
+        "swap_total": swap_total,
+        "swap_free": swap_free,
+        "swap_used": swap_used,
+        "cpu_usage_percent": cpu_percent,
+        "memory_usage_percent": memory_percent,
+        "swap_usage_percent": swap_percent,
+        "disk_usage_percent": disk_usage_percent,
+        "load_average_percent": load_average_percent,
+    }
+
+
+@router.get("/qemu/capabilities")
+async def get_qemu_capabilities() -> dict:
+    capabilities = {"kvm": []}
+    kvms = await Qemu.get_kvm_archs()
+    if kvms:
+        capabilities["kvm"] = kvms
+    return capabilities
+
+
+@router.get("/virtualbox/vms", response_model=List[dict])
+async def get_virtualbox_vms() -> List[dict]:
+
+    vbox_manager = VirtualBox.instance()
+    return await vbox_manager.list_vms()
+
+
+@router.get("/vmware/vms", response_model=List[dict])
+async def get_vms() -> List[dict]:
+    vmware_manager = VMware.instance()
+    return await vmware_manager.list_vms()

gns3server/api/routes/compute/dependencies/authentication.py

@@ -0,0 +1,83 @@
+#
+# Copyright (C) 2021 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import secrets
+import base64
+import binascii
+import logging
+
+from fastapi import Depends, HTTPException, WebSocket, status
+from fastapi.security import HTTPBasic, HTTPBasicCredentials
+from fastapi.security.utils import get_authorization_scheme_param
+from gns3server.config import Config
+from typing import Optional, Union
+
+log = logging.getLogger(__name__)
+security = HTTPBasic()
+
+
+def compute_authentication(credentials: Optional[HTTPBasicCredentials] = Depends(security)) -> None:
+
+    server_settings = Config.instance().settings.Server
+    username = secrets.compare_digest(credentials.username, server_settings.compute_username)
+    password = secrets.compare_digest(credentials.password, server_settings.compute_password.get_secret_value())
+    if not (username and password):
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Invalid compute username or password",
+            headers={"WWW-Authenticate": "Basic"},
+        )
+
+async def ws_compute_authentication(websocket: WebSocket) -> Union[None, WebSocket]:
+    """
+    """
+
+    await websocket.accept()
+
+    # handle basic HTTP authentication
+    invalid_user_credentials_exc = HTTPException(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        detail="Could not validate credentials",
+        headers={"WWW-Authenticate": "Basic"},
+    )
+
+    try:
+        authorization = websocket.headers.get("Authorization")
+        scheme, param = get_authorization_scheme_param(authorization)
+        if not authorization or scheme.lower() != "basic":
+            raise invalid_user_credentials_exc
+        try:
+            data = base64.b64decode(param).decode("ascii")
+        except (ValueError, UnicodeDecodeError, binascii.Error):
+            raise invalid_user_credentials_exc
+
+        username, separator, password = data.partition(":")
+        if not separator:
+            raise invalid_user_credentials_exc
+
+        server_settings = Config.instance().settings.Server
+        username = secrets.compare_digest(username, server_settings.compute_username)
+        password = secrets.compare_digest(password, server_settings.compute_password.get_secret_value())
+        if not (username and password):
+            raise invalid_user_credentials_exc
+
+    except HTTPException as e:
+        err_msg = f"Could not authenticate while connecting to compute WebSocket: {e.detail}"
+        websocket_error = {"action": "log.error", "event": {"message": err_msg}}
+        await websocket.send_json(websocket_error)
+        log.error(err_msg)
+        return await websocket.close(code=1008)
+    return websocket

gns3server/api/routes/compute/docker_nodes.py

@@ -0,0 +1,393 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for Docker nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, Body, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+from typing import Union
+
+from gns3server import schemas
+from gns3server.compute.docker import Docker
+from gns3server.compute.docker.docker_vm import DockerVM
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Docker node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> DockerVM:
+    """
+    Dependency to retrieve a node.
+    """
+
+    docker_manager = Docker.instance()
+    node = docker_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.Docker,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Docker node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_docker_node(project_id: UUID, node_data: schemas.DockerCreate) -> schemas.Docker:
+    """
+    Create a new Docker node.
+    """
+
+    docker_manager = Docker.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    container = await docker_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        image=node_data.pop("image"),
+        start_command=node_data.get("start_command"),
+        environment=node_data.get("environment"),
+        adapters=node_data.get("adapters"),
+        mac_address=node_data.get("mac_address"),
+        console=node_data.get("console"),
+        console_type=node_data.get("console_type"),
+        console_resolution=node_data.get("console_resolution", "1024x768"),
+        console_http_port=node_data.get("console_http_port", 80),
+        console_http_path=node_data.get("console_http_path", "/"),
+        aux=node_data.get("aux"),
+        aux_type=node_data.pop("aux_type", "none"),
+        extra_hosts=node_data.get("extra_hosts"),
+        extra_volumes=node_data.get("extra_volumes"),
+        memory=node_data.get("memory", 0),
+        cpus=node_data.get("cpus", 0),
+    )
+    for name, value in node_data.items():
+        if name != "node_id":
+            if hasattr(container, name) and getattr(container, name) != value:
+                setattr(container, name, value)
+
+    return container.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.Docker,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_docker_node(node: DockerVM = Depends(dep_node)) -> schemas.Docker:
+    """
+    Return a Docker node.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.Docker,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_docker_node(node_data: schemas.DockerUpdate, node: DockerVM = Depends(dep_node)) -> schemas.Docker:
+    """
+    Update a Docker node.
+    """
+
+    props = [
+        "name",
+        "console",
+        "console_type",
+        "aux",
+        "aux_type",
+        "console_resolution",
+        "console_http_port",
+        "console_http_path",
+        "start_command",
+        "environment",
+        "adapters",
+        "mac_address",
+        "custom_adapters",
+        "extra_hosts",
+        "extra_volumes",
+        "memory",
+        "cpus",
+    ]
+
+    changed = False
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    for prop in props:
+        if prop in node_data and node_data[prop] != getattr(node, prop):
+            setattr(node, prop, node_data[prop])
+            changed = True
+    # We don't call container.update for nothing because it will restart the container
+    if changed:
+        await node.update()
+    node.updated()
+    return node.asdict()
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Start a Docker node.
+    """
+
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Stop a Docker node.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def suspend_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Suspend a Docker node.
+    """
+
+    await node.pause()
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Reload a Docker node.
+    """
+
+    await node.restart()
+
+
+@router.post(
+    "/{node_id}/pause",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def pause_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Pause a Docker node.
+    """
+
+    await node.pause()
+
+
+@router.post(
+    "/{node_id}/unpause",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def unpause_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Unpause a Docker node.
+    """
+
+    await node.unpause()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_docker_node(node: DockerVM = Depends(dep_node)) -> None:
+    """
+    Delete a Docker node.
+    """
+
+    await node.delete()
+
+
+@router.post(
+    "/{node_id}/duplicate",
+    response_model=schemas.Docker,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(compute_authentication)]
+)
+async def duplicate_docker_node(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: DockerVM = Depends(dep_node)
+) -> schemas.Docker:
+    """
+    Duplicate a Docker node.
+    """
+
+    new_node = await Docker.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_docker_node_nio(
+    adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: DockerVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The port number on the Docker node is always 0.
+    """
+
+    nio = Docker.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.adapter_add_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_docker_node_nio(
+    adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: DockerVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    The port number on the Docker node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.adapter_update_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_docker_node_nio(
+        adapter_number: int,
+        port_number: int,
+        node: DockerVM = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The port number on the Docker node is always 0.
+    """
+
+    await node.adapter_remove_nio_binding(adapter_number)
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_docker_node_capture(
+        adapter_number: int,
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: DockerVM = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The port number on the Docker node is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": str(pcap_file_path)}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_docker_node_capture(
+        adapter_number: int,
+        port_number: int,
+        node: DockerVM = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The port number on the Docker node is always 0.
+    """
+
+    await node.stop_capture(adapter_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        adapter_number: int,
+        port_number: int,
+        node: DockerVM = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The port number on the Docker node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    stream = Docker.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.websocket("/{node_id}/console/ws")
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: DockerVM = Depends(dep_node)
+) -> None:
+    """
+    Console WebSocket.
+    """
+
+    if websocket:
+        await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: DockerVM = Depends(dep_node)) -> None:
+
+    await node.reset_console()

gns3server/api/routes/compute/dynamips_nodes.py

@@ -0,0 +1,367 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for Dynamips nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Body, Depends, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import List, Union
+from uuid import UUID
+
+from gns3server.compute.dynamips import Dynamips
+from gns3server.compute.dynamips.nodes.router import Router
+from gns3server import schemas
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Dynamips node"}}
+
+router = APIRouter(responses=responses)
+
+
+DEFAULT_CHASSIS = {"c1700": "1720", "c2600": "2610", "c3600": "3640"}
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> Router:
+    """
+    Dependency to retrieve a node.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    node = dynamips_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.Dynamips,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Dynamips node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_router(project_id: UUID, node_data: schemas.DynamipsCreate) -> schemas.Dynamips:
+    """
+    Create a new Dynamips router.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    platform = node_data.platform
+    print(node_data.chassis, platform in DEFAULT_CHASSIS)
+    if not node_data.chassis and platform in DEFAULT_CHASSIS:
+        chassis = DEFAULT_CHASSIS[platform]
+    else:
+        chassis = node_data.chassis
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await dynamips_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        dynamips_id=node_data.get("dynamips_id"),
+        platform=platform,
+        console=node_data.get("console"),
+        console_type=node_data.get("console_type", "telnet"),
+        aux=node_data.get("aux"),
+        aux_type=node_data.pop("aux_type", "none"),
+        chassis=chassis,
+        node_type="dynamips",
+    )
+    await dynamips_manager.update_vm_settings(vm, node_data)
+    return vm.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.Dynamips,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_router(node: Router = Depends(dep_node)) -> schemas.Dynamips:
+    """
+    Return Dynamips router.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.Dynamips,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_router(node_data: schemas.DynamipsUpdate, node: Router = Depends(dep_node)) -> schemas.Dynamips:
+    """
+    Update a Dynamips router.
+    """
+
+    await Dynamips.instance().update_vm_settings(node, jsonable_encoder(node_data, exclude_unset=True))
+    node.updated()
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_router(node: Router = Depends(dep_node)) -> None:
+    """
+    Delete a Dynamips router.
+    """
+
+    await Dynamips.instance().delete_node(node.id)
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_router(node: Router = Depends(dep_node)) -> None:
+    """
+    Start a Dynamips router.
+    """
+
+    try:
+        await Dynamips.instance().ghost_ios_support(node)
+    except GeneratorExit:
+        pass
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_router(node: Router = Depends(dep_node)) -> None:
+    """
+    Stop a Dynamips router.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def suspend_router(node: Router = Depends(dep_node)) -> None:
+
+    await node.suspend()
+
+
+@router.post(
+    "/{node_id}/resume",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def resume_router(node: Router = Depends(dep_node)) -> None:
+    """
+    Resume a suspended Dynamips router.
+    """
+
+    await node.resume()
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_router(node: Router = Depends(dep_node)) -> None:
+    """
+    Reload a suspended Dynamips router.
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_nio(
+        adapter_number: int,
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: Router = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    """
+
+    nio = await Dynamips.instance().create_nio(node, jsonable_encoder(nio_data, exclude_unset=True))
+    await node.slot_add_nio_binding(adapter_number, port_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_nio(
+        adapter_number: int,
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: Router = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    """
+
+    nio = node.get_nio(adapter_number, port_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.slot_update_nio_binding(adapter_number, port_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_nio(adapter_number: int, port_number: int, node: Router = Depends(dep_node)) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    """
+
+    nio = await node.slot_remove_nio_binding(adapter_number, port_number)
+    await nio.delete()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_capture(
+        adapter_number: int,
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: Router = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_capture(adapter_number: int, port_number: int, node: Router = Depends(dep_node)) -> None:
+    """
+    Stop a packet capture on the node.
+    """
+
+    await node.stop_capture(adapter_number, port_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        adapter_number: int,
+        port_number: int,
+        node: Router = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    """
+
+    nio = node.get_nio(adapter_number, port_number)
+    stream = Dynamips.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.get(
+    "/{node_id}/idlepc_proposals",
+    dependencies=[Depends(compute_authentication)]
+)
+async def get_idlepcs(node: Router = Depends(dep_node)) -> List[str]:
+    """
+    Retrieve Dynamips idle-pc proposals
+    """
+
+    await node.set_idlepc("0x0")
+    return await node.get_idle_pc_prop()
+
+
+@router.get(
+    "/{node_id}/auto_idlepc",
+    dependencies=[Depends(compute_authentication)]
+)
+async def get_auto_idlepc(node: Router = Depends(dep_node)) -> dict:
+    """
+    Get an automatically guessed best idle-pc value.
+    """
+
+    idlepc = await Dynamips.instance().auto_idlepc(node)
+    return {"idlepc": idlepc}
+
+
+@router.post(
+    "/{node_id}/duplicate",
+    response_model=schemas.Dynamips,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(compute_authentication)]
+)
+async def duplicate_router(destination_node_id: UUID = Body(..., embed=True), node: Router = Depends(dep_node)) -> schemas.Dynamips:
+    """
+    Duplicate a router.
+    """
+
+    new_node = await Dynamips.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.websocket("/{node_id}/console/ws")
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: Router = Depends(dep_node)
+
+) -> None:
+    """
+    Console WebSocket.
+    """
+
+    if websocket:
+        await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: Router = Depends(dep_node)) -> None:
+
+    await node.reset_console()

gns3server/api/routes/compute/ethernet_hub_nodes.py

@@ -0,0 +1,236 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for Ethernet hub nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Body, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+
+from gns3server.compute.dynamips import Dynamips
+from gns3server.compute.dynamips.nodes.ethernet_hub import EthernetHub
+from gns3server import schemas
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Ethernet hub node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> EthernetHub:
+    """
+    Dependency to retrieve a node.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    node = dynamips_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.EthernetHub,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Ethernet hub node"}},
+)
+async def create_ethernet_hub(project_id: UUID, node_data: schemas.EthernetHubCreate) -> schemas.EthernetHub:
+    """
+    Create a new Ethernet hub.
+    """
+
+    # Use the Dynamips Ethernet hub to simulate this node
+    dynamips_manager = Dynamips.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await dynamips_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_type="ethernet_hub",
+        ports=node_data.get("ports_mapping"),
+    )
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.EthernetHub)
+def get_ethernet_hub(node: EthernetHub = Depends(dep_node)) -> schemas.EthernetHub:
+    """
+    Return an Ethernet hub.
+    """
+
+    return node.asdict()
+
+
+@router.post("/{node_id}/duplicate", response_model=schemas.EthernetHub, status_code=status.HTTP_201_CREATED)
+async def duplicate_ethernet_hub(
+    destination_node_id: UUID = Body(..., embed=True), node: EthernetHub = Depends(dep_node)
+) -> schemas.EthernetHub:
+    """
+    Duplicate an Ethernet hub.
+    """
+
+    new_node = await Dynamips.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.EthernetHub)
+async def update_ethernet_hub(
+        node_data: schemas.EthernetHubUpdate,
+        node: EthernetHub = Depends(dep_node)
+) -> schemas.EthernetHub:
+    """
+    Update an Ethernet hub.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    if "name" in node_data and node.name != node_data["name"]:
+        await node.set_name(node_data["name"])
+    if "ports_mapping" in node_data:
+        node.ports_mapping = node_data["ports_mapping"]
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_ethernet_hub(node: EthernetHub = Depends(dep_node)) -> None:
+    """
+    Delete an Ethernet hub.
+    """
+
+    await Dynamips.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+def start_ethernet_hub(node: EthernetHub = Depends(dep_node)) -> None:
+    """
+    Start an Ethernet hub.
+    This endpoint results in no action since Ethernet hub nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+def stop_ethernet_hub(node: EthernetHub = Depends(dep_node)) -> None:
+    """
+    Stop an Ethernet hub.
+    This endpoint results in no action since Ethernet hub nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+def suspend_ethernet_hub(node: EthernetHub = Depends(dep_node)) -> None:
+    """
+    Suspend an Ethernet hub.
+    This endpoint results in no action since Ethernet hub nodes are always on.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+)
+async def create_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: EthernetHub = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the hub is always 0.
+    """
+
+    nio = await Dynamips.instance().create_nio(node, jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: EthernetHub = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The adapter number on the hub is always 0.
+    """
+
+    nio = await node.remove_nio(port_number)
+    await nio.delete()
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: EthernetHub = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the hub is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
+)
+async def stop_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: EthernetHub = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the hub is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: EthernetHub = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the hub is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Dynamips.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/ethernet_switch_nodes.py

@@ -0,0 +1,246 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for Ethernet switch nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Body, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+
+from gns3server.compute.dynamips import Dynamips
+from gns3server.compute.dynamips.nodes.ethernet_switch import EthernetSwitch
+from gns3server import schemas
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Ethernet switch node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> EthernetSwitch:
+    """
+    Dependency to retrieve a node.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    node = dynamips_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.EthernetSwitch,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Ethernet switch node"}},
+)
+async def create_ethernet_switch(project_id: UUID, node_data: schemas.EthernetSwitchCreate) -> schemas.EthernetSwitch:
+    """
+    Create a new Ethernet switch.
+    """
+
+    # Use the Dynamips Ethernet switch to simulate this node
+    dynamips_manager = Dynamips.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await dynamips_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        console=node_data.get("console"),
+        console_type=node_data.get("console_type"),
+        node_type="ethernet_switch",
+        ports=node_data.get("ports_mapping"),
+    )
+
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.EthernetSwitch)
+def get_ethernet_switch(node: EthernetSwitch = Depends(dep_node)) -> schemas.EthernetSwitch:
+
+    return node.asdict()
+
+
+@router.post("/{node_id}/duplicate", response_model=schemas.EthernetSwitch, status_code=status.HTTP_201_CREATED)
+async def duplicate_ethernet_switch(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: EthernetSwitch = Depends(dep_node)
+) -> schemas.EthernetSwitch:
+    """
+    Duplicate an Ethernet switch.
+    """
+
+    new_node = await Dynamips.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.EthernetSwitch)
+async def update_ethernet_switch(
+        node_data: schemas.EthernetSwitchUpdate,
+        node: EthernetSwitch = Depends(dep_node)
+) -> schemas.EthernetSwitch:
+    """
+    Update an Ethernet switch.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    if "name" in node_data and node.name != node_data["name"]:
+        await node.set_name(node_data["name"])
+    if "ports_mapping" in node_data:
+        node.ports_mapping = node_data["ports_mapping"]
+        await node.update_port_settings()
+    if "console_type" in node_data:
+        node.console_type = node_data["console_type"]
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_ethernet_switch(node: EthernetSwitch = Depends(dep_node)) -> None:
+    """
+    Delete an Ethernet switch.
+    """
+
+    await Dynamips.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+def start_ethernet_switch(node: EthernetSwitch = Depends(dep_node)) -> None:
+    """
+    Start an Ethernet switch.
+    This endpoint results in no action since Ethernet switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+def stop_ethernet_switch(node: EthernetSwitch = Depends(dep_node)) -> None:
+    """
+    Stop an Ethernet switch.
+    This endpoint results in no action since Ethernet switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+def suspend_ethernet_switch(node: EthernetSwitch = Depends(dep_node)) -> None:
+    """
+    Suspend an Ethernet switch.
+    This endpoint results in no action since Ethernet switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/reload", status_code=status.HTTP_204_NO_CONTENT)
+def reload_ethernet_switch(node: EthernetSwitch = Depends(dep_node)) -> None:
+    """
+    Reload an Ethernet switch.
+    This endpoint results in no action since Ethernet switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+)
+async def create_ethernet_switch_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: EthernetSwitch = Depends(dep_node)
+) -> schemas.UDPNIO:
+
+    nio = await Dynamips.instance().create_nio(node, jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_ethernet_switch_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: EthernetSwitch = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = await node.remove_nio(port_number)
+    await nio.delete()
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_ethernet_switch_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: EthernetSwitch = Depends(dep_node),
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the switch is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
+)
+async def stop_ethernet_switch_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: EthernetSwitch = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the switch is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: EthernetSwitch = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Dynamips.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/frame_relay_switch_nodes.py

@@ -0,0 +1,240 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for Frame Relay switch nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Body, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.dynamips import Dynamips
+from gns3server.compute.dynamips.nodes.frame_relay_switch import FrameRelaySwitch
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Frame Relay switch node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> FrameRelaySwitch:
+    """
+    Dependency to retrieve a node.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    node = dynamips_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.FrameRelaySwitch,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Frame Relay switch node"}},
+)
+async def create_frame_relay_switch(
+        project_id: UUID,
+        node_data: schemas.FrameRelaySwitchCreate
+) -> schemas.FrameRelaySwitch:
+    """
+    Create a new Frame Relay switch node.
+    """
+
+    # Use the Dynamips Frame Relay switch to simulate this node
+    dynamips_manager = Dynamips.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await dynamips_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_type="frame_relay_switch",
+        mappings=node_data.get("mappings"),
+    )
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.FrameRelaySwitch)
+def get_frame_relay_switch(node: FrameRelaySwitch = Depends(dep_node)) -> schemas.FrameRelaySwitch:
+    """
+    Return a Frame Relay switch node.
+    """
+
+    return node.asdict()
+
+
+@router.post("/{node_id}/duplicate", response_model=schemas.FrameRelaySwitch, status_code=status.HTTP_201_CREATED)
+async def duplicate_frame_relay_switch(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: FrameRelaySwitch = Depends(dep_node)
+) -> schemas.FrameRelaySwitch:
+    """
+    Duplicate a Frame Relay switch node.
+    """
+
+    new_node = await Dynamips.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.FrameRelaySwitch)
+async def update_frame_relay_switch(
+        node_data: schemas.FrameRelaySwitchUpdate,
+        node: FrameRelaySwitch = Depends(dep_node)
+) -> schemas.FrameRelaySwitch:
+    """
+    Update an Frame Relay switch node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    if "name" in node_data and node.name != node_data["name"]:
+        await node.set_name(node_data["name"])
+    if "mappings" in node_data:
+        node.mappings = node_data["mappings"]
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_frame_relay_switch(node: FrameRelaySwitch = Depends(dep_node)) -> None:
+    """
+    Delete a Frame Relay switch node.
+    """
+
+    await Dynamips.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+def start_frame_relay_switch(node: FrameRelaySwitch = Depends(dep_node)) -> None:
+    """
+    Start a Frame Relay switch node.
+    This endpoint results in no action since Frame Relay switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+def stop_frame_relay_switch(node: FrameRelaySwitch = Depends(dep_node)) -> None:
+    """
+    Stop a Frame Relay switch node.
+    This endpoint results in no action since Frame Relay switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+def suspend_frame_relay_switch(node: FrameRelaySwitch = Depends(dep_node)) -> None:
+    """
+    Suspend a Frame Relay switch node.
+    This endpoint results in no action since Frame Relay switch nodes are always on.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+)
+async def create_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: FrameRelaySwitch = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = await Dynamips.instance().create_nio(node, jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: FrameRelaySwitch = Depends(dep_node)
+) -> None:
+    """
+    Remove a NIO (Network Input/Output) from the node.
+    The adapter number on the switch is always 0.
+    """
+
+    nio = await node.remove_nio(port_number)
+    await nio.delete()
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: FrameRelaySwitch = Depends(dep_node),
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the switch is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
+)
+async def stop_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: FrameRelaySwitch = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the switch is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: FrameRelaySwitch = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the hub is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Dynamips.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/images.py

@@ -0,0 +1,156 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for images.
+"""
+
+import os
+import urllib.parse
+
+from fastapi import APIRouter, Request, status, Response, HTTPException
+from fastapi.responses import FileResponse
+from typing import List
+
+from gns3server.compute.docker import Docker
+from gns3server.compute.dynamips import Dynamips
+from gns3server.compute.iou import IOU
+from gns3server.compute.qemu import Qemu
+
+router = APIRouter()
+
+
+@router.get("/docker/images")
+async def get_docker_images() -> List[dict]:
+    """
+    Get all Docker images.
+    """
+
+    docker_manager = Docker.instance()
+    return await docker_manager.list_images()
+
+
+@router.get("/dynamips/images")
+async def get_dynamips_images() -> List[dict]:
+    """
+    Get all Dynamips images.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    return await dynamips_manager.list_images()
+
+
+@router.post("/dynamips/images/{filename:path}", status_code=status.HTTP_204_NO_CONTENT)
+async def upload_dynamips_image(filename: str, request: Request) -> None:
+    """
+    Upload a Dynamips IOS image.
+    """
+
+    dynamips_manager = Dynamips.instance()
+    await dynamips_manager.write_image(urllib.parse.unquote(filename), request.stream())
+
+
+@router.get("/dynamips/images/{filename:path}")
+async def download_dynamips_image(filename: str) -> FileResponse:
+    """
+    Download a Dynamips IOS image.
+    """
+
+    filename = urllib.parse.unquote(filename)
+
+    # Raise error if user try to escape
+    if filename[0] == "." or os.path.sep in filename:
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    dynamips_manager = Dynamips.instance()
+    image_path = dynamips_manager.get_abs_image_path(filename)
+
+    if not os.path.exists(image_path):
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    return FileResponse(image_path, media_type="application/octet-stream")
+
+
+@router.get("/iou/images")
+async def get_iou_images() -> List[dict]:
+    """
+    Get all IOU images.
+    """
+
+    iou_manager = IOU.instance()
+    return await iou_manager.list_images()
+
+
+@router.post("/iou/images/{filename:path}", status_code=status.HTTP_204_NO_CONTENT)
+async def upload_iou_image(filename: str, request: Request) -> None:
+    """
+    Upload an IOU image.
+    """
+
+    iou_manager = IOU.instance()
+    await iou_manager.write_image(urllib.parse.unquote(filename), request.stream())
+
+
+@router.get("/iou/images/{filename:path}")
+async def download_iou_image(filename: str) -> FileResponse:
+    """
+    Download an IOU image.
+    """
+
+    filename = urllib.parse.unquote(filename)
+
+    # Raise error if user try to escape
+    if filename[0] == "." or os.path.sep in filename:
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    iou_manager = IOU.instance()
+    image_path = iou_manager.get_abs_image_path(filename)
+    if not os.path.exists(image_path):
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    return FileResponse(image_path, media_type="application/octet-stream")
+
+
+@router.get("/qemu/images")
+async def get_qemu_images() -> List[dict]:
+
+    qemu_manager = Qemu.instance()
+    return await qemu_manager.list_images()
+
+
+@router.post("/qemu/images/{filename:path}", status_code=status.HTTP_204_NO_CONTENT)
+async def upload_qemu_image(filename: str, request: Request) -> None:
+
+    qemu_manager = Qemu.instance()
+    await qemu_manager.write_image(urllib.parse.unquote(filename), request.stream())
+
+
+@router.get("/qemu/images/{filename:path}")
+async def download_qemu_image(filename: str) -> FileResponse:
+
+    filename = urllib.parse.unquote(filename)
+
+    # Raise error if user try to escape
+    if filename[0] == "." or os.path.sep in filename:
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    qemu_manager = Qemu.instance()
+    image_path = qemu_manager.get_abs_image_path(filename)
+
+    if not os.path.exists(image_path):
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    return FileResponse(image_path, media_type="application/octet-stream")

gns3server/api/routes/compute/iou_nodes.py

@@ -0,0 +1,344 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for IOU nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, Body, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import Union
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.iou import IOU
+from gns3server.compute.iou.iou_vm import IOUVM
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or IOU node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> IOUVM:
+    """
+    Dependency to retrieve a node.
+    """
+
+    iou_manager = IOU.instance()
+    node = iou_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.IOU,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create IOU node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_iou_node(project_id: UUID, node_data: schemas.IOUCreate) -> schemas.IOU:
+    """
+    Create a new IOU node.
+    """
+
+    iou = IOU.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await iou.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        application_id=node_data.get("application_id"),
+        path=node_data.get("path"),
+        console=node_data.get("console"),
+        console_type=node_data.get("console_type", "telnet"),
+    )
+
+    for name, value in node_data.items():
+        if hasattr(vm, name) and getattr(vm, name) != value:
+            if name == "application_id":
+                continue  # we must ignore this to avoid overwriting the application_id allocated by the controller
+            if name == "startup_config_content" and (vm.startup_config_content and len(vm.startup_config_content) > 0):
+                continue
+            if name == "private_config_content" and (vm.private_config_content and len(vm.private_config_content) > 0):
+                continue
+            if node_data.get("use_default_iou_values") and (name == "ram" or name == "nvram"):
+                continue
+            setattr(vm, name, value)
+    return vm.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.IOU,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_iou_node(node: IOUVM = Depends(dep_node)) -> schemas.IOU:
+    """
+    Return an IOU node.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.IOU,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_iou_node(node_data: schemas.IOUUpdate, node: IOUVM = Depends(dep_node)) -> schemas.IOU:
+    """
+    Update an IOU node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            if name == "application_id":
+                continue  # we must ignore this to avoid overwriting the application_id allocated by the IOU manager
+            setattr(node, name, value)
+
+    if node.use_default_iou_values:
+        # update the default IOU values in case the image or use_default_iou_values have changed
+        # this is important to have the correct NVRAM amount in order to correctly push the configs to the NVRAM
+        await node.update_default_iou_values()
+    node.updated()
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_iou_node(node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Delete an IOU node.
+    """
+
+    await IOU.instance().delete_node(node.id)
+
+
+@router.post(
+    "/{node_id}/duplicate",
+    response_model=schemas.IOU,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(compute_authentication)]
+)
+async def duplicate_iou_node(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: IOUVM = Depends(dep_node)
+) -> schemas.IOU:
+    """
+    Duplicate an IOU node.
+    """
+
+    new_node = await IOU.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_iou_node(start_data: schemas.IOUStart, node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Start an IOU node.
+    """
+
+    start_data = jsonable_encoder(start_data, exclude_unset=True)
+    for name, value in start_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_iou_node(node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Stop an IOU node.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+def suspend_iou_node(node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Suspend an IOU node.
+    Does nothing since IOU doesn't support being suspended.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_iou_node(node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Reload an IOU node.
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_iou_node_nio(
+    adapter_number: int,
+    port_number: int,
+    nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+    node: IOUVM = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    """
+
+    nio = IOU.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.adapter_add_nio_binding(adapter_number, port_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_iou_node_nio(
+    adapter_number: int,
+    port_number: int,
+    nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+    node: IOUVM = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    """
+
+    nio = node.get_nio(adapter_number, port_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.adapter_update_nio_binding(adapter_number, port_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_iou_node_nio(adapter_number: int, port_number: int, node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    """
+
+    await node.adapter_remove_nio_binding(adapter_number, port_number)
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_iou_node_capture(
+        adapter_number: int,
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: IOUVM = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": str(pcap_file_path)}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_iou_node_capture(adapter_number: int, port_number: int, node: IOUVM = Depends(dep_node)) -> None:
+    """
+    Stop a packet capture on the node.
+    """
+
+    await node.stop_capture(adapter_number, port_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        adapter_number: int,
+        port_number: int,
+        node: IOUVM = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    """
+
+    nio = node.get_nio(adapter_number, port_number)
+    stream = IOU.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.websocket(
+    "/{node_id}/console/ws",
+)
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: IOUVM = Depends(dep_node)
+) -> None:
+    """
+    Console WebSocket.
+    """
+
+    if websocket:
+        await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: IOUVM = Depends(dep_node)) -> None:
+
+    await node.reset_console()

gns3server/api/routes/compute/nat_nodes.py

@@ -0,0 +1,244 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for NAT nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import Union
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.builtin import Builtin
+from gns3server.compute.builtin.nodes.nat import Nat
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or NAT node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> Nat:
+    """
+    Dependency to retrieve a node.
+    """
+
+    builtin_manager = Builtin.instance()
+    node = builtin_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.NAT,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create NAT node"}},
+)
+async def create_nat_node(project_id: UUID, node_data: schemas.NATCreate) -> schemas.NAT:
+    """
+    Create a new NAT node.
+    """
+
+    builtin_manager = Builtin.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await builtin_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_type="nat",
+        ports=node_data.get("ports_mapping"),
+    )
+
+    node.usage = node_data.get("usage", "")
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.NAT)
+def get_nat_node(node: Nat = Depends(dep_node)) -> schemas.NAT:
+    """
+    Return a NAT node.
+    """
+
+    return node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.NAT)
+async def update_nat_node(node_data: schemas.NATUpdate, node: Nat = Depends(dep_node)) -> schemas.NAT:
+    """
+    Update a NAT node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_nat_node(node: Nat = Depends(dep_node)) -> None:
+    """
+    Delete a cloud node.
+    """
+
+    await Builtin.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+async def start_nat_node(node: Nat = Depends(dep_node)) -> None:
+    """
+    Start a NAT node.
+    """
+
+    await node.start()
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+async def stop_nat_node(node: Nat = Depends(dep_node)) -> None:
+    """
+    Stop a NAT node.
+    This endpoint results in no action since cloud nodes cannot be stopped.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+async def suspend_nat_node(node: Nat = Depends(dep_node)) -> None:
+    """
+    Suspend a NAT node.
+    This endpoint results in no action since NAT nodes cannot be suspended.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+)
+async def create_nat_node_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+        node: Nat = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = Builtin.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+)
+async def update_nat_node_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+        node: Nat = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Update a NIO (Network Input/Output) to the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.update_nio(port_number, nio)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_nat_node_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Nat = Depends(dep_node)
+) -> None:
+    """
+    Remove a NIO (Network Input/Output) from the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    await node.remove_nio(port_number)
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_nat_node_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: Nat = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
+)
+async def stop_nat_node_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Nat = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Nat = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Builtin.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/notifications.py

@@ -0,0 +1,88 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for compute notifications.
+"""
+
+
+from fastapi import APIRouter, Depends, WebSocket, WebSocketDisconnect
+from typing import Union
+from websockets.exceptions import ConnectionClosed, WebSocketException
+
+from gns3server.compute.notification_manager import NotificationManager
+from .dependencies.authentication import ws_compute_authentication
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.websocket("/notifications/ws")
+async def project_ws_notifications(websocket: Union[None, WebSocket] = Depends(ws_compute_authentication)) -> None:
+    """
+    Receive project notifications about the project from WebSocket.
+    """
+
+    if websocket:
+        log.info(f"New client {websocket.client.host}:{websocket.client.port} has connected to compute WebSocket")
+        try:
+            with NotificationManager.instance().queue() as queue:
+                while True:
+                    notification = await queue.get_json(5)
+                    await websocket.send_text(notification)
+        except (ConnectionClosed, WebSocketDisconnect):
+            log.info(f"Client {websocket.client.host}:{websocket.client.port} has disconnected from compute WebSocket")
+        except WebSocketException as e:
+            log.warning(f"Error while sending to controller event to WebSocket client: {e}")
+
+
+if __name__ == "__main__":
+
+    import uvicorn
+    from fastapi import FastAPI
+    from starlette.responses import HTMLResponse
+
+    app = FastAPI()
+    app.include_router(router)
+
+    html = """
+    <!DOCTYPE html>
+    <html>
+        <body>
+            <ul id='messages'>
+            </ul>
+            <script>
+                var ws = new WebSocket("ws://localhost:8000/notifications/ws");        
+                ws.onmessage = function(event) {
+                    var messages = document.getElementById('messages')
+                    var message = document.createElement('li')
+                    var content = document.createTextNode(event.data)
+                    message.appendChild(content)
+                    messages.appendChild(message)
+                };
+            </script>
+        </body>
+    </html>
+    """
+
+    @app.get("/")
+    async def get() -> HTMLResponse:
+        return HTMLResponse(html)
+
+    uvicorn.run(app, host="localhost", port=8000)

gns3server/api/routes/compute/projects.py

@@ -0,0 +1,243 @@
+#
+# Copyright (C) 2015 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for projects.
+"""
+
+import os
+import urllib.parse
+
+import logging
+
+log = logging.getLogger()
+
+from fastapi import APIRouter, Depends, HTTPException, Request, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import FileResponse
+from typing import List
+from uuid import UUID
+
+from gns3server.compute.project_manager import ProjectManager
+from gns3server.compute.project import Project
+from gns3server.utils.path import is_safe_path
+from gns3server import schemas
+
+
+router = APIRouter()
+
+# How many clients have subscribed to notifications
+_notifications_listening = {}
+
+
+def dep_project(project_id: UUID) -> Project:
+    """
+    Dependency to retrieve a project.
+    """
+
+    pm = ProjectManager.instance()
+    project = pm.get_project(str(project_id))
+    return project
+
+
+@router.get("/projects", response_model=List[schemas.Project])
+def get_compute_projects() -> List[schemas.Project]:
+    """
+    Get all projects opened on the compute.
+    """
+
+    pm = ProjectManager.instance()
+    return [p.asdict() for p in pm.projects]
+
+
+@router.post("/projects", status_code=status.HTTP_201_CREATED, response_model=schemas.Project)
+def create_compute_project(project_data: schemas.ProjectCreate) -> schemas.Project:
+    """
+    Create a new project on the compute.
+    """
+
+    pm = ProjectManager.instance()
+    project_data = jsonable_encoder(project_data, exclude_unset=True)
+    project = pm.create_project(
+        name=project_data.get("name"),
+        path=project_data.get("path"),
+        project_id=project_data.get("project_id"),
+        variables=project_data.get("variables", None),
+    )
+    return project.asdict()
+
+
+@router.put("/projects/{project_id}", response_model=schemas.Project)
+async def update_compute_project(
+        project_data: schemas.ProjectUpdate,
+        project: Project = Depends(dep_project)
+) -> schemas.Project:
+    """
+    Update project on the compute.
+    """
+
+    await project.update(variables=project_data.variables)
+    return project.asdict()
+
+
+@router.get("/projects/{project_id}", response_model=schemas.Project)
+def get_compute_project(project: Project = Depends(dep_project)) -> schemas.Project:
+    """
+    Return a project from the compute.
+    """
+
+    return project.asdict()
+
+
+@router.post("/projects/{project_id}/close", status_code=status.HTTP_204_NO_CONTENT)
+async def close_compute_project(project: Project = Depends(dep_project)) -> None:
+    """
+    Close a project on the compute.
+    """
+
+    # FIXME
+    if _notifications_listening.setdefault(project.id, 0) <= 1:
+        await project.close()
+        ProjectManager.instance().remove_project(project.id)
+        try:
+            del _notifications_listening[project.id]
+        except KeyError:
+            pass
+    else:
+        log.warning("Skip project closing, another client is listening for project notifications")
+
+
+@router.delete("/projects/{project_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_compute_project(project: Project = Depends(dep_project)) -> None:
+    """
+    Delete project from the compute.
+    """
+
+    await project.delete()
+    ProjectManager.instance().remove_project(project.id)
+
+# @Route.get(
+#     r"/projects/{project_id}/notifications",
+#     description="Receive notifications about the project",
+#     parameters={
+#         "project_id": "Project UUID",
+#     },
+#     status_codes={
+#         200: "End of stream",
+#         404: "The project doesn't exist"
+#     })
+# async def notification(request, response):
+#
+#     pm = ProjectManager.instance()
+#     project = pm.get_project(request.match_info["project_id"])
+#
+#     response.content_type = "application/json"
+#     response.set_status(200)
+#     response.enable_chunked_encoding()
+#
+#     response.start(request)
+#     queue = project.get_listen_queue()
+#     ProjectHandler._notifications_listening.setdefault(project.id, 0)
+#     ProjectHandler._notifications_listening[project.id] += 1
+#     await response.write("{}\n".format(json.dumps(ProjectHandler._getPingMessage())).encode("utf-8"))
+#     while True:
+#         try:
+#             (action, msg) = await asyncio.wait_for(queue.get(), 5)
+#             if hasattr(msg, "asdict"):
+#                 msg = json.dumps({"action": action, "event": msg.asdict()}, sort_keys=True)
+#             else:
+#                 msg = json.dumps({"action": action, "event": msg}, sort_keys=True)
+#             log.debug("Send notification: %s", msg)
+#             await response.write(("{}\n".format(msg)).encode("utf-8"))
+#         except asyncio.TimeoutError:
+#             await response.write("{}\n".format(json.dumps(ProjectHandler._getPingMessage())).encode("utf-8"))
+#     project.stop_listen_queue(queue)
+#     if project.id in ProjectHandler._notifications_listening:
+#         ProjectHandler._notifications_listening[project.id] -= 1
+
+# def _getPingMessage(cls):
+#     """
+#     Ping messages are regularly sent to the client to
+#     keep the connection open. We send with it some information about server load.
+#
+#     :returns: hash
+#     """
+#     stats = {}
+#     # Non blocking call in order to get cpu usage. First call will return 0
+#     stats["cpu_usage_percent"] = CpuPercent.get(interval=None)
+#     stats["memory_usage_percent"] = psutil.virtual_memory().percent
+#     stats["disk_usage_percent"] = psutil.disk_usage(get_default_project_directory()).percent
+#     return {"action": "ping", "event": stats}
+
+
+@router.get("/projects/{project_id}/files", response_model=List[schemas.ProjectFile])
+async def get_compute_project_files(project: Project = Depends(dep_project)) -> List[schemas.ProjectFile]:
+    """
+    Return files belonging to a project.
+    """
+
+    return await project.list_files()
+
+
+@router.get("/projects/{project_id}/files/{file_path:path}")
+async def get_compute_project_file(file_path: str, project: Project = Depends(dep_project)) -> FileResponse:
+    """
+    Get a file from a project.
+    """
+
+    file_path = urllib.parse.unquote(file_path)
+    path = os.path.normpath(file_path)
+
+    # Raise error if user try to escape
+    if not is_safe_path(path, project.path):
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    path = os.path.join(project.path, path)
+    if not os.path.exists(path):
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    return FileResponse(path, media_type="application/octet-stream")
+
+
+@router.post("/projects/{project_id}/files/{file_path:path}", status_code=status.HTTP_204_NO_CONTENT)
+async def write_compute_project_file(
+        file_path: str,
+        request: Request,
+        project: Project = Depends(dep_project)
+) -> None:
+
+    file_path = urllib.parse.unquote(file_path)
+    path = os.path.normpath(file_path)
+
+    # Raise error if user try to escape
+    if not is_safe_path(path, project.path):
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    path = os.path.join(project.path, path)
+    try:
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+
+        try:
+            with open(path, "wb+") as f:
+                async for chunk in request.stream():
+                    f.write(chunk)
+        except (UnicodeEncodeError, OSError) as e:
+            pass  # FIXME
+
+    except FileNotFoundError:
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+    except PermissionError:
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)

gns3server/api/routes/compute/qemu_nodes.py

@@ -0,0 +1,412 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for Qemu nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, Body, Path, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import Union
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.qemu import Qemu
+from gns3server.compute.qemu.qemu_vm import QemuVM
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Qemu node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> QemuVM:
+    """
+    Dependency to retrieve a node.
+    """
+
+    qemu_manager = Qemu.instance()
+    node = qemu_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.Qemu,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Qemu node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_qemu_node(project_id: UUID, node_data: schemas.QemuCreate) -> schemas.Qemu:
+    """
+    Create a new Qemu node.
+    """
+
+    qemu = Qemu.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await qemu.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.pop("node_id", None),
+        linked_clone=node_data.get("linked_clone", True),
+        qemu_path=node_data.pop("qemu_path", None),
+        console=node_data.pop("console", None),
+        console_type=node_data.pop("console_type", "telnet"),
+        aux=node_data.get("aux"),
+        aux_type=node_data.pop("aux_type", "none"),
+        platform=node_data.pop("platform", None),
+    )
+
+    for name, value in node_data.items():
+        if hasattr(vm, name) and getattr(vm, name) != value:
+            setattr(vm, name, value)
+
+    return vm.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.Qemu,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_qemu_node(node: QemuVM = Depends(dep_node)) -> schemas.Qemu:
+    """
+    Return a Qemu node.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.Qemu,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_qemu_node(node_data: schemas.QemuUpdate, node: QemuVM = Depends(dep_node)) -> schemas.Qemu:
+    """
+    Update a Qemu node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    # update the console first to avoid issue if updating console type
+    node.console = node_data.pop("console", node.console)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            await node.update_property(name, value)
+    node.updated()
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_qemu_node(node: QemuVM = Depends(dep_node)) -> None:
+    """
+    Delete a Qemu node.
+    """
+
+    await Qemu.instance().delete_node(node.id)
+
+
+@router.post(
+    "/{node_id}/duplicate",
+    response_model=schemas.Qemu,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(compute_authentication)]
+)
+async def duplicate_qemu_node(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: QemuVM = Depends(dep_node)
+) -> schemas.Qemu:
+    """
+    Duplicate a Qemu node.
+    """
+
+    new_node = await Qemu.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.post(
+    "/{node_id}/disk_image/{disk_name}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_qemu_disk_image(
+        disk_name: str,
+        disk_data: schemas.QemuDiskImageCreate,
+        node: QemuVM = Depends(dep_node)
+) -> None:
+    """
+    Create a Qemu disk image.
+    """
+
+    options = jsonable_encoder(disk_data, exclude_unset=True)
+    await node.create_disk_image(disk_name, options)
+
+
+@router.put(
+    "/{node_id}/disk_image/{disk_name}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_qemu_disk_image(
+        disk_name: str,
+        disk_data: schemas.QemuDiskImageUpdate,
+        node: QemuVM = Depends(dep_node)
+) -> None:
+    """
+    Update a Qemu disk image.
+    """
+
+    if disk_data.extend:
+        await node.resize_disk_image(disk_name, disk_data.extend)
+
+
+@router.delete(
+    "/{node_id}/disk_image/{disk_name}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_qemu_disk_image(
+        disk_name: str,
+        node: QemuVM = Depends(dep_node)
+) -> None:
+    """
+    Delete a Qemu disk image.
+    """
+
+    node.delete_disk_image(disk_name)
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_qemu_node(node: QemuVM = Depends(dep_node)) -> None:
+    """
+    Start a Qemu node.
+    """
+
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_qemu_node(node: QemuVM = Depends(dep_node)) -> None:
+    """
+    Stop a Qemu node.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_qemu_node(node: QemuVM = Depends(dep_node)) -> None:
+    """
+    Reload a Qemu node.
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def suspend_qemu_node(node: QemuVM = Depends(dep_node)) -> None:
+    """
+    Suspend a Qemu node.
+    """
+
+    await node.suspend()
+
+
+@router.post(
+    "/{node_id}/resume",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def resume_qemu_node(node: QemuVM = Depends(dep_node)) -> None:
+    """
+    Resume a Qemu node.
+    """
+
+    await node.resume()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_qemu_node_nio(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        nio_data: schemas.UDPNIO,
+        node: QemuVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The port number on the Qemu node is always 0.
+    """
+
+    nio = Qemu.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.adapter_add_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_qemu_node_nio(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        nio_data: schemas.UDPNIO,
+        node: QemuVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    The port number on the Qemu node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    if nio_data.suspend:
+        nio.suspend = nio_data.suspend
+    await node.adapter_update_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_qemu_node_nio(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: QemuVM = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The port number on the Qemu node is always 0.
+    """
+
+    await node.adapter_remove_nio_binding(adapter_number)
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_qemu_node_capture(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node_capture_data: schemas.NodeCapture,
+        node: QemuVM = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The port number on the Qemu node is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": str(pcap_file_path)}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_qemu_node_capture(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: QemuVM = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The port number on the Qemu node is always 0.
+    """
+
+    await node.stop_capture(adapter_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: QemuVM = Depends(dep_node)) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The port number on the Qemu node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    stream = Qemu.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.websocket(
+    "/{node_id}/console/ws"
+)
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: QemuVM = Depends(dep_node)
+) -> None:
+    """
+    Console WebSocket.
+    """
+
+    if websocket:
+        await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: QemuVM = Depends(dep_node)) -> None:
+
+    await node.reset_console()

gns3server/api/routes/compute/virtualbox_nodes.py

@@ -0,0 +1,377 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for VirtualBox nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, Path, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+from typing import Union
+
+from gns3server import schemas
+from gns3server.compute.virtualbox import VirtualBox
+from gns3server.compute.virtualbox.virtualbox_error import VirtualBoxError
+from gns3server.compute.virtualbox.virtualbox_vm import VirtualBoxVM
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or VirtualBox node"}}
+
+router = APIRouter(responses=responses, deprecated=True)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> VirtualBoxVM:
+    """
+    Dependency to retrieve a node.
+    """
+
+    vbox_manager = VirtualBox.instance()
+    node = vbox_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.VirtualBox,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create VirtualBox node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_virtualbox_node(project_id: UUID, node_data: schemas.VirtualBoxCreate) -> schemas.VirtualBox:
+    """
+    Create a new VirtualBox node.
+    """
+
+    vbox_manager = VirtualBox.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await vbox_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_data.pop("vmname"),
+        linked_clone=node_data.pop("linked_clone", False),
+        console=node_data.get("console", None),
+        console_type=node_data.get("console_type", "telnet"),
+        adapters=node_data.get("adapters", 0),
+    )
+
+    if "ram" in node_data:
+        ram = node_data.pop("ram")
+        if ram != vm.ram:
+            await vm.set_ram(ram)
+
+    for name, value in node_data.items():
+        if name != "node_id":
+            if hasattr(vm, name) and getattr(vm, name) != value:
+                setattr(vm, name, value)
+
+    return vm.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.VirtualBox,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> schemas.VirtualBox:
+    """
+    Return a VirtualBox node.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.VirtualBox,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_virtualbox_node(
+        node_data: schemas.VirtualBoxUpdate,
+        node: VirtualBoxVM = Depends(dep_node)
+) -> schemas.VirtualBox:
+    """
+    Update a VirtualBox node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    if "name" in node_data:
+        name = node_data.pop("name")
+        vmname = node_data.pop("vmname", None)
+        if name != node.name:
+            oldname = node.name
+            node.name = name
+            if node.linked_clone:
+                try:
+                    await node.set_vmname(node.name)
+                except VirtualBoxError as e:  # In case of error we rollback (we can't change the name when running)
+                    node.name = oldname
+                    node.updated()
+                    raise e
+
+    if "adapters" in node_data:
+        adapters = node_data.pop("adapters")
+        if adapters != node.adapters:
+            await node.set_adapters(adapters)
+
+    if "ram" in node_data:
+        ram = node_data.pop("ram")
+        if ram != node.ram:
+            await node.set_ram(ram)
+
+    # update the console first to avoid issue if updating console type
+    node.console = node_data.pop("console", node.console)
+
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+
+    node.updated()
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> None:
+    """
+    Delete a VirtualBox node.
+    """
+
+    await VirtualBox.instance().delete_node(node.id)
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> None:
+    """
+    Start a VirtualBox node.
+    """
+
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> None:
+    """
+    Stop a VirtualBox node.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def suspend_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> None:
+    """
+    Suspend a VirtualBox node.
+    """
+
+    await node.suspend()
+
+
+@router.post(
+    "/{node_id}/resume",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def resume_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> None:
+    """
+    Resume a VirtualBox node.
+    """
+
+    await node.resume()
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)) -> None:
+    """
+    Reload a VirtualBox node.
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_virtualbox_node_nio(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        nio_data: schemas.UDPNIO,
+        node: VirtualBoxVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The port number on the VirtualBox node is always 0.
+    """
+
+    nio = VirtualBox.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.adapter_add_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_virtualbox_node_nio(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        nio_data: schemas.UDPNIO,
+        node: VirtualBoxVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    The port number on the VirtualBox node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    if nio_data.suspend:
+        nio.suspend = nio_data.suspend
+    await node.adapter_update_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_virtualbox_node_nio(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: VirtualBoxVM = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The port number on the VirtualBox node is always 0.
+    """
+
+    await node.adapter_remove_nio_binding(adapter_number)
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_virtualbox_node_capture(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node_capture_data: schemas.NodeCapture,
+        node: VirtualBoxVM = Depends(dep_node),
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The port number on the VirtualBox node is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": str(pcap_file_path)}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_virtualbox_node_capture(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: VirtualBoxVM = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The port number on the VirtualBox node is always 0.
+    """
+
+    await node.stop_capture(adapter_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: VirtualBoxVM = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The port number on the VirtualBox node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    stream = VirtualBox.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.websocket(
+    "/{node_id}/console/ws"
+)
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: VirtualBoxVM = Depends(dep_node)
+) -> None:
+    """
+    Console WebSocket.
+    """
+
+    await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: VirtualBoxVM = Depends(dep_node)) -> None:
+
+    await node.reset_console()
+

gns3server/api/routes/compute/vmware_nodes.py

@@ -0,0 +1,355 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for VMware nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, Path, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+from typing import Union
+
+from gns3server import schemas
+from gns3server.compute.vmware import VMware
+from gns3server.compute.vmware.vmware_vm import VMwareVM
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or VMware node"}}
+
+router = APIRouter(responses=responses, deprecated=True)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> VMwareVM:
+    """
+    Dependency to retrieve a node.
+    """
+
+    vmware_manager = VMware.instance()
+    node = vmware_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.VMware,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create VMware node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_vmware_node(project_id: UUID, node_data: schemas.VMwareCreate) -> schemas.VMware:
+    """
+    Create a new VMware node.
+    """
+
+    vmware_manager = VMware.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await vmware_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_data.pop("vmx_path"),
+        linked_clone=node_data.pop("linked_clone"),
+        console=node_data.get("console", None),
+        console_type=node_data.get("console_type", "telnet"),
+    )
+
+    for name, value in node_data.items():
+        if name != "node_id":
+            if hasattr(vm, name) and getattr(vm, name) != value:
+                setattr(vm, name, value)
+
+    return vm.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.VMware,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_vmware_node(node: VMwareVM = Depends(dep_node)) -> schemas.VMware:
+    """
+    Return a VMware node.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.VMware,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_vmware_node(node_data: schemas.VMwareUpdate, node: VMwareVM = Depends(dep_node)) -> schemas.VMware:
+    """
+    Update a VMware node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    # update the console first to avoid issue if updating console type
+    node.console = node_data.pop("console", node.console)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+
+    node.updated()
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_vmware_node(node: VMwareVM = Depends(dep_node)) -> None:
+    """
+    Delete a VMware node.
+    """
+
+    await VMware.instance().delete_node(node.id)
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_vmware_node(node: VMwareVM = Depends(dep_node)) -> None:
+    """
+    Start a VMware node.
+    """
+
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_vmware_node(node: VMwareVM = Depends(dep_node)) -> None:
+    """
+    Stop a VMware node.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def suspend_vmware_node(node: VMwareVM = Depends(dep_node)) -> None:
+    """
+    Suspend a VMware node.
+    """
+
+    await node.suspend()
+
+
+@router.post(
+    "/{node_id}/resume",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def resume_vmware_node(node: VMwareVM = Depends(dep_node)) -> None:
+    """
+    Resume a VMware node.
+    """
+
+    await node.resume()
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_vmware_node(node: VMwareVM = Depends(dep_node)) -> None:
+    """
+    Reload a VMware node.
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_vmware_node_nio(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        nio_data: schemas.UDPNIO,
+        node: VMwareVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The port number on the VMware node is always 0.
+    """
+
+    nio = VMware.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.adapter_add_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_vmware_node_nio(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        nio_data: schemas.UDPNIO,
+        node: VMwareVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    The port number on the VMware node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.adapter_update_nio_binding(adapter_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_vmware_node_nio(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: VMwareVM = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The port number on the VMware node is always 0.
+    """
+
+    await node.adapter_remove_nio_binding(adapter_number)
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_vmware_node_capture(
+        *,
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node_capture_data: schemas.NodeCapture,
+        node: VMwareVM = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The port number on the VMware node is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_vmware_node_capture(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: VMwareVM = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The port number on the VMware node is always 0.
+    """
+
+    await node.stop_capture(adapter_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        adapter_number: int,
+        port_number: int = Path(..., ge=0, le=0),
+        node: VMwareVM = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The port number on the VMware node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    stream = VMware.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.post(
+    "/{node_id}/interfaces/vmnet",
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(compute_authentication)]
+)
+def allocate_vmnet(node: VMwareVM = Depends(dep_node)) -> dict:
+    """
+    Allocate a VMware VMnet interface on the server.
+    """
+
+    vmware_manager = VMware.instance()
+    vmware_manager.refresh_vmnet_list(ubridge=False)
+    vmnet = vmware_manager.allocate_vmnet()
+    node.vmnets.append(vmnet)
+    return {"vmnet": vmnet}
+
+
+@router.websocket("/{node_id}/console/ws")
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: VMwareVM = Depends(dep_node)
+) -> None:
+    """
+    Console WebSocket.
+    """
+
+    if websocket:
+        await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: VMwareVM = Depends(dep_node)) -> None:
+
+    await node.reset_console()

gns3server/api/routes/compute/vpcs_nodes.py

@@ -0,0 +1,343 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for VPCS nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, Body, Path, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import Union
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.vpcs import VPCS
+from gns3server.compute.vpcs.vpcs_vm import VPCSVM
+
+from .dependencies.authentication import compute_authentication, ws_compute_authentication
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or VMware node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> VPCSVM:
+    """
+    Dependency to retrieve a node.
+    """
+
+    vpcs_manager = VPCS.instance()
+    node = vpcs_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.VPCS,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create VMware node"}},
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_vpcs_node(project_id: UUID, node_data: schemas.VPCSCreate) -> schemas.VPCS:
+    """
+    Create a new VPCS node.
+    """
+
+    vpcs = VPCS.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await vpcs.create_node(
+        node_data["name"],
+        str(project_id),
+        node_data.get("node_id"),
+        console=node_data.get("console"),
+        console_type=node_data.get("console_type", "telnet"),
+        startup_script=node_data.get("startup_script"),
+    )
+
+    return vm.asdict()
+
+
+@router.get(
+    "/{node_id}",
+    response_model=schemas.VPCS,
+    dependencies=[Depends(compute_authentication)]
+)
+def get_vpcs_node(node: VPCSVM = Depends(dep_node)) -> schemas.VPCS:
+    """
+    Return a VPCS node.
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.VPCS,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_vpcs_node(node_data: schemas.VPCSUpdate, node: VPCSVM = Depends(dep_node)) -> schemas.VPCS:
+    """
+    Update a VPCS node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    name = node_data.get("name", node.name)
+    if node.name != name:
+        node.name = name
+    console = node_data.get("console", node.console)
+    if node.console != console:
+        node.console = console
+    console_type = node_data.get("console_type", node.console_type)
+    if node.console_type != console_type:
+        node.console_type = console_type
+    node.updated()
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_vpcs_node(node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Delete a VPCS node.
+    """
+
+    await VPCS.instance().delete_node(node.id)
+
+
+@router.post(
+    "/{node_id}/duplicate",
+    response_model=schemas.VPCS,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(compute_authentication)]
+)
+async def duplicate_vpcs_node(
+        destination_node_id: UUID = Body(..., embed=True),
+        node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Duplicate a VPCS node.
+    """
+
+    new_node = await VPCS.instance().duplicate_node(node.id, str(destination_node_id))
+    return new_node.asdict()
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_vpcs_node(node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Start a VPCS node.
+    """
+
+    await node.start()
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_vpcs_node(node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Stop a VPCS node.
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def suspend_vpcs_node(node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Suspend a VPCS node.
+    Does nothing, suspend is not supported by VPCS.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reload_vpcs_node(node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Reload a VPCS node.
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def create_vpcs_node_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: VPCSVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the VPCS node is always 0.
+    """
+
+    nio = VPCS.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.port_add_nio_binding(port_number, nio)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.UDPNIO,
+    dependencies=[Depends(compute_authentication)]
+)
+async def update_vpcs_node_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: schemas.UDPNIO,
+        node: VPCSVM = Depends(dep_node)
+) -> schemas.UDPNIO:
+    """
+    Update a NIO (Network Input/Output) on the node.
+    The adapter number on the VPCS node is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.port_update_nio_binding(port_number, nio)
+    return nio.asdict()
+
+
+@router.delete(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def delete_vpcs_node_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: VPCSVM = Depends(dep_node)
+) -> None:
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The adapter number on the VPCS node is always 0.
+    """
+
+    await node.port_remove_nio_binding(port_number)
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+    dependencies=[Depends(compute_authentication)]
+)
+async def start_vpcs_node_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: VPCSVM = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the VPCS node is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def stop_vpcs_node_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: VPCSVM = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the VPCS node is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+    dependencies=[Depends(compute_authentication)]
+)
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: VPCSVM = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the VPCS node is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = VPCS.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.websocket(
+    "/{node_id}/console/ws"
+)
+async def console_ws(
+        websocket: Union[None, WebSocket] = Depends(ws_compute_authentication),
+        node: VPCSVM = Depends(dep_node)) -> None:
+    """
+    Console WebSocket.
+    """
+
+    await node.start_websocket_console(websocket)
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(compute_authentication)]
+)
+async def reset_console(node: VPCSVM = Depends(dep_node)) -> None:
+
+    await node.reset_console()

gns3server/api/routes/controller/__init__.py

@@ -0,0 +1,147 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from fastapi import APIRouter, Depends
+
+from . import controller
+from . import appliances
+from . import computes
+from . import drawings
+from . import gns3vm
+from . import links
+from . import nodes
+from . import projects
+from . import snapshots
+from . import symbols
+from . import templates
+from . import images
+from . import users
+from . import groups
+from . import roles
+from . import acl
+from . import pools
+from . import privileges
+
+from .dependencies.authentication import get_current_active_user
+
+router = APIRouter()
+
+router.include_router(
+    controller.router,
+    tags=["Controller"]
+)
+
+router.include_router(
+    users.router,
+    prefix="/access/users",
+    tags=["Users"]
+)
+
+router.include_router(
+    groups.router,
+    prefix="/access/groups",
+    tags=["Users groups"]
+)
+
+router.include_router(
+    roles.router,
+    prefix="/access/roles",
+    tags=["Roles"]
+)
+
+router.include_router(
+    privileges.router,
+    dependencies=[Depends(get_current_active_user)],
+    prefix="/access/privileges",
+    tags=["Privileges"]
+)
+
+router.include_router(
+    acl.router,
+    prefix="/access/acl",
+    tags=["ACL"]
+)
+
+router.include_router(
+    images.router,
+    prefix="/images",
+    tags=["Images"]
+)
+
+router.include_router(
+    templates.router,
+    prefix="/templates",
+    tags=["Templates"]
+)
+
+router.include_router(
+    projects.router,
+    prefix="/projects",
+    tags=["Projects"])
+
+router.include_router(
+    nodes.router,
+    prefix="/projects/{project_id}/nodes",
+    tags=["Nodes"]
+)
+
+router.include_router(
+    links.router,
+    prefix="/projects/{project_id}/links",
+    tags=["Links"]
+)
+
+router.include_router(
+    drawings.router,
+    prefix="/projects/{project_id}/drawings",
+    tags=["Drawings"])
+
+router.include_router(
+    symbols.router,
+    prefix="/symbols", tags=["Symbols"]
+)
+
+router.include_router(
+    snapshots.router,
+    prefix="/projects/{project_id}/snapshots",
+    tags=["Snapshots"])
+
+router.include_router(
+    computes.router,
+    dependencies=[Depends(get_current_active_user)],
+    prefix="/computes",
+    tags=["Computes"]
+)
+
+router.include_router(
+    appliances.router,
+    prefix="/appliances",
+    tags=["Appliances"]
+)
+
+router.include_router(
+    pools.router,
+    prefix="/pools",
+    tags=["Resource pools"]
+)
+
+router.include_router(
+    gns3vm.router,
+    dependencies=[Depends(get_current_active_user)],
+    deprecated=True,
+    prefix="/gns3vm",
+    tags=["GNS3 VM"]
+)

gns3server/api/routes/controller/acl.py

@@ -0,0 +1,268 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2023 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for ACL.
+"""
+
+import re
+
+from fastapi import APIRouter, Depends, Request, status
+from fastapi.routing import APIRoute
+from uuid import UUID
+from typing import List
+
+
+from gns3server import schemas
+from gns3server.controller.controller_error import (
+    ControllerBadRequestError,
+    ControllerNotFoundError
+)
+
+from gns3server.controller import Controller
+from gns3server.db.repositories.users import UsersRepository
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.db.repositories.images import ImagesRepository
+from gns3server.db.repositories.templates import TemplatesRepository
+from gns3server.db.repositories.pools import ResourcePoolsRepository
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get(
+    "/endpoints",
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("ACE.Audit"))]
+)
+async def endpoints(
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+        templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> List[dict]:
+    """
+    List all endpoints to be used in ACL entries.
+    """
+
+    controller = Controller.instance()
+    endpoints = [{"endpoint": "/", "name": "All endpoints", "endpoint_type": "root"}]
+
+    def add_to_endpoints(endpoint: str, name: str, endpoint_type: str) -> None:
+        if endpoint not in endpoints:
+            endpoints.append({"endpoint": endpoint, "name": name, "endpoint_type": endpoint_type})
+
+    # projects
+    add_to_endpoints("/projects", "All projects", "project")
+    projects = [p for p in controller.projects.values()]
+    for project in projects:
+        add_to_endpoints(f"/projects/{project.id}", f'Project "{project.name}"', "project")
+
+        if project.status == "closed":
+            nodes = project.nodes.values()
+            links = project.links.values()
+        else:
+            nodes = [v.asdict() for v in project.nodes.values()]
+            links = [v.asdict() for v in project.links.values()]
+
+        # nodes
+        add_to_endpoints(f"/projects/{project.id}/nodes", f'All nodes in project "{project.name}"', "node")
+        for node in nodes:
+            add_to_endpoints(
+                f"/projects/{project.id}/nodes/{node['node_id']}",
+                f'Node "{node["name"]}" in project "{project.name}"',
+                endpoint_type="node"
+            )
+
+        # links
+        add_to_endpoints(f"/projects/{project.id}/links", f'All links in project "{project.name}"', "link")
+        for link in links:
+            node_id_1 = link["nodes"][0]["node_id"]
+            node_id_2 = link["nodes"][1]["node_id"]
+            node_name_1 = node_name_2 = "N/A"
+            for node in nodes:
+                if node["node_id"] == node_id_1:
+                    node_name_1 = node["name"]
+                if node["node_id"] == node_id_2:
+                    node_name_2 = node["name"]
+            add_to_endpoints(
+                f"/projects/{project.id}/links/{link['link_id']}",
+                f'Link from "{node_name_1}" to "{node_name_2}" in project "{project.name}"',
+                endpoint_type="link"
+            )
+
+    # users
+    add_to_endpoints("/access/users", "All users", "user")
+    users = await users_repo.get_users()
+    for user in users:
+        add_to_endpoints(f"/users/{user.user_id}", f'User "{user.username}"', "user")
+
+    # groups
+    add_to_endpoints("/access/groups", "All groups", "group")
+    groups = await users_repo.get_user_groups()
+    for group in groups:
+        add_to_endpoints(f"/groups/{group.user_group_id}", f'Group "{group.name}"', "group")
+
+    # roles
+    add_to_endpoints("/access/roles", "All roles", "role")
+    roles = await rbac_repo.get_roles()
+    for role in roles:
+        add_to_endpoints(f"/roles/{role.role_id}", f'Role "{role.name}"', "role")
+
+    # images
+    add_to_endpoints("/images", "All images", "image")
+    images = await images_repo.get_images()
+    for image in images:
+        add_to_endpoints(f"/images/{image.filename}", f'Image "{image.filename}"', "image")
+
+    # templates
+    add_to_endpoints("/templates", "All templates", "template")
+    templates = await templates_repo.get_templates()
+    for template in templates:
+        add_to_endpoints(f"/templates/{template.template_id}", f'Template "{template.name}"', "template")
+
+    # resource pools
+    add_to_endpoints("/pools", "All resource pools", "pool")
+    pools = await pools_repo.get_resource_pools()
+    for pool in pools:
+        add_to_endpoints(f"/pools/{pool.resource_pool_id}", f'Resource pool "{pool.name}"', "pool")
+    return endpoints
+
+
+@router.get(
+    "",
+    response_model=List[schemas.ACE],
+    dependencies=[Depends(has_privilege("ACE.Audit"))]
+)
+async def get_aces(
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> List[schemas.ACE]:
+    """
+    Get all ACL entries.
+
+    Required privilege: ACE.Audit
+    """
+
+    return await rbac_repo.get_aces()
+
+
+@router.post(
+    "",
+    response_model=schemas.ACE,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("ACE.Allocate"))]
+)
+async def create_ace(
+        request: Request,
+        ace_create: schemas.ACECreate,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> schemas.ACE:
+    """
+    Create a new ACL entry.
+
+    Required privilege: ACE.Allocate
+    """
+
+    for route in request.app.routes:
+        if isinstance(route, APIRoute):
+
+            # remove the prefix (e.g. "/v3") from the route path
+            route_path = re.sub(r"^/v[0-9]", "", route.path)
+            # replace route path ID parameters by a UUID regex
+            route_path = re.sub(r"{\w+_id}", "[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}", route_path)
+            # replace remaining route path parameters by a word matching regex
+            route_path = re.sub(r"/{[\w:]+}", r"/\\w+", route_path)
+
+            if re.fullmatch(route_path, ace_create.path):
+                log.info(f"Creating ACE for route path {route_path}")
+                return await rbac_repo.create_ace(ace_create)
+
+    raise ControllerBadRequestError(f"Path '{ace_create.path}' doesn't match any existing endpoint")
+
+
+@router.get(
+    "/{ace_id}",
+    response_model=schemas.ACE,
+    dependencies=[Depends(has_privilege("ACE.Audit"))]
+)
+async def get_ace(
+        ace_id: UUID,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> schemas.ACE:
+    """
+    Get an ACL entry.
+
+    Required privilege: ACE.Audit
+    """
+
+    ace = await rbac_repo.get_ace(ace_id)
+    if not ace:
+        raise ControllerNotFoundError(f"ACL entry '{ace_id}' not found")
+    return ace
+
+
+@router.put(
+    "/{ace_id}",
+    response_model=schemas.ACE,
+    dependencies=[Depends(has_privilege("ACE.Modify"))]
+)
+async def update_ace(
+        ace_id: UUID,
+        ace_update: schemas.ACEUpdate,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> schemas.ACE:
+    """
+    Update an ACL entry.
+
+    Required privilege: ACE.Modify
+    """
+
+    ace = await rbac_repo.get_ace(ace_id)
+    if not ace:
+        raise ControllerNotFoundError(f"ACL entry '{ace_id}' not found")
+
+    return await rbac_repo.update_ace(ace_id, ace_update)
+
+
+@router.delete(
+    "/{ace_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("ACE.Allocate"))]
+)
+async def delete_ace(
+    ace_id: UUID,
+    rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> None:
+    """
+    Delete an ACL entry.
+
+    Required privilege: ACE.Allocate
+    """
+
+    ace = await rbac_repo.get_ace(ace_id)
+    if not ace:
+        raise ControllerNotFoundError(f"ACL entry '{ace_id}' not found")
+
+    success = await rbac_repo.delete_ace(ace_id)
+    if not success:
+        raise ControllerNotFoundError(f"ACL entry '{ace_id}' could not be deleted")

gns3server/api/routes/controller/appliances.py

@@ -0,0 +1,150 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for appliances.
+"""
+
+import logging
+
+from fastapi import APIRouter, Depends, status
+from typing import Optional, List
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.controller import Controller
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerBadRequestError,
+    ControllerNotFoundError
+)
+
+from gns3server.db.repositories.images import ImagesRepository
+from gns3server.db.repositories.templates import TemplatesRepository
+from gns3server.db.repositories.rbac import RbacRepository
+
+from .dependencies.authentication import get_current_active_user
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Appliance],
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Appliance.Audit"))]
+)
+async def get_appliances(
+        update: Optional[bool] = False,
+        symbol_theme: Optional[str] = None
+) -> List[schemas.Appliance]:
+    """
+    Return all appliances known by the controller.
+
+    Required privilege: Appliance.Audit
+    """
+
+    controller = Controller.instance()
+    if update:
+        await controller.appliance_manager.download_appliances()
+    controller.appliance_manager.load_appliances(symbol_theme)
+    return [c.asdict() for c in controller.appliance_manager.appliances.values()]
+
+
+@router.get(
+    "/{appliance_id}",
+    response_model=schemas.Appliance,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Appliance.Audit"))]
+)
+def get_appliance(appliance_id: UUID) -> schemas.Appliance:
+    """
+    Get an appliance file.
+
+    Required privilege: Appliance.Audit
+    """
+
+    controller = Controller.instance()
+    appliance = controller.appliance_manager.appliances.get(str(appliance_id))
+    if not appliance:
+        raise ControllerNotFoundError(message=f"Could not find appliance '{appliance_id}'")
+    return appliance.asdict()
+
+
+@router.post(
+    "/{appliance_id}/version",
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Appliance.Allocate"))]
+)
+def add_appliance_version(appliance_id: UUID, appliance_version: schemas.ApplianceVersion) -> dict:
+    """
+    Add a version to an appliance.
+
+    Required privilege: Appliance.Allocate
+    """
+
+    controller = Controller.instance()
+    appliance = controller.appliance_manager.appliances.get(str(appliance_id))
+    if not appliance:
+        raise ControllerNotFoundError(message=f"Could not find appliance '{appliance_id}'")
+
+    if not appliance.versions:
+        raise ControllerBadRequestError(message=f"Appliance '{appliance_id}' do not have versions")
+
+    if not appliance_version.images:
+        raise ControllerBadRequestError(message=f"Version '{appliance_version.name}' must contain images")
+
+    for version in appliance.versions:
+        if version.get("name") == appliance_version.name:
+            raise ControllerError(message=f"Appliance '{appliance_id}' already has version '{appliance_version.name}'")
+
+    appliance.versions.append(appliance_version.model_dump(exclude_unset=True))
+    return appliance.asdict()
+
+
+@router.post(
+    "/{appliance_id}/install",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Appliance.Allocate"))]
+)
+async def install_appliance(
+        appliance_id: UUID,
+        version: Optional[str] = None,
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+        templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+        current_user: schemas.User = Depends(get_current_active_user),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Install an appliance.
+
+    Required privilege: Appliance.Allocate
+    """
+
+    controller = Controller.instance()
+    await controller.appliance_manager.install_appliance(
+        appliance_id,
+        version,
+        images_repo,
+        templates_repo,
+        rbac_repo,
+        current_user
+    )

gns3server/api/routes/controller/computes.py

@@ -0,0 +1,231 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for computes.
+"""
+
+from fastapi import APIRouter, Depends, status
+from typing import Any, List, Union, Optional
+from uuid import UUID
+
+from gns3server.controller import Controller
+from gns3server.db.repositories.computes import ComputesRepository
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.services.computes import ComputesService
+from gns3server import schemas
+
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Compute not found"}}
+
+router = APIRouter(responses=responses)
+
+
+@router.post(
+    "",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Compute,
+    responses={
+        404: {"model": schemas.ErrorMessage, "description": "Could not connect to compute"},
+        409: {"model": schemas.ErrorMessage, "description": "Could not create compute"},
+        401: {"model": schemas.ErrorMessage, "description": "Invalid authentication for compute"},
+    },
+    dependencies=[Depends(has_privilege("Compute.Allocate"))]
+)
+async def create_compute(
+    compute_create: schemas.ComputeCreate,
+    computes_repo: ComputesRepository = Depends(get_repository(ComputesRepository)),
+    connect: Optional[bool] = False
+) -> schemas.Compute:
+    """
+    Create a new compute on the controller.
+
+    Required privilege: Compute.Allocate
+    """
+
+    return await ComputesService(computes_repo).create_compute(compute_create, connect)
+
+
+@router.post(
+    "/{compute_id}/connect",
+    status_code=status.HTTP_204_NO_CONTENT,
+    #dependencies=[Depends(has_privilege("Compute.Audit"))]  # FIXME: this is a temporary workaround due to a bug in the web-ui
+)
+async def connect_compute(compute_id: Union[str, UUID]) -> None:
+    """
+    Connect to compute on the controller.
+
+    Required privilege: Compute.Audit
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    if not compute.connected:
+        await compute.connect(report_failed_connection=True)
+
+
+@router.get(
+    "/{compute_id}",
+    response_model=schemas.Compute,
+    response_model_exclude_unset=True,
+    #dependencies=[Depends(has_privilege("Compute.Audit"))]  # FIXME: this is a temporary workaround due to a bug in the web-ui
+)
+async def get_compute(
+    compute_id: Union[str, UUID], computes_repo: ComputesRepository = Depends(get_repository(ComputesRepository))
+) -> schemas.Compute:
+    """
+    Return a compute from the controller.
+
+    Required privilege: Compute.Audit
+    """
+
+    return await ComputesService(computes_repo).get_compute(compute_id)
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Compute],
+    response_model_exclude_unset=True,
+    #dependencies=[Depends(has_privilege("Compute.Audit"))]  # FIXME: this is a temporary workaround due to a bug in the web-ui
+)
+async def get_computes(
+    computes_repo: ComputesRepository = Depends(get_repository(ComputesRepository)),
+) -> List[schemas.Compute]:
+    """
+    Return all computes known by the controller.
+
+    Required privilege: Compute.Audit
+    """
+
+    return await ComputesService(computes_repo).get_computes()
+
+
+@router.put(
+    "/{compute_id}",
+    response_model=schemas.Compute,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Compute.Modify"))]
+)
+async def update_compute(
+    compute_id: Union[str, UUID],
+    compute_update: schemas.ComputeUpdate,
+    computes_repo: ComputesRepository = Depends(get_repository(ComputesRepository)),
+) -> schemas.Compute:
+    """
+    Update a compute on the controller.
+
+    Required privilege: Compute.Modify
+    """
+
+    return await ComputesService(computes_repo).update_compute(compute_id, compute_update)
+
+
+@router.delete(
+    "/{compute_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Compute.Allocate"))]
+)
+async def delete_compute(
+        compute_id: Union[str, UUID],
+        computes_repo: ComputesRepository = Depends(get_repository(ComputesRepository)),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> None:
+    """
+    Delete a compute from the controller.
+
+    Required privilege: Compute.Allocate
+    """
+
+    await ComputesService(computes_repo).delete_compute(compute_id)
+    await rbac_repo.delete_all_ace_starting_with_path(f"/computes/{compute_id}")
+
+
+@router.get("/{compute_id}/docker/images", response_model=List[schemas.ComputeDockerImage])
+async def docker_get_images(compute_id: Union[str, UUID]) -> List[schemas.ComputeDockerImage]:
+    """
+    Get Docker images from a compute.
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    result = await compute.forward("GET", "docker", "images")
+    return result
+
+
+@router.get("/{compute_id}/virtualbox/vms", response_model=List[schemas.ComputeVirtualBoxVM])
+async def virtualbox_vms(compute_id: Union[str, UUID]) -> List[schemas.ComputeVirtualBoxVM]:
+    """
+    Get VirtualBox VMs from a compute.
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    result = await compute.forward("GET", "virtualbox", "vms")
+    return result
+
+
+@router.get("/{compute_id}/vmware/vms", response_model=List[schemas.ComputeVMwareVM])
+async def vmware_vms(compute_id: Union[str, UUID]) -> List[schemas.ComputeVMwareVM]:
+    """
+    Get VMware VMs from a compute.
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    result = await compute.forward("GET", "vmware", "vms")
+    return result
+
+
+@router.post("/{compute_id}/dynamips/auto_idlepc")
+async def dynamips_autoidlepc(compute_id: Union[str, UUID], auto_idle_pc: schemas.AutoIdlePC) -> str:
+    """
+    Find a suitable Idle-PC value for a given IOS image. This may take a few minutes.
+    """
+
+    controller = Controller.instance()
+    return await controller.autoidlepc(str(compute_id), auto_idle_pc.platform, auto_idle_pc.image, auto_idle_pc.ram)
+
+
+@router.get("/{compute_id}/{emulator}/{endpoint_path:path}", deprecated=True)
+async def forward_get(compute_id: Union[str, UUID], emulator: str, endpoint_path: str) -> Any:
+    """
+    Forward a GET request to a compute.
+    Read the full compute API documentation for available routes.
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    result = await compute.forward("GET", emulator, endpoint_path)
+    return result
+
+
+@router.post("/{compute_id}/{emulator}/{endpoint_path:path}", deprecated=True)
+async def forward_post(compute_id: Union[str, UUID], emulator: str, endpoint_path: str, compute_data: dict) -> Any:
+    """
+    Forward a POST request to a compute.
+    Read the full compute API documentation for available routes.
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    return await compute.forward("POST", emulator, endpoint_path, data=compute_data)
+
+
+@router.put("/{compute_id}/{emulator}/{endpoint_path:path}", deprecated=True)
+async def forward_put(compute_id: Union[str, UUID], emulator: str, endpoint_path: str, compute_data: dict) -> Any:
+    """
+    Forward a PUT request to a compute.
+    Read the full compute API documentation for available routes.
+    """
+
+    compute = Controller.instance().get_compute(str(compute_id))
+    return await compute.forward("PUT", emulator, endpoint_path, data=compute_data)

gns3server/api/routes/controller/controller.py

@@ -0,0 +1,319 @@
+#
+# Copyright (C) 2015 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import asyncio
+import signal
+import os
+
+from fastapi import APIRouter, Request, Depends, WebSocket, WebSocketDisconnect, status
+from fastapi.responses import StreamingResponse
+from fastapi.encoders import jsonable_encoder
+from fastapi.routing import Mount
+from websockets.exceptions import ConnectionClosed, WebSocketException
+
+from typing import List
+
+from gns3server.config import Config
+from gns3server.controller import Controller
+from gns3server.version import __version__
+from gns3server.controller.controller_error import ControllerError, ControllerForbiddenError
+from gns3server import schemas
+
+from .dependencies.authentication import get_current_active_user, get_current_active_user_from_websocket
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get(
+    "/version",
+    response_model=schemas.Version,
+)
+def get_version(request: Request) -> dict:
+    """
+    Return the server version number.
+    """
+
+    # retrieve the controller host information from the mounted
+    # compute subapp
+    controller_host = None
+    for route in request.app.routes:
+        if isinstance(route, Mount) and route.name == "compute":
+            controller_host = route.app.state.controller_host
+
+    local_server = Config.instance().settings.Server.local
+    return {
+        "controller_host": controller_host,
+        "version": __version__,
+        "local": local_server
+    }
+
+
+@router.post(
+    "/version",
+    response_model=schemas.Version,
+    response_model_exclude_defaults=True,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Invalid version"}},
+)
+def check_version(version: schemas.Version) -> dict:
+    """
+    Check if version is the same as the server.
+    """
+
+    if version.version != __version__:
+        raise ControllerError(f"Client version {version.version} is not the same as server version {__version__}")
+    return {"version": __version__}
+
+
+@router.post(
+    "/reload",
+    dependencies=[Depends(get_current_active_user)],
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+async def reload() -> None:
+    """
+    Reload the controller
+    """
+
+    await Controller.instance().reload()
+
+
+@router.post(
+    "/shutdown",
+    dependencies=[Depends(get_current_active_user)],
+    status_code=status.HTTP_204_NO_CONTENT,
+    responses={403: {"model": schemas.ErrorMessage, "description": "Server shutdown not allowed"}},
+)
+async def shutdown() -> None:
+    """
+    Shutdown the server
+    """
+
+    if Config.instance().settings.Server.local is False:
+        raise ControllerForbiddenError("You can only stop a local server")
+
+    log.info("Start shutting down the server")
+    # close all the projects first
+    controller = Controller.instance()
+    projects = controller.projects.values()
+
+    tasks = []
+    for project in projects:
+        tasks.append(asyncio.ensure_future(project.close()))
+
+    if tasks:
+        done, _ = await asyncio.wait(tasks)
+        for future in done:
+            try:
+                future.result()
+            except Exception as e:
+                log.error(f"Could not close project: {e}", exc_info=1)
+                continue
+
+    # then shutdown the server itself
+    os.kill(os.getpid(), signal.SIGTERM)
+
+
+@router.get(
+    "/iou_license",
+    dependencies=[Depends(get_current_active_user)],
+    response_model=schemas.IOULicense
+)
+def get_iou_license() -> schemas.IOULicense:
+    """
+    Return the IOU license settings
+    """
+
+    return Controller.instance().iou_license
+
+
+@router.put(
+    "/iou_license",
+    dependencies=[Depends(get_current_active_user)],
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.IOULicense
+)
+async def update_iou_license(iou_license: schemas.IOULicense) -> schemas.IOULicense:
+    """
+    Update the IOU license settings.
+    """
+
+    controller = Controller().instance()
+    current_iou_license = controller.iou_license
+    current_iou_license.update(jsonable_encoder(iou_license))
+    controller.save()
+    return current_iou_license
+
+
+@router.get("/statistics", dependencies=[Depends(get_current_active_user)])
+async def statistics() -> List[dict]:
+    """
+    Return server statistics.
+    """
+
+    compute_statistics = []
+    for compute in list(Controller.instance().computes.values()):
+        try:
+            r = await compute.get("/statistics")
+            compute_statistics.append({"compute_id": compute.id, "compute_name": compute.name, "statistics": r.json})
+        except ControllerError as e:
+            log.error(f"Could not retrieve statistics on compute {compute.name}: {e}")
+    return compute_statistics
+
+
+@router.get("/notifications", dependencies=[Depends(get_current_active_user)])
+async def controller_http_notifications(request: Request) -> StreamingResponse:
+    """
+    Receive controller notifications about the controller from HTTP stream.
+    """
+
+    from gns3server.api.server import app
+    log.info(f"New client {request.client.host}:{request.client.port} has connected to controller HTTP "
+             f"notification stream")
+
+    async def event_stream():
+        try:
+            with Controller.instance().notification.controller_queue() as queue:
+                while not app.state.exiting:
+                    msg = await queue.get_json(5)
+                    yield f"{msg}\n".encode("utf-8")
+        finally:
+            log.info(f"Client {request.client.host}:{request.client.port} has disconnected from controller HTTP "
+                     f"notification stream")
+    return StreamingResponse(event_stream(), media_type="application/json")
+
+
+@router.websocket("/notifications/ws")
+async def controller_ws_notifications(
+        websocket: WebSocket,
+        current_user: schemas.User = Depends(get_current_active_user_from_websocket)
+) -> None:
+    """
+    Receive project notifications about the controller from WebSocket.
+    """
+
+    if current_user is None:
+        return
+
+    log.info(f"New client {websocket.client.host}:{websocket.client.port} has connected to controller WebSocket")
+    try:
+        with Controller.instance().notification.controller_queue() as queue:
+            while True:
+                notification = await queue.get_json(5)
+                await websocket.send_text(notification)
+    except (ConnectionClosed, WebSocketDisconnect):
+        log.info(f"Client {websocket.client.host}:{websocket.client.port} has disconnected from controller WebSocket")
+    except WebSocketException as e:
+        log.warning(f"Error while sending to controller event to WebSocket client: {e}")
+
+
+# @Route.post(
+#     r"/debug",
+#     description="Dump debug information to disk (debug directory in config directory). Work only for local server",
+#     status_codes={
+#         201: "Written"
+#     })
+# async def debug(request, response):
+#
+#     config = Config.instance()
+#     if config.get_section_config("Server").getboolean("local", False) is False:
+#         raise ControllerForbiddenError("You can only debug a local server")
+#
+#     debug_dir = os.path.join(config.config_dir, "debug")
+#     try:
+#         if os.path.exists(debug_dir):
+#             shutil.rmtree(debug_dir)
+#         os.makedirs(debug_dir)
+#         with open(os.path.join(debug_dir, "controller.txt"), "w+") as f:
+#             f.write(ServerHandler._getDebugData())
+#     except Exception as e:
+#         # If something is wrong we log the info to the log and we hope the log will be include correctly to the debug export
+#         log.error("Could not export debug information {}".format(e), exc_info=1)
+#
+#     try:
+#         if Controller.instance().gns3vm.engine == "vmware":
+#             vmx_path = Controller.instance().gns3vm.current_engine().vmx_path
+#             if vmx_path:
+#                 shutil.copy(vmx_path, os.path.join(debug_dir, os.path.basename(vmx_path)))
+#     except OSError as e:
+#         # If something is wrong we log the info to the log and we hope the log will be include correctly to the debug export
+#         log.error("Could not copy VMware VMX file {}".format(e), exc_info=1)
+#
+#     for compute in list(Controller.instance().computes.values()):
+#         try:
+#             r = await compute.get("/debug", raw=True)
+#             data = r.body.decode("utf-8")
+#         except Exception as e:
+#             data = str(e)
+#         with open(os.path.join(debug_dir, "compute_{}.txt".format(compute.id)), "w+") as f:
+#             f.write("Compute ID: {}\n".format(compute.id))
+#             f.write(data)
+#
+#     response.set_status(201)
+#
+# @staticmethod
+# def _getDebugData():
+#     try:
+#         connections = psutil.net_connections()
+#     # You need to be root for OSX
+#     except psutil.AccessDenied:
+#         connections = None
+#
+#     try:
+#         addrs = ["* {}: {}".format(key, val) for key, val in psutil.net_if_addrs().items()]
+#     except UnicodeDecodeError:
+#         addrs = ["INVALID ADDR WITH UNICODE CHARACTERS"]
+#
+#     data = """Version: {version}
+# OS: {os}
+# Python: {python}
+# CPU: {cpu}
+# Memory: {memory}
+#
+# Networks:
+# {addrs}
+#
+# Open connections:
+# {connections}
+#
+# Processus:
+# """.format(
+#         version=__version__,
+#         os=platform.platform(),
+#         python=platform.python_version(),
+#         memory=psutil.virtual_memory(),
+#         cpu=psutil.cpu_times(),
+#         connections=connections,
+#         addrs="\n".join(addrs)
+#     )
+#     for proc in psutil.process_iter():
+#         try:
+#             psinfo = proc.as_dict(attrs=["name", "exe"])
+#             data += "* {} {}\n".format(psinfo["name"], psinfo["exe"])
+#         except psutil.NoSuchProcess:
+#             pass
+#
+#     data += "\n\nProjects"
+#     for project in Controller.instance().projects.values():
+#         data += "\n\nProject name: {}\nProject ID: {}\n".format(project.name, project.id)
+#         if project.status != "closed":
+#             for link in project.links.values():
+#                 data += "Link {}: {}".format(link.id, link.debug_link_data)
+#
+#     return data

gns3server/api/routes/controller/dependencies/authentication.py

@@ -0,0 +1,117 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+
+from fastapi import Request, Query, Depends, HTTPException, WebSocket, status
+from fastapi.security import OAuth2PasswordBearer
+from typing import Optional
+
+from gns3server import schemas
+from gns3server.db.repositories.users import UsersRepository
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.services import auth_service
+from .database import get_repository
+
+log = logging.getLogger(__name__)
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/v3/access/users/login", auto_error=False)
+
+
+async def get_user_from_token(
+        bearer_token: str = Depends(oauth2_scheme),
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+        token: Optional[str] = Query(None, include_in_schema=False)
+) -> schemas.User:
+
+    if bearer_token:
+        # bearer token is used first, then any token passed as a URL parameter
+        token = bearer_token
+
+    if token is None:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Not authenticated",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+
+    username = auth_service.get_username_from_token(token)
+    user = await user_repo.get_user_by_username(username)
+    if user is None:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Could not validate credentials",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+    return user
+
+
+async def get_current_active_user(
+        request: Request,
+        current_user: schemas.User = Depends(get_user_from_token),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> schemas.User:
+
+    # Super admin is always authorized
+    if current_user.is_superadmin:
+        return current_user
+
+    if not current_user.is_active:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Not an active user",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+
+    return current_user
+
+
+async def get_current_active_user_from_websocket(
+        websocket: WebSocket,
+        token: str = Query(...),
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+) -> Optional[schemas.User]:
+
+    await websocket.accept()
+
+    try:
+        username = auth_service.get_username_from_token(token)
+        user = await user_repo.get_user_by_username(username)
+
+        if user is None:
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail=f"Could not validate credentials for '{username}'"
+            )
+
+        # Super admin is always authorized
+        if user.is_superadmin:
+            return user
+
+        if not user.is_active:
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail=f"'{username}' is not an active user"
+            )
+
+        return user
+
+    except HTTPException as e:
+        err_msg = f"Could not authenticate while connecting to controller WebSocket: {e.detail}"
+        websocket_error = {"action": "log.error", "event": {"message": err_msg}}
+        await websocket.send_json(websocket_error)
+        log.error(err_msg)
+        return await websocket.close(code=1008)
+

gns3server/api/routes/controller/dependencies/database.py

@@ -0,0 +1,38 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from typing import Callable, Type
+from fastapi import Depends
+from starlette.requests import HTTPConnection
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from gns3server.db.repositories.base import BaseRepository
+
+
+async def get_db_session(request: HTTPConnection) -> AsyncSession:
+
+    async with AsyncSession(request.app.state._db_engine, expire_on_commit=False) as session:
+        try:
+            yield session
+        finally:
+            await session.close()
+
+
+def get_repository(repo: Type[BaseRepository]) -> Callable:
+    def get_repo(db_session: AsyncSession = Depends(get_db_session)) -> Type[BaseRepository]:
+        return repo(db_session)
+
+    return get_repo

gns3server/api/routes/controller/dependencies/rbac.py

@@ -0,0 +1,78 @@
+#
+# Copyright (C) 2023 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import re
+
+from fastapi import Request, WebSocket, Depends, HTTPException
+from gns3server import schemas
+from gns3server.db.repositories.rbac import RbacRepository
+from .authentication import get_current_active_user, get_current_active_user_from_websocket
+from .database import get_repository
+
+import logging
+
+log = logging.getLogger()
+
+
+def has_privilege(
+        privilege_name: str
+):
+    async def get_user_and_check_privilege(
+            request: Request,
+            current_user: schemas.User = Depends(get_current_active_user),
+            rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+    ):
+        if not current_user.is_superadmin:
+            path = re.sub(r"^/v[0-9]", "", request.url.path)  # remove the prefix (e.g. "/v3") from URL path
+            log.debug(f"Checking user {current_user.username} has privilege {privilege_name} on '{path}'")
+            if not await rbac_repo.check_user_has_privilege(current_user.user_id, path, privilege_name):
+                raise HTTPException(status_code=403, detail=f"Permission denied (privilege {privilege_name} is required)")
+        return current_user
+    return get_user_and_check_privilege
+
+
+def has_privilege_on_websocket(
+        privilege_name: str
+):
+    async def get_user_and_check_privilege(
+            websocket: WebSocket,
+            current_user: schemas.User = Depends(get_current_active_user_from_websocket),
+            rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+    ):
+        if not current_user.is_superadmin:
+            path = re.sub(r"^/v[0-9]", "", websocket.url.path)  # remove the prefix (e.g. "/v3") from URL path
+            log.debug(f"Checking user {current_user.username} has privilege {privilege_name} on '{path}'")
+            if not await rbac_repo.check_user_has_privilege(current_user.user_id, path, privilege_name):
+                raise HTTPException(status_code=403, detail=f"Permission denied (privilege {privilege_name} is required)")
+        return current_user
+    return get_user_and_check_privilege
+
+# class PrivilegeChecker:
+#
+#     def __init__(self, required_privilege: str) -> None:
+#         self._required_privilege = required_privilege
+#
+#     async def __call__(
+#             self,
+#             current_user: schemas.User = Depends(get_current_active_user),
+#             rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+#     ) -> bool:
+#
+#         if not await rbac_repo.check_user_has_privilege(current_user.user_id, "/projects", self._required_privilege):
+#             raise HTTPException(status_code=403, detail=f"Permission denied (privilege {self._required_privilege} is required)")
+#         return True
+
+# Depends(PrivilegeChecker("Project.Audit"))

gns3server/api/routes/controller/drawings.py

@@ -0,0 +1,131 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for drawings.
+"""
+
+from fastapi import APIRouter, Depends, status
+from fastapi.encoders import jsonable_encoder
+from typing import List
+from uuid import UUID
+
+from gns3server.controller import Controller
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server import schemas
+
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Project or drawing not found"}}
+
+router = APIRouter(responses=responses)
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Drawing],
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Drawing.Audit"))]
+)
+async def get_drawings(project_id: UUID) -> List[schemas.Drawing]:
+    """
+    Return the list of all drawings for a given project.
+
+    Required privilege: Drawing.Audit
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    if project.status == "closed":
+        # allow to retrieve drawings from a closed project
+        return project.drawings.values()
+    return [v.asdict() for v in project.drawings.values()]
+
+
+@router.post(
+    "",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Drawing,
+    dependencies=[Depends(has_privilege("Drawing.Allocate"))]
+)
+async def create_drawing(project_id: UUID, drawing_data: schemas.Drawing) -> schemas.Drawing:
+    """
+    Create a new drawing.
+
+    Required privilege: Drawing.Allocate
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    drawing = await project.add_drawing(**jsonable_encoder(drawing_data, exclude_unset=True))
+    return drawing.asdict()
+
+
+@router.get(
+    "/{drawing_id}",
+    response_model=schemas.Drawing,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Drawing.Audit"))]
+)
+async def get_drawing(project_id: UUID, drawing_id: UUID) -> schemas.Drawing:
+    """
+    Return a drawing.
+
+    Required privilege: Drawing.Audit
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    drawing = project.get_drawing(str(drawing_id))
+    return drawing.asdict()
+
+
+@router.put(
+    "/{drawing_id}",
+    response_model=schemas.Drawing,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Drawing.Modify"))]
+)
+async def update_drawing(project_id: UUID, drawing_id: UUID, drawing_data: schemas.Drawing) -> schemas.Drawing:
+    """
+    Update a drawing.
+
+    Required privilege: Drawing.Modify
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    drawing = project.get_drawing(str(drawing_id))
+    await drawing.update(**jsonable_encoder(drawing_data, exclude_unset=True))
+    return drawing.asdict()
+
+
+@router.delete(
+    "/{drawing_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Drawing.Allocate"))]
+)
+async def delete_drawing(
+        project_id: UUID,
+        drawing_id: UUID,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a drawing.
+
+    Required privilege: Drawing.Allocate
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    await project.delete_drawing(str(drawing_id))
+    await rbac_repo.delete_all_ace_starting_with_path(f"/drawings/{drawing_id}")

gns3server/api/routes/controller/gns3vm.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for managing the GNS3 VM.
+"""
+
+from fastapi import APIRouter
+from fastapi.encoders import jsonable_encoder
+from typing import List
+
+from gns3server.controller import Controller
+from gns3server import schemas
+
+router = APIRouter()
+
+
+@router.get("/engines")
+async def get_engines() -> List[dict]:
+    """
+    Return the list of supported engines for the GNS3VM.
+    """
+
+    gns3_vm = Controller().instance().gns3vm
+    return gns3_vm.engine_list()
+
+
+@router.get("/engines/{engine}/vms")
+async def get_vms(engine: str) -> List[dict]:
+    """
+    Return all the available VMs for a specific virtualization engine.
+    """
+
+    vms = await Controller.instance().gns3vm.list(engine)
+    return vms
+
+
+@router.get("", response_model=schemas.GNS3VM)
+async def get_gns3vm_settings() -> schemas.GNS3VM:
+    """
+    Return the GNS3 VM settings.
+    """
+
+    return Controller.instance().gns3vm.asdict()
+
+
+@router.put("", response_model=schemas.GNS3VM, response_model_exclude_unset=True)
+async def update_gns3vm_settings(gns3vm_data: schemas.GNS3VM) -> schemas.GNS3VM:
+    """
+    Update the GNS3 VM settings.
+    """
+
+    controller = Controller().instance()
+    gns3_vm = controller.gns3vm
+    await gns3_vm.update_settings(jsonable_encoder(gns3vm_data, exclude_unset=True))
+    controller.save()
+    return gns3_vm.asdict()

gns3server/api/routes/controller/groups.py

@@ -0,0 +1,231 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2021 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for user groups.
+"""
+
+from fastapi import APIRouter, Depends, status
+from uuid import UUID
+from typing import List
+
+from gns3server import schemas
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerBadRequestError,
+    ControllerNotFoundError,
+    ControllerForbiddenError,
+)
+
+from gns3server.db.repositories.users import UsersRepository
+from gns3server.db.repositories.rbac import RbacRepository
+
+from .dependencies.rbac import has_privilege
+from .dependencies.database import get_repository
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.UserGroup],
+    dependencies=[Depends(has_privilege("Group.Audit"))]
+)
+async def get_user_groups(
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> List[schemas.UserGroup]:
+    """
+    Get all user groups.
+
+    Required privilege: Group.Audit
+    """
+
+    return await users_repo.get_user_groups()
+
+
+@router.post(
+    "",
+    response_model=schemas.UserGroup,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Group.Allocate"))]
+)
+async def create_user_group(
+        user_group_create: schemas.UserGroupCreate,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.UserGroup:
+    """
+    Create a new user group.
+
+    Required privilege: Group.Allocate
+    """
+
+    if await users_repo.get_user_group_by_name(user_group_create.name):
+        raise ControllerBadRequestError(f"User group '{user_group_create.name}' already exists")
+
+    return await users_repo.create_user_group(user_group_create)
+
+
+@router.get(
+    "/{user_group_id}",
+    response_model=schemas.UserGroup,
+    dependencies=[Depends(has_privilege("Group.Audit"))]
+)
+async def get_user_group(
+        user_group_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+) -> schemas.UserGroup:
+    """
+    Get a user group.
+
+    Required privilege: Group.Audit
+    """
+
+    user_group = await users_repo.get_user_group(user_group_id)
+    if not user_group:
+        raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
+    return user_group
+
+
+@router.put(
+    "/{user_group_id}",
+    response_model=schemas.UserGroup,
+    dependencies=[Depends(has_privilege("Group.Modify"))]
+)
+async def update_user_group(
+        user_group_id: UUID,
+        user_group_update: schemas.UserGroupUpdate,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.UserGroup:
+    """
+    Update a user group.
+
+    Required privilege: Group.Modify
+    """
+    user_group = await users_repo.get_user_group(user_group_id)
+    if not user_group:
+        raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
+
+    if user_group.is_builtin:
+        raise ControllerForbiddenError(f"Built-in user group '{user_group_id}' cannot be updated")
+
+    return await users_repo.update_user_group(user_group_id, user_group_update)
+
+
+@router.delete(
+    "/{user_group_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Group.Allocate"))]
+)
+async def delete_user_group(
+        user_group_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a user group.
+
+    Required privilege: Group.Allocate
+    """
+
+    user_group = await users_repo.get_user_group(user_group_id)
+    if not user_group:
+        raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
+
+    if user_group.is_builtin:
+        raise ControllerForbiddenError(f"Built-in user group '{user_group_id}' cannot be deleted")
+
+    success = await users_repo.delete_user_group(user_group_id)
+    if not success:
+        raise ControllerError(f"User group '{user_group_id}' could not be deleted")
+    await rbac_repo.delete_all_ace_starting_with_path(f"/groups/{user_group_id}")
+
+
+@router.get(
+    "/{user_group_id}/members",
+    response_model=List[schemas.User],
+    dependencies=[Depends(has_privilege("Group.Audit"))]
+)
+async def get_user_group_members(
+        user_group_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> List[schemas.User]:
+    """
+    Get all user group members.
+
+    Required privilege: Group.Audit
+    """
+
+    return await users_repo.get_user_group_members(user_group_id)
+
+
+@router.put(
+    "/{user_group_id}/members/{user_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Group.Modify"))]
+)
+async def add_member_to_group(
+        user_group_id: UUID,
+        user_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> None:
+    """
+    Add member to a user group.
+
+    Required privilege: Group.Modify
+    """
+
+    user = await users_repo.get_user(user_id)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+
+    user_groups = await users_repo.get_user_memberships(user_id)
+    for group in user_groups:
+        if group.user_group_id == user_group_id:
+            raise ControllerBadRequestError(f"Username '{user.username}' is already member of group '{group.name}'")
+
+    user_group = await users_repo.add_member_to_user_group(user_group_id, user)
+    if not user_group:
+        raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
+
+
+@router.delete(
+    "/{user_group_id}/members/{user_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Group.Modify"))]
+)
+async def remove_member_from_group(
+    user_group_id: UUID,
+    user_id: UUID,
+    users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+) -> None:
+    """
+    Remove member from a user group.
+
+    Required privilege: Group.Modify
+    """
+
+    user = await users_repo.get_user(user_id)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+
+    user_group = await users_repo.remove_member_from_user_group(user_group_id, user)
+    if not user_group:
+        raise ControllerNotFoundError(f"User group '{user_group_id}' not found")

gns3server/api/routes/controller/images.py

@@ -0,0 +1,255 @@
+#
+# Copyright (C) 2021 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for images.
+"""
+
+import os
+import logging
+import urllib.parse
+
+from fastapi import APIRouter, Request, Depends, status
+from fastapi.encoders import jsonable_encoder
+from starlette.requests import ClientDisconnect
+from sqlalchemy.orm.exc import MultipleResultsFound
+from typing import List, Optional
+from gns3server import schemas
+
+from gns3server.config import Config
+from gns3server.compute.qemu import Qemu
+from gns3server.utils.images import InvalidImageError, write_image, read_image_info, default_images_directory
+from gns3server.db.repositories.images import ImagesRepository
+from gns3server.db.repositories.templates import TemplatesRepository
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.controller import Controller
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerNotFoundError,
+    ControllerForbiddenError,
+    ControllerBadRequestError
+)
+
+from .dependencies.authentication import get_current_active_user
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.post(
+    "/qemu/{image_path:path}",
+    response_model=schemas.Image,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Image.Allocate"))]
+)
+async def create_qemu_image(
+        image_path: str,
+        image_data: schemas.QemuDiskImageCreate,
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+
+) -> schemas.Image:
+    """
+    Create a new blank Qemu image.
+
+    Required privilege: Image.Allocate
+    """
+
+    allow_raw_image = Config.instance().settings.Server.allow_raw_images
+    if image_data.format == schemas.QemuDiskImageFormat.raw and not allow_raw_image:
+        raise ControllerBadRequestError("Raw images are not allowed")
+
+    disk_image_path = urllib.parse.unquote(image_path)
+    image_dir, image_name = os.path.split(disk_image_path)
+    # check if the path is within the default images directory
+    base_images_directory = os.path.expanduser(Config.instance().settings.Server.images_path)
+    full_path = os.path.abspath(os.path.join(base_images_directory, image_dir, image_name))
+    if os.path.commonprefix([base_images_directory, full_path]) != base_images_directory:
+        raise ControllerForbiddenError(f"Cannot write disk image, '{disk_image_path}' is forbidden")
+
+    if not image_dir:
+        # put the image in the default images directory for Qemu
+        directory = default_images_directory(image_type="qemu")
+        os.makedirs(directory, exist_ok=True)
+        disk_image_path = os.path.abspath(os.path.join(directory, disk_image_path))
+
+    if await images_repo.get_image(disk_image_path):
+        raise ControllerBadRequestError(f"Disk image '{disk_image_path}' already exists")
+
+    options = jsonable_encoder(image_data, exclude_unset=True)
+    # FIXME: should we have the create_disk_image in the compute code since
+    # this code is used to create images on the controller?
+    await Qemu.instance().create_disk_image(disk_image_path, options)
+
+    image_info = await read_image_info(disk_image_path, "qemu")
+    return await images_repo.add_image(**image_info)
+
+@router.get(
+    "",
+    response_model=List[schemas.Image],
+    dependencies=[Depends(has_privilege("Image.Audit"))]
+)
+async def get_images(
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+        image_type: Optional[schemas.ImageType] = None
+) -> List[schemas.Image]:
+    """
+    Return all images.
+
+    Required privilege: Image.Audit
+    """
+
+    return await images_repo.get_images(image_type)
+
+
+@router.post(
+    "/upload/{image_path:path}",
+    response_model=schemas.Image,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Image.Allocate"))]
+)
+async def upload_image(
+        image_path: str,
+        request: Request,
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+        templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+        current_user: schemas.User = Depends(get_current_active_user),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+        install_appliances: Optional[bool] = False,
+) -> schemas.Image:
+    """
+    Upload an image.
+
+    Example: curl -X POST http://host:port/v3/images/upload/my_image_name.qcow2 \
+    -H 'Authorization: Bearer <token>' --data-binary @"/path/to/image.qcow2"
+
+    Required privilege: Image.Allocate
+    """
+
+    image_path = urllib.parse.unquote(image_path)
+    image_dir, image_name = os.path.split(image_path)
+    # check if the path is within the default images directory
+    base_images_directory = os.path.expanduser(Config.instance().settings.Server.images_path)
+    full_path = os.path.abspath(os.path.join(base_images_directory, image_dir, image_name))
+    if os.path.commonprefix([base_images_directory, full_path]) != base_images_directory:
+        raise ControllerForbiddenError(f"Cannot write image, '{image_path}' is forbidden")
+
+    image = await images_repo.get_image(image_path)
+    if image:
+        log.warning(f"Image '{image_path}' already exists")
+        return image
+
+    try:
+        allow_raw_image = Config.instance().settings.Server.allow_raw_images
+        image = await write_image(image_path, full_path, request.stream(), images_repo, allow_raw_image=allow_raw_image)
+    except (OSError, InvalidImageError, ClientDisconnect) as e:
+        raise ControllerError(f"Could not save image '{image_path}': {e}")
+
+    if install_appliances:
+        # attempt to automatically create templates based on image checksum
+        await Controller.instance().appliance_manager.install_appliances_from_image(
+            image_path,
+            image.checksum,
+            images_repo,
+            templates_repo,
+            rbac_repo,
+            current_user,
+            os.path.dirname(image.path)
+        )
+
+    return image
+
+
+@router.get(
+    "/{image_path:path}",
+    response_model=schemas.Image,
+    dependencies=[Depends(has_privilege("Image.Audit"))]
+)
+async def get_image(
+        image_path: str,
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+) -> schemas.Image:
+    """
+    Return an image.
+
+    Required privilege: Image.Audit
+    """
+
+    image_path = urllib.parse.unquote(image_path)
+    image = await images_repo.get_image(image_path)
+    if not image:
+        raise ControllerNotFoundError(f"Image '{image_path}' not found")
+    return image
+
+
+@router.delete(
+    "/{image_path:path}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Image.Allocate"))]
+)
+async def delete_image(
+        image_path: str,
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+) -> None:
+    """
+    Delete an image.
+
+    Required privilege: Image.Allocate
+    """
+
+    image_path = urllib.parse.unquote(image_path)
+
+    try:
+        image = await images_repo.get_image(image_path)
+    except MultipleResultsFound:
+        raise ControllerBadRequestError(f"Image '{image_path}' matches multiple images. "
+                                        f"Please include the relative path of the image")
+
+    if not image:
+        raise ControllerNotFoundError(f"Image '{image_path}' not found")
+
+    templates = await images_repo.get_image_templates(image.image_id)
+    if templates:
+        template_names = ", ".join([template.name for template in templates])
+        raise ControllerError(f"Image '{image_path}' is used by one or more templates: {template_names}")
+
+    try:
+        os.remove(image.path)
+    except OSError:
+        log.warning(f"Could not delete image file {image.path}")
+
+    success = await images_repo.delete_image(image_path)
+    if not success:
+        raise ControllerError(f"Image '{image_path}' could not be deleted")
+
+
+@router.post(
+    "/prune",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Image.Allocate"))]
+)
+async def prune_images(
+        images_repo: ImagesRepository = Depends(get_repository(ImagesRepository)),
+) -> None:
+    """
+    Prune images not attached to any template.
+
+    Required privilege: Image.Allocate
+    """
+
+    await images_repo.prune_images()

gns3server/api/routes/controller/links.py

@@ -0,0 +1,287 @@
+#
+# Copyright (C) 2023 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for links.
+"""
+
+import multidict
+import aiohttp
+
+from fastapi import APIRouter, Depends, Request, status
+from fastapi.responses import StreamingResponse
+from fastapi.encoders import jsonable_encoder
+from typing import List
+from uuid import UUID
+
+from gns3server.controller import Controller
+from gns3server.controller.controller_error import ControllerError
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.controller.link import Link
+from gns3server.utils.http_client import HTTPClient
+from gns3server import schemas
+
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+import logging
+
+log = logging.getLogger(__name__)
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or link"}}
+
+router = APIRouter(responses=responses)
+
+
+async def dep_link(project_id: UUID, link_id: UUID) -> Link:
+    """
+    Dependency to retrieve a link.
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    link = project.get_link(str(link_id))
+    return link
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Link],
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Link.Audit"))]
+)
+async def get_links(project_id: UUID) -> List[schemas.Link]:
+    """
+    Return all links for a given project.
+
+    Required privilege: Link.Audit
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    if project.status == "closed":
+        # allow to retrieve links from a closed project
+        return project.links.values()
+    return [v.asdict() for v in project.links.values()]
+
+
+@router.post(
+    "",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Link,
+    responses={
+        404: {"model": schemas.ErrorMessage, "description": "Could not find project"},
+        409: {"model": schemas.ErrorMessage, "description": "Could not create link"},
+    },
+    dependencies=[Depends(has_privilege("Link.Allocate"))]
+)
+async def create_link(project_id: UUID, link_data: schemas.LinkCreate) -> schemas.Link:
+    """
+    Create a new link.
+
+    Required privilege: Link.Allocate
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    link = await project.add_link()
+    link_data = jsonable_encoder(link_data, exclude_unset=True)
+    if "filters" in link_data:
+        await link.update_filters(link_data["filters"])
+    if "link_style" in link_data:
+        await link.update_link_style(link_data["link_style"])
+    if "suspend" in link_data:
+        await link.update_suspend(link_data["suspend"])
+    try:
+        for node in link_data["nodes"]:
+            await link.add_node(
+                project.get_node(node["node_id"]),
+                node.get("adapter_number", 0),
+                node.get("port_number", 0),
+                label=node.get("label"),
+            )
+    except ControllerError as e:
+        await project.delete_link(link.id)
+        raise e
+    return link.asdict()
+
+
+@router.get(
+    "/{link_id}/available_filters",
+    dependencies=[Depends(has_privilege("Link.Audit"))]
+)
+async def get_filters(link: Link = Depends(dep_link)) -> List[dict]:
+    """
+    Return all filters available for a given link.
+
+    Required privilege: Link.Audit
+    """
+
+    return link.available_filters()
+
+
+@router.get(
+    "/{link_id}",
+    response_model=schemas.Link,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Link.Audit"))]
+)
+async def get_link(link: Link = Depends(dep_link)) -> schemas.Link:
+    """
+    Return a link.
+
+    Required privilege: Link.Audit
+    """
+
+    return link.asdict()
+
+
+@router.put(
+    "/{link_id}",
+    response_model=schemas.Link,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Link.Modify"))]
+)
+async def update_link(link_data: schemas.LinkUpdate, link: Link = Depends(dep_link)) -> schemas.Link:
+    """
+    Update a link.
+
+    Required privilege: Link.Modify
+    """
+
+    link_data = jsonable_encoder(link_data, exclude_unset=True)
+    if "filters" in link_data:
+        await link.update_filters(link_data["filters"])
+    if "link_style" in link_data:
+        await link.update_link_style(link_data["link_style"])
+    if "suspend" in link_data:
+        await link.update_suspend(link_data["suspend"])
+    if "nodes" in link_data:
+        await link.update_nodes(link_data["nodes"])
+    return link.asdict()
+
+
+@router.delete(
+    "/{link_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Link.Allocate"))]
+)
+async def delete_link(
+        project_id: UUID,
+        link: Link = Depends(dep_link),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a link.
+
+    Required privilege: Link.Allocate
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    await project.delete_link(link.id)
+    await rbac_repo.delete_all_ace_starting_with_path(f"/links/{link.id}")
+
+
+@router.post(
+    "/{link_id}/reset",
+    response_model=schemas.Link,
+    dependencies=[Depends(has_privilege("Link.Modify"))]
+)
+async def reset_link(link: Link = Depends(dep_link)) -> schemas.Link:
+    """
+    Reset a link.
+
+    Required privilege: Link.Modify
+    """
+
+    await link.reset()
+    return link.asdict()
+
+
+@router.post(
+    "/{link_id}/capture/start",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Link,
+    dependencies=[Depends(has_privilege("Link.Capture"))]
+)
+async def start_capture(capture_data: dict, link: Link = Depends(dep_link)) -> schemas.Link:
+    """
+    Start packet capture on the link.
+
+    Required privilege: Link.Capture
+    """
+
+    await link.start_capture(
+        data_link_type=capture_data.get("data_link_type", "DLT_EN10MB"),
+        capture_file_name=capture_data.get("capture_file_name"),
+    )
+    return link.asdict()
+
+
+@router.post(
+    "/{link_id}/capture/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Link.Capture"))]
+)
+async def stop_capture(link: Link = Depends(dep_link)) -> None:
+    """
+    Stop packet capture on the link.
+
+    Required privilege: Link.Capture
+    """
+
+    await link.stop_capture()
+
+
+@router.get(
+    "/{link_id}/capture/stream",
+    dependencies=[Depends(has_privilege("Link.Capture"))]
+)
+async def stream_pcap(request: Request, link: Link = Depends(dep_link)) -> StreamingResponse:
+    """
+    Stream the PCAP capture file from compute.
+
+    Required privilege: Link.Capture
+    """
+
+    if not link.capturing:
+        raise ControllerError("This link has no active packet capture")
+
+    compute = link.compute
+    pcap_streaming_url = link.pcap_streaming_url()
+    headers = multidict.MultiDict(request.headers)
+    headers["Host"] = compute.host
+    headers["Router-Host"] = request.client.host
+    body = await request.body()
+
+    async def compute_pcap_stream():
+
+        try:
+            ssl_context = Controller.instance().ssl_context()
+            async with HTTPClient.request(
+                    request.method,
+                    pcap_streaming_url,
+                    user=compute.user,
+                    password=compute.password,
+                    ssl_context=ssl_context,
+                    timeout=None,
+                    data=body
+            ) as response:
+                async for data in response.content.iter_any():
+                    if not data:
+                        break
+                    yield data
+        except aiohttp.ClientError as e:
+            raise ControllerError(f"Client error received when receiving pcap stream from compute: {e}")
+
+    return StreamingResponse(compute_pcap_stream(), media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/controller/nodes.py

@@ -0,0 +1,619 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for nodes.
+"""
+
+import aiohttp
+import asyncio
+import ipaddress
+
+from fastapi import APIRouter, Depends, WebSocket, WebSocketDisconnect, Request, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.routing import APIRoute
+from typing import List, Callable
+from uuid import UUID
+
+from gns3server.controller import Controller
+from gns3server.config import Config
+from gns3server.controller.node import Node
+from gns3server.controller.project import Project
+from gns3server.utils import force_unix_path
+from gns3server.utils.http_client import HTTPClient
+from gns3server.controller.controller_error import ControllerForbiddenError, ControllerBadRequestError
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server import schemas
+
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege, has_privilege_on_websocket
+
+import logging
+
+log = logging.getLogger(__name__)
+
+node_locks = {}
+
+
+class NodeConcurrency(APIRoute):
+    """
+    To avoid strange effects, we prevent concurrency
+    between the same instance of the node
+    (excepting when streaming a PCAP file and for WebSocket consoles).
+    """
+
+    def get_route_handler(self) -> Callable:
+        original_route_handler = super().get_route_handler()
+
+        async def custom_route_handler(request: Request) -> Response:
+
+            node_id = request.path_params.get("node_id")
+            project_id = request.path_params.get("project_id")
+
+            if node_id and "pcap" not in request.url.path and not request.url.path.endswith("console/ws"):
+                lock_key = f"{project_id}:{node_id}"
+                node_locks.setdefault(lock_key, {"lock": asyncio.Lock(), "concurrency": 0})
+                node_locks[lock_key]["concurrency"] += 1
+
+                async with node_locks[lock_key]["lock"]:
+                    response = await original_route_handler(request)
+
+                node_locks[lock_key]["concurrency"] -= 1
+                if node_locks[lock_key]["concurrency"] <= 0:
+                    del node_locks[lock_key]
+            else:
+                response = await original_route_handler(request)
+
+            return response
+
+        return custom_route_handler
+
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}}
+
+router = APIRouter(route_class=NodeConcurrency, responses=responses)
+
+
+async def dep_project(project_id: UUID) -> Project:
+    """
+    Dependency to retrieve a project.
+    """
+
+    project = await Controller.instance().get_loaded_project(str(project_id))
+    return project
+
+
+async def dep_node(node_id: UUID, project: Project = Depends(dep_project)) -> None:
+    """
+    Dependency to retrieve a node.
+    """
+
+    node = project.get_node(str(node_id))
+    return node
+
+
+@router.post(
+    "",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Node,
+    responses={
+        404: {"model": schemas.ErrorMessage, "description": "Could not find project"},
+        409: {"model": schemas.ErrorMessage, "description": "Could not create node"},
+    },
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def create_node(node_data: schemas.NodeCreate, project: Project = Depends(dep_project)) -> schemas.Node:
+    """
+    Create a new node.
+
+    Required privilege: Node.Allocate
+    """
+
+    controller = Controller.instance()
+    compute = controller.get_compute(str(node_data.compute_id))
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await project.add_node(compute, node_data.pop("name"), node_data.pop("node_id", None), **node_data)
+    return node.asdict()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Node],
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Node.Audit"))]
+)
+def get_nodes(project: Project = Depends(dep_project)) -> List[schemas.Node]:
+    """
+    Return all nodes belonging to a given project.
+
+    Required privilege: Node.Audit
+    """
+
+    if project.status == "closed":
+        # allow to retrieve nodes from a closed project
+        return project.nodes.values()
+    return [v.asdict() for v in project.nodes.values()]
+
+
+@router.post("/start", status_code=status.HTTP_204_NO_CONTENT, dependencies=[Depends(has_privilege("Node.PowerMgmt"))])
+async def start_all_nodes(project: Project = Depends(dep_project)) -> None:
+    """
+    Start all nodes belonging to a given project.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await project.start_all()
+
+
+@router.post("/stop", status_code=status.HTTP_204_NO_CONTENT, dependencies=[Depends(has_privilege("Node.PowerMgmt"))])
+async def stop_all_nodes(project: Project = Depends(dep_project)) -> None:
+    """
+    Stop all nodes belonging to a given project.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await project.stop_all()
+
+
+@router.post("/suspend", status_code=status.HTTP_204_NO_CONTENT, dependencies=[Depends(has_privilege("Node.PowerMgmt"))])
+async def suspend_all_nodes(project: Project = Depends(dep_project)) -> None:
+    """
+    Suspend all nodes belonging to a given project.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await project.suspend_all()
+
+
+@router.post("/reload", status_code=status.HTTP_204_NO_CONTENT, dependencies=[Depends(has_privilege("Node.PowerMgmt"))])
+async def reload_all_nodes(project: Project = Depends(dep_project)) -> None:
+    """
+    Reload all nodes belonging to a given project.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await project.stop_all()
+    await project.start_all()
+
+
+@router.get("/{node_id}", response_model=schemas.Node, dependencies=[Depends(has_privilege("Node.Audit"))])
+def get_node(node: Node = Depends(dep_node)) -> schemas.Node:
+    """
+    Return a node from a given project.
+
+    Required privilege: Node.Audit
+    """
+
+    return node.asdict()
+
+
+@router.put(
+    "/{node_id}",
+    response_model=schemas.Node,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Node.Modify"))]
+)
+async def update_node(node_data: schemas.NodeUpdate, node: Node = Depends(dep_node)) -> schemas.Node:
+    """
+    Update a node.
+
+    Required privilege: Node.Modify
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+
+    # Ignore these because we only use them when creating a node
+    node_data.pop("node_id", None)
+    node_data.pop("node_type", None)
+    node_data.pop("compute_id", None)
+
+    await node.update(**node_data)
+    return node.asdict()
+
+
+@router.delete(
+    "/{node_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Cannot delete node"}},
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def delete_node(
+        node_id: UUID, project: Project = Depends(dep_project),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> None:
+    """
+    Delete a node from a project.
+
+    Required privilege: Node.Allocate
+    """
+
+    await project.delete_node(str(node_id))
+    await rbac_repo.delete_all_ace_starting_with_path(f"/projects/{project.id}/nodes/{node_id}")
+
+
+@router.post(
+    "/{node_id}/duplicate",
+    response_model=schemas.Node,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def duplicate_node(duplicate_data: schemas.NodeDuplicate, node: Node = Depends(dep_node)) -> schemas.Node:
+    """
+    Duplicate a node.
+
+    Required privilege: Node.Allocate
+    """
+
+    new_node = await node.project.duplicate_node(node, duplicate_data.x, duplicate_data.y, duplicate_data.z)
+    return new_node.asdict()
+
+
+@router.post(
+    "/{node_id}/start",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.PowerMgmt"))]
+)
+async def start_node(start_data: dict, node: Node = Depends(dep_node)) -> None:
+    """
+    Start a node.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await node.start(data=start_data)
+
+
+@router.post(
+    "/{node_id}/stop",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.PowerMgmt"))]
+)
+async def stop_node(node: Node = Depends(dep_node)) -> None:
+    """
+    Stop a node.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await node.stop()
+
+
+@router.post(
+    "/{node_id}/suspend",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.PowerMgmt"))]
+)
+async def suspend_node(node: Node = Depends(dep_node)) -> None:
+    """
+    Suspend a node.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await node.suspend()
+
+
+@router.post(
+    "/{node_id}/reload",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.PowerMgmt"))]
+)
+async def reload_node(node: Node = Depends(dep_node)) -> None:
+    """
+    Reload a node.
+
+    Required privilege: Node.PowerMgmt
+    """
+
+    await node.reload()
+
+
+@router.post(
+    "/{node_id}/isolate",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Link.Modify"))]
+)
+async def isolate_node(node: Node = Depends(dep_node)) -> None:
+    """
+    Isolate a node (suspend all attached links).
+
+    Required privilege: Link.Modify
+    """
+
+    for link in node.links:
+        await link.update_suspend(True)
+
+
+@router.post(
+    "/{node_id}/unisolate",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Link.Modify"))]
+)
+async def unisolate_node(node: Node = Depends(dep_node)) -> None:
+    """
+    Un-isolate a node (resume all attached suspended links).
+
+    Required privilege: Link.Modify
+    """
+
+    for link in node.links:
+        await link.update_suspend(False)
+
+
+@router.get(
+    "/{node_id}/links",
+    response_model=List[schemas.Link],
+    response_model_exclude_unset=True,
+    dependencies = [Depends(has_privilege("Link.Audit"))]
+)
+async def get_node_links(node: Node = Depends(dep_node)) -> List[schemas.Link]:
+    """
+    Return all the links connected to a node.
+
+    Required privilege: Link.Audit
+    """
+
+    links = []
+    for link in node.links:
+        links.append(link.asdict())
+    return links
+
+
+@router.get("/{node_id}/dynamips/auto_idlepc", dependencies=[Depends(has_privilege("Node.Audit"))])
+async def auto_idlepc(node: Node = Depends(dep_node)) -> dict:
+    """
+    Compute an Idle-PC value for a Dynamips node
+
+    Required privilege: Node.Audit
+    """
+
+    if node.node_type != "dynamips":
+        raise ControllerBadRequestError("Auto Idle-PC is only supported on a Dynamips node")
+    return await node.dynamips_auto_idlepc()
+
+
+@router.get("/{node_id}/dynamips/idlepc_proposals", dependencies=[Depends(has_privilege("Node.Audit"))])
+async def idlepc_proposals(node: Node = Depends(dep_node)) -> List[str]:
+    """
+    Compute a list of potential idle-pc values for a Dynamips node
+
+    Required privilege: Node.Audit
+    """
+
+    if node.node_type != "dynamips":
+        raise ControllerBadRequestError("Idle-PC proposals is only supported on a Dynamips node")
+    return await node.dynamips_idlepc_proposals()
+
+
+@router.post(
+    "/{node_id}/qemu/disk_image/{disk_name}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def create_disk_image(
+        disk_name: str,
+        disk_data: schemas.QemuDiskImageCreate,
+        node: Node = Depends(dep_node)
+) -> None:
+    """
+    Create a Qemu disk image.
+
+    Required privilege: Node.Allocate
+    """
+
+    if node.node_type != "qemu":
+        raise ControllerBadRequestError("Creating a disk image is only supported on a Qemu node")
+    await node.post(f"/disk_image/{disk_name}", data=disk_data.model_dump(exclude_unset=True))
+
+
+@router.put(
+    "/{node_id}/qemu/disk_image/{disk_name}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def update_disk_image(
+        disk_name: str,
+        disk_data: schemas.QemuDiskImageUpdate,
+        node: Node = Depends(dep_node)
+) -> None:
+    """
+    Update a Qemu disk image.
+
+    Required privilege: Node.Allocate
+    """
+
+    if node.node_type != "qemu":
+        raise ControllerBadRequestError("Updating a disk image is only supported on a Qemu node")
+    await node.put(f"/disk_image/{disk_name}", data=disk_data.model_dump(exclude_unset=True))
+
+
+@router.delete(
+    "/{node_id}/qemu/disk_image/{disk_name}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def delete_disk_image(
+        disk_name: str,
+        node: Node = Depends(dep_node)
+) -> None:
+    """
+    Delete a Qemu disk image.
+
+    Required privilege: Node.Allocate
+    """
+
+    if node.node_type != "qemu":
+        raise ControllerBadRequestError("Deleting a disk image is only supported on a Qemu node")
+    await node.delete(f"/disk_image/{disk_name}")
+
+
+@router.get("/{node_id}/files/{file_path:path}", dependencies=[Depends(has_privilege("Node.Audit"))])
+async def get_file(file_path: str, node: Node = Depends(dep_node)) -> Response:
+    """
+    Return a file from the node directory.
+
+    Required privilege: Node.Audit
+    """
+
+    path = force_unix_path(file_path)
+
+    # Raise error if user try to escape
+    if path[0] == ".":
+        raise ControllerForbiddenError("It is forbidden to get a file outside the project directory")
+
+    node_type = node.node_type
+    path = f"/project-files/{node_type}/{node.id}/{path}"
+
+    res = await node.compute.http_query("GET", f"/projects/{node.project.id}/files{path}", timeout=None, raw=True)
+    return Response(res.body, media_type="application/octet-stream", status_code=res.status)
+
+
+@router.post(
+    "/{node_id}/files/{file_path:path}",
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Node.Modify"))]
+)
+async def post_file(file_path: str, request: Request, node: Node = Depends(dep_node)):
+    """
+    Write a file in the node directory.
+
+    Required privilege: Node.Modify
+    """
+
+    path = force_unix_path(file_path)
+
+    # Raise error if user try to escape
+    if path[0] == ".":
+        raise ControllerForbiddenError("Cannot write outside the node directory")
+
+    node_type = node.node_type
+    path = f"/project-files/{node_type}/{node.id}/{path}"
+
+    data = await request.body()  # FIXME: are we handling timeout or large files correctly?
+    await node.compute.http_query("POST", f"/projects/{node.project.id}/files{path}", data=data, timeout=None, raw=True)
+    # FIXME: response with correct status code (from compute)
+
+
+@router.websocket("/{node_id}/console/ws")
+async def ws_console(
+        websocket: WebSocket,
+        current_user: schemas.User = Depends(has_privilege_on_websocket("Node.Console")),
+        node: Node = Depends(dep_node)
+) -> None:
+    """
+    WebSocket console.
+
+    Required privilege: Node.Console
+    """
+
+    if current_user is None:
+        return
+
+    compute = node.compute
+    log.info(
+        f"New client {websocket.client.host}:{websocket.client.port} has connected to controller console WebSocket"
+    )
+
+    compute_host = compute.host
+    try:
+        # handle IPv6 address
+        ip = ipaddress.ip_address(compute_host)
+        if isinstance(ip, ipaddress.IPv6Address):
+            compute_host = '[' + compute_host + ']'
+    except ValueError:
+        pass
+
+    ws_console_compute_url = (
+        f"{websocket.url.scheme}://{compute_host}:{compute.port}/v3/compute/projects/"
+        f"{node.project.id}/{node.node_type}/nodes/{node.id}/console/ws"
+    )
+
+    async def ws_receive(ws_console_compute):
+        """
+        Receive WebSocket data from client and forward to compute console WebSocket.
+        """
+
+        try:
+            while True:
+                data = await websocket.receive_text()
+                if data:
+                    await ws_console_compute.send_str(data)
+        except WebSocketDisconnect:
+            await ws_console_compute.close()
+            log.info(
+                f"Client {websocket.client.host}:{websocket.client.port} has disconnected from controller"
+                f" console WebSocket"
+            )
+
+    try:
+        # receive WebSocket data from compute console WebSocket and forward to client.
+        log.info(f"Forwarding console WebSocket to '{ws_console_compute_url}'")
+        server_config = Config.instance().settings.Server
+        user = server_config.compute_username
+        password = server_config.compute_password
+        if not user:
+            raise ControllerForbiddenError("Compute username is not set")
+        user = user.strip()
+        if user and password:
+            auth = aiohttp.BasicAuth(user, password.get_secret_value(), "utf-8")
+        else:
+            auth = aiohttp.BasicAuth(user, "")
+        ssl_context = Controller.instance().ssl_context()
+        async with HTTPClient.get_client().ws_connect(ws_console_compute_url, auth=auth, ssl_context=ssl_context) as ws:
+            asyncio.ensure_future(ws_receive(ws))
+            async for msg in ws:
+                if msg.type == aiohttp.WSMsgType.TEXT:
+                    await websocket.send_text(msg.data)
+                elif msg.type == aiohttp.WSMsgType.BINARY:
+                    await websocket.send_bytes(msg.data)
+                elif msg.type == aiohttp.WSMsgType.ERROR:
+                    break
+    except aiohttp.ClientError as e:
+        log.error(f"Client error received when forwarding to compute console WebSocket: {e}")
+
+
+@router.post(
+    "/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.Console"))]
+)
+async def reset_console_all_nodes(project: Project = Depends(dep_project)) -> None:
+    """
+    Reset console for all nodes belonging to the project.
+
+    Required privilege: Node.Console
+    """
+
+    await project.reset_console_all()
+
+
+@router.post(
+    "/{node_id}/console/reset",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Node.Console"))]
+)
+async def console_reset(node: Node = Depends(dep_node)) -> None:
+    """
+    Reset a console for a given node.
+
+    Required privilege: Node.Console
+    """
+
+    await node.post("/console/reset")

gns3server/api/routes/controller/pools.py

@@ -0,0 +1,239 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2023 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for resource pools.
+"""
+
+from fastapi import APIRouter, Depends, status
+from uuid import UUID
+from typing import List
+
+from gns3server import schemas
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerBadRequestError,
+    ControllerNotFoundError
+)
+
+from gns3server.controller import Controller
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.db.repositories.pools import ResourcePoolsRepository
+
+from .dependencies.rbac import has_privilege
+from .dependencies.database import get_repository
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.ResourcePool],
+    dependencies=[Depends(has_privilege("Pool.Audit"))]
+)
+async def get_resource_pools(
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> List[schemas.ResourcePool]:
+    """
+    Get all resource pools.
+
+    Required privilege: Pool.Audit
+    """
+
+    return await pools_repo.get_resource_pools()
+
+
+@router.post(
+    "",
+    response_model=schemas.ResourcePool,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Pool.Allocate"))]
+)
+async def create_resource_pool(
+        resource_pool_create: schemas.ResourcePoolCreate,
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> schemas.ResourcePool:
+    """
+    Create a new resource pool
+
+    Required privilege: Pool.Allocate
+    """
+
+    if await pools_repo.get_resource_pool_by_name(resource_pool_create.name):
+       raise ControllerBadRequestError(f"Resource pool '{resource_pool_create.name}' already exists")
+
+    return await pools_repo.create_resource_pool(resource_pool_create)
+
+
+@router.get(
+    "/{resource_pool_id}",
+    response_model=schemas.ResourcePool,
+    dependencies=[Depends(has_privilege("Pool.Audit"))]
+)
+async def get_resource_pool(
+        resource_pool_id: UUID,
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> schemas.ResourcePool:
+    """
+    Get a resource pool.
+
+    Required privilege: Pool.Audit
+    """
+
+    resource_pool = await pools_repo.get_resource_pool(resource_pool_id)
+    if not resource_pool:
+        raise ControllerNotFoundError(f"Resource pool '{resource_pool_id}' not found")
+    return resource_pool
+
+
+@router.put(
+    "/{resource_pool_id}",
+    response_model=schemas.ResourcePool,
+    dependencies=[Depends(has_privilege("Pool.Modify"))]
+)
+async def update_resource_pool(
+        resource_pool_id: UUID,
+        resource_pool_update: schemas.ResourcePoolUpdate,
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> schemas.ResourcePool:
+    """
+    Update a resource pool.
+
+    Required privilege: Pool.Modify
+    """
+
+    resource_pool = await pools_repo.get_resource_pool(resource_pool_id)
+    if not resource_pool:
+        raise ControllerNotFoundError(f"Resource pool '{resource_pool_id}' not found")
+
+    return await pools_repo.update_resource_pool(resource_pool_id, resource_pool_update)
+
+
+@router.delete(
+    "/{resource_pool_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Pool.Allocate"))]
+)
+async def delete_resource_pool(
+        resource_pool_id: UUID,
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository)),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a resource pool.
+
+    Required privilege: Pool.Allocate
+    """
+
+    resource_pool = await pools_repo.get_resource_pool(resource_pool_id)
+    if not resource_pool:
+        raise ControllerNotFoundError(f"Resource pool '{resource_pool_id}' not found")
+
+    success = await pools_repo.delete_resource_pool(resource_pool_id)
+    if not success:
+        raise ControllerError(f"Resource pool '{resource_pool_id}' could not be deleted")
+    await rbac_repo.delete_all_ace_starting_with_path(f"/pools/{resource_pool_id}")
+
+
+@router.get(
+    "/{resource_pool_id}/resources",
+    response_model=List[schemas.Resource],
+    dependencies=[Depends(has_privilege("Pool.Audit"))]
+)
+async def get_pool_resources(
+        resource_pool_id: UUID,
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository)),
+) -> List[schemas.Resource]:
+    """
+    Get all resource in a pool.
+
+    Required privilege: Pool.Audit
+    """
+
+    return await pools_repo.get_pool_resources(resource_pool_id)
+
+
+@router.put(
+    "/{resource_pool_id}/resources/{resource_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Pool.Modify"))]
+)
+async def add_resource_to_pool(
+        resource_pool_id: UUID,
+        resource_id: UUID,
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository)),
+) -> None:
+    """
+    Add resource to a resource pool.
+
+    Required privilege: Pool.Modify
+    """
+
+    resource_pool = await pools_repo.get_resource_pool(resource_pool_id)
+    if not resource_pool:
+        raise ControllerNotFoundError(f"Resource pool '{resource_pool_id}' not found")
+
+    # TODO: consider if a resource can belong to multiple pools
+    resources = await pools_repo.get_pool_resources(resource_pool_id)
+    for resource in resources:
+        if resource.resource_id == resource_id:
+            raise ControllerBadRequestError(f"Resource '{resource_id}' is already in '{resource_pool.name}'")
+
+    # we only support projects in resource pools for now
+    project = Controller.instance().get_project(str(resource_id))
+
+    resource = await pools_repo.get_resource(resource_id)
+    if not resource:
+        # the resource is not in the database yet, create it
+        resource_create = schemas.ResourceCreate(resource_id=resource_id, resource_type="project", name=project.name)
+        resource = await pools_repo.create_resource(resource_create)
+
+    await pools_repo.add_resource_to_pool(resource_pool_id, resource)
+
+
+@router.delete(
+    "/{resource_pool_id}/resources/{resource_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Pool.Modify"))]
+)
+async def remove_resource_from_pool(
+    resource_pool_id: UUID,
+    resource_id: UUID,
+    pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository)),
+) -> None:
+    """
+    Remove resource from a resource pool.
+
+    Required privilege: Pool.Modify
+    """
+
+    resource = await pools_repo.get_resource(resource_id)
+    if not resource:
+        raise ControllerNotFoundError(f"Resource '{resource_id}' not found")
+
+    resource_pool = await pools_repo.remove_resource_from_pool(resource_pool_id, resource)
+    if not resource_pool:
+        raise ControllerNotFoundError(f"Resource pool '{resource_pool_id}' not found")
+
+    # TODO: consider if a resource can belong to multiple pools
+    success = await pools_repo.delete_resource(resource.resource_id)
+    if not success:
+        raise ControllerError(f"Resource '{resource_id}' could not be deleted")

gns3server/api/routes/controller/privileges.py

@@ -0,0 +1,43 @@
+#
+# Software Name : GNS3 server
+# Version: 3
+# SPDX-FileCopyrightText: Copyright (c) 2023 Orange Business Services
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This software is distributed under the GPL-3.0 or any later version,
+# the text of which is available at https://www.gnu.org/licenses/gpl-3.0.txt
+# or see the "LICENSE" file for more details.
+#
+# Author: Sylvain MATHIEU
+#
+
+"""
+API route for privileges
+"""
+
+from typing import List
+from gns3server.db.repositories.rbac import RbacRepository
+from .dependencies.database import get_repository
+from fastapi import APIRouter, Depends
+import logging
+
+from gns3server import schemas
+
+log = logging.getLogger(__name__)
+router = APIRouter()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Privilege],
+)
+async def get_privileges(
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> List[schemas.Privilege]:
+    """
+    Get all privileges.
+
+    Required privilege: None
+    """
+
+    return await rbac_repo.get_privileges()

gns3server/api/routes/controller/projects.py

@@ -0,0 +1,579 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for projects.
+"""
+
+import os
+import asyncio
+import tempfile
+import aiofiles
+import time
+import urllib.parse
+import gns3server.utils.zipfile_zstd as zipfile
+
+import logging
+
+log = logging.getLogger()
+
+from fastapi import APIRouter, Depends, Request, Body, HTTPException, status, WebSocket, WebSocketDisconnect
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse, FileResponse
+from websockets.exceptions import ConnectionClosed, WebSocketException
+from typing import List, Optional
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.controller import Controller
+from gns3server.controller.project import Project
+from gns3server.controller.controller_error import ControllerError, ControllerBadRequestError
+from gns3server.controller.import_project import import_project as import_controller_project
+from gns3server.controller.export_project import export_project as export_controller_project
+from gns3server.utils.asyncio import aiozipstream
+from gns3server.utils.path import is_safe_path
+from gns3server.db.repositories.templates import TemplatesRepository
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.db.repositories.pools import ResourcePoolsRepository
+from gns3server.services.templates import TemplatesService
+
+from .dependencies.rbac import has_privilege, has_privilege_on_websocket
+from .dependencies.authentication import get_current_active_user
+from .dependencies.database import get_repository
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_project(project_id: UUID) -> Project:
+    """
+    Dependency to retrieve a project.
+    """
+
+    project = Controller.instance().get_project(str(project_id))
+    return project
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Project],
+    response_model_exclude_unset=True
+)
+async def get_projects(
+        current_user: schemas.User = Depends(get_current_active_user),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> List[schemas.Project]:
+    """
+    Return all projects.
+
+    Required privilege: Project.Audit
+    """
+
+    controller = Controller.instance()
+    projects = []
+
+    if current_user.is_superadmin:
+        # super admin sees all projects
+        return [p.asdict() for p in controller.projects.values()]
+    elif await rbac_repo.check_user_has_privilege(current_user.user_id, "/projects", "Project.Audit"):
+        # user with Project.Audit privilege on '/projects' sees all projects except those in resource pools
+        project_ids_in_pools = [str(r.resource_id) for r in await pools_repo.get_resources() if r.resource_type == "project"]
+        projects.extend([p.asdict() for p in controller.projects.values() if p.id not in project_ids_in_pools])
+
+    # user with Project.Audit privilege on resource pools sees the projects in these pools
+    user_pool_resources = await rbac_repo.get_user_pool_resources(current_user.user_id, "Project.Audit")
+    project_ids_in_pools = [str(r.resource_id) for r in user_pool_resources if r.resource_type == "project"]
+    projects.extend([p.asdict() for p in controller.projects.values() if p.id in project_ids_in_pools])
+
+    return projects
+
+
+@router.post(
+    "",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Project,
+    response_model_exclude_unset=True,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create project"}},
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def create_project(
+        project_data: schemas.ProjectCreate,
+) -> schemas.Project:
+    """
+    Create a new project.
+
+    Required privilege: Project.Allocate
+    """
+
+    controller = Controller.instance()
+    project = await controller.add_project(**jsonable_encoder(project_data, exclude_unset=True))
+    return project.asdict()
+
+
+@router.get("/{project_id}", response_model=schemas.Project, dependencies=[Depends(has_privilege("Project.Audit"))])
+def get_project(project: Project = Depends(dep_project)) -> schemas.Project:
+    """
+    Return a project.
+
+    Required privilege: Project.Audit
+    """
+
+    return project.asdict()
+
+
+@router.put(
+    "/{project_id}",
+    response_model=schemas.Project,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Project.Modify"))]
+)
+async def update_project(
+        project_data: schemas.ProjectUpdate,
+        project: Project = Depends(dep_project)
+) -> schemas.Project:
+    """
+    Update a project.
+
+    Required privilege: Project.Modify
+    """
+
+    await project.update(**jsonable_encoder(project_data, exclude_unset=True))
+    return project.asdict()
+
+
+@router.delete(
+    "/{project_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def delete_project(
+        project: Project = Depends(dep_project),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> None:
+    """
+    Delete a project.
+
+    Required privilege: Project.Allocate
+    """
+
+    controller = Controller.instance()
+    await project.delete()
+    controller.remove_project(project)
+    await rbac_repo.delete_all_ace_starting_with_path(f"/projects/{project.id}")
+
+
+@router.get("/{project_id}/stats", dependencies=[Depends(has_privilege("Project.Audit"))])
+def get_project_stats(project: Project = Depends(dep_project)) -> dict:
+    """
+    Return a project statistics.
+
+    Required privilege: Project.Audit
+    """
+
+    return project.stats()
+
+
+@router.post(
+    "/{project_id}/close",
+    status_code=status.HTTP_204_NO_CONTENT,
+    responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Could not close project"}},
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def close_project(project: Project = Depends(dep_project)) -> None:
+    """
+    Close a project.
+
+    Required privilege: Project.Allocate
+    """
+
+    await project.close()
+
+
+@router.post(
+    "/{project_id}/open",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Project,
+    responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Could not open project"}},
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def open_project(project: Project = Depends(dep_project)) -> schemas.Project:
+    """
+    Open a project.
+
+    Required privilege: Project.Allocate
+    """
+
+    await project.open()
+    return project.asdict()
+
+
+@router.post(
+    "/load",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Project,
+    responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Could not load project"}},
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def load_project(path: str = Body(..., embed=True)) -> schemas.Project:
+    """
+    Load a project (local server only).
+
+    Required privilege: Project.Allocate
+    """
+
+    controller = Controller.instance()
+    dot_gns3_file = path
+    project = await controller.load_project(dot_gns3_file)
+    return project.asdict()
+
+
+@router.get("/{project_id}/notifications", dependencies=[Depends(has_privilege("Project.Audit"))])
+async def project_http_notifications(project_id: UUID) -> StreamingResponse:
+    """
+    Receive project notifications about the controller from HTTP stream.
+
+    Required privilege: Project.Audit
+    """
+
+    from gns3server.api.server import app
+    controller = Controller.instance()
+    project = controller.get_project(str(project_id))
+
+    log.info(f"New client has connected to the notification stream for project ID '{project.id}' (HTTP stream method)")
+
+    async def event_stream():
+
+        try:
+            with controller.notification.project_queue(project.id) as queue:
+                while not app.state.exiting:
+                    msg = await queue.get_json(5)
+                    yield f"{msg}\n".encode("utf-8")
+        finally:
+            log.info(f"Client has disconnected from notification for project ID '{project.id}' (HTTP stream method)")
+            if project.auto_close:
+                # To avoid trouble with client connecting disconnecting we sleep few seconds before checking
+                # if someone else is not connected
+                await asyncio.sleep(5)
+                if not controller.notification.project_has_listeners(project.id):
+                    log.info(f"Project '{project.id}' is automatically closing due to no client listening")
+                    await project.close()
+
+    return StreamingResponse(event_stream(), media_type="application/json")
+
+
+@router.websocket("/{project_id}/notifications/ws")
+async def project_ws_notifications(
+        project_id: UUID,
+        websocket: WebSocket,
+        current_user: schemas.User = Depends(has_privilege_on_websocket("Project.Audit"))
+) -> None:
+    """
+    Receive project notifications about the controller from WebSocket.
+
+    Required privilege: Project.Audit
+    """
+
+    if current_user is None:
+        return
+
+    controller = Controller.instance()
+    project = controller.get_project(str(project_id))
+
+    log.info(f"New client has connected to the notification stream for project ID '{project.id}' (WebSocket method)")
+    try:
+        with controller.notification.project_queue(project.id) as queue:
+            while True:
+                notification = await queue.get_json(5)
+                await websocket.send_text(notification)
+    except (ConnectionClosed, WebSocketDisconnect):
+        log.info(f"Client has disconnected from notification stream for project ID '{project.id}' (WebSocket method)")
+    except WebSocketException as e:
+        log.warning(f"Error while sending to project event to WebSocket client: {e}")
+    finally:
+        if project.auto_close:
+            # To avoid trouble with client connecting disconnecting we sleep few seconds before checking
+            # if someone else is not connected
+            await asyncio.sleep(5)
+            if not controller.notification.project_has_listeners(project.id):
+                log.info(f"Project '{project.id}' is automatically closing due to no client listening")
+                await project.close()
+
+
+@router.get("/{project_id}/export", dependencies=[Depends(has_privilege("Project.Audit"))])
+async def export_project(
+    project: Project = Depends(dep_project),
+    include_snapshots: bool = False,
+    include_images: bool = False,
+    reset_mac_addresses: bool = False,
+    keep_compute_ids: bool = False,
+    compression: schemas.ProjectCompression = "zstd",
+    compression_level: int = None,
+) -> StreamingResponse:
+    """
+    Export a project as a portable archive.
+
+    Required privilege: Project.Audit
+    """
+
+    compression_query = compression.lower()
+    if compression_query == "zip":
+        compression = zipfile.ZIP_DEFLATED
+        if compression_level is not None and (compression_level < 0 or compression_level > 9):
+            raise ControllerBadRequestError("Compression level must be between 0 and 9 for ZIP compression")
+    elif compression_query == "none":
+        compression = zipfile.ZIP_STORED
+    elif compression_query == "bzip2":
+        compression = zipfile.ZIP_BZIP2
+        if compression_level is not None and (compression_level < 1 or compression_level > 9):
+            raise ControllerBadRequestError("Compression level must be between 1 and 9 for BZIP2 compression")
+    elif compression_query == "lzma":
+        compression = zipfile.ZIP_LZMA
+    elif compression_query == "zstd":
+        compression = zipfile.ZIP_ZSTANDARD
+        if compression_level is not None and (compression_level < 1 or compression_level > 22):
+            raise ControllerBadRequestError("Compression level must be between 1 and 22 for Zstandard compression")
+
+    if compression_level is not None and compression_query in ("none", "lzma"):
+        raise ControllerBadRequestError(f"Compression level is not supported for '{compression_query}' compression method")
+
+    try:
+        begin = time.time()
+        # use the parent directory as a temporary working dir
+        working_dir = os.path.abspath(os.path.join(project.path, os.pardir))
+
+        async def streamer():
+            log.info(f"Exporting project '{project.name}' with '{compression_query}' compression "
+                     f"(level {compression_level})")
+            with tempfile.TemporaryDirectory(dir=working_dir) as tmpdir:
+                with aiozipstream.ZipFile(compression=compression, compresslevel=compression_level) as zstream:
+                    await export_controller_project(
+                        zstream,
+                        project,
+                        tmpdir,
+                        include_snapshots=include_snapshots,
+                        include_images=include_images,
+                        keep_compute_ids=keep_compute_ids,
+                        reset_mac_addresses=reset_mac_addresses,
+                    )
+                    async for chunk in zstream:
+                        yield chunk
+
+            log.info(f"Project '{project.name}' exported in {time.time() - begin:.4f} seconds")
+
+    # Will be raised if you have no space left or permission issue on your temporary directory
+    # RuntimeError: something was wrong during the zip process
+    except (ValueError, OSError, RuntimeError) as e:
+        raise ConnectionError(f"Cannot export project: {e}")
+
+    headers = {"CONTENT-DISPOSITION": f'attachment; filename="{project.name}.gns3project"'}
+    return StreamingResponse(streamer(), media_type="application/gns3project", headers=headers)
+
+
+@router.post(
+    "/{project_id}/import",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Project,
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def import_project(
+        project_id: UUID,
+        request: Request,
+        name: Optional[str] = None
+) -> schemas.Project:
+    """
+    Import a project from a portable archive.
+
+    Required privilege: Project.Allocate
+    """
+
+    controller = Controller.instance()
+    # We write the content to a temporary location and then we extract it all.
+    # It could be more optimal to stream this but it is not implemented in Python.
+    try:
+        begin = time.time()
+        working_dir = controller.projects_directory()
+        with tempfile.TemporaryDirectory(dir=working_dir) as tmpdir:
+            temp_project_path = os.path.join(tmpdir, "project.zip")
+            async with aiofiles.open(temp_project_path, "wb") as f:
+                async for chunk in request.stream():
+                    await f.write(chunk)
+            with open(temp_project_path, "rb") as f:
+                project = await import_controller_project(controller, str(project_id), f, name=name)
+
+        log.info(f"Project '{project.name}' imported in {time.time() - begin:.4f} seconds")
+    except OSError as e:
+        raise ControllerError(f"Could not import the project: {e}")
+    return project.asdict()
+
+
+@router.post(
+    "/{project_id}/duplicate",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Project,
+    responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Could not duplicate project"}},
+    dependencies=[Depends(has_privilege("Project.Allocate"))]
+)
+async def duplicate_project(
+        project_data: schemas.ProjectDuplicate,
+        project: Project = Depends(dep_project),
+        pools_repo: ResourcePoolsRepository = Depends(get_repository(ResourcePoolsRepository))
+) -> schemas.Project:
+    """
+    Duplicate a project.
+
+    Required privilege: Project.Allocate
+    """
+
+    reset_mac_addresses = project_data.reset_mac_addresses
+    new_project = await project.duplicate(
+        name=project_data.name, reset_mac_addresses=reset_mac_addresses
+    )
+
+    # Add the new project in the same resource pools if the duplicated project is in any
+    pool_memberships = await pools_repo.get_resource_memberships(project.id)
+    if pool_memberships:
+        resource_create = schemas.ResourceCreate(resource_id=new_project.id, resource_type="project", name=new_project.name)
+        resource = await pools_repo.create_resource(resource_create)
+        for pool in pool_memberships:
+            await pools_repo.add_resource_to_pool(pool.resource_pool_id, resource)
+
+    return new_project.asdict()
+
+
+@router.get("/{project_id}/locked", dependencies=[Depends(has_privilege("Project.Audit"))])
+async def locked_project(project: Project = Depends(dep_project)) -> bool:
+    """
+    Returns whether a project is locked or not.
+
+    Required privilege: Project.Audit
+    """
+
+    return project.locked
+
+
+@router.post(
+    "/{project_id}/lock",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Project.Modify"))]
+)
+async def lock_project(project: Project = Depends(dep_project)) -> None:
+    """
+    Lock all drawings and nodes in a given project.
+
+    Required privilege: Project.Audit
+    """
+
+    project.lock()
+
+
+@router.post(
+    "/{project_id}/unlock",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Project.Modify"))]
+)
+async def unlock_project(project: Project = Depends(dep_project)) -> None:
+    """
+    Unlock all drawings and nodes in a given project.
+
+    Required privilege: Project.Modify
+    """
+
+    project.unlock()
+
+
+@router.get("/{project_id}/files/{file_path:path}", dependencies=[Depends(has_privilege("Project.Audit"))])
+async def get_file(file_path: str, project: Project = Depends(dep_project)) -> FileResponse:
+    """
+    Return a file from a project.
+
+    Required privilege: Project.Audit
+    """
+
+    file_path = urllib.parse.unquote(file_path)
+    path = os.path.normpath(file_path)
+
+    # Raise error if user try to escape
+    if not is_safe_path(path, project.path):
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    path = os.path.join(project.path, path)
+    if not os.path.exists(path):
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    return FileResponse(path, media_type="application/octet-stream")
+
+
+@router.post(
+    "/{project_id}/files/{file_path:path}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Project.Modify"))]
+)
+async def write_file(file_path: str, request: Request, project: Project = Depends(dep_project)) -> None:
+    """
+    Write a file to a project.
+
+    Required privilege: Project.Modify
+    """
+
+    file_path = urllib.parse.unquote(file_path)
+    path = os.path.normpath(file_path)
+
+    # Raise error if user try to escape
+    if not is_safe_path(path, project.path):
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    path = os.path.join(project.path, path)
+
+    try:
+        async with aiofiles.open(path, "wb+") as f:
+            async for chunk in request.stream():
+                await f.write(chunk)
+    except FileNotFoundError:
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+    except PermissionError:
+        raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED)
+    except OSError as e:
+        raise ControllerError(str(e))
+
+
+@router.post(
+    "/{project_id}/templates/{template_id}",
+    response_model=schemas.Node,
+    status_code=status.HTTP_201_CREATED,
+    responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or template"}},
+    dependencies=[Depends(has_privilege("Node.Allocate"))]
+)
+async def create_node_from_template(
+    project_id: UUID,
+    template_id: UUID,
+    template_usage: schemas.TemplateUsage,
+    templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+) -> schemas.Node:
+    """
+    Create a new node from a template.
+
+    Required privilege: Node.Allocate
+    """
+
+    template = await TemplatesService(templates_repo).get_template(template_id)
+    controller = Controller.instance()
+    project = controller.get_project(str(project_id))
+    node = await project.add_node_from_template(
+        template, x=template_usage.x, y=template_usage.y, compute_id=template_usage.compute_id
+    )
+    return node.asdict()

gns3server/api/routes/controller/roles.py

@@ -0,0 +1,224 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2021 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for roles.
+"""
+
+from fastapi import APIRouter, Depends, status
+from uuid import UUID
+from typing import List
+
+from gns3server import schemas
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerBadRequestError,
+    ControllerNotFoundError,
+    ControllerForbiddenError,
+)
+
+from gns3server.db.repositories.rbac import RbacRepository
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Role],
+    dependencies=[Depends(has_privilege("Role.Audit"))]
+)
+async def get_roles(
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> List[schemas.Role]:
+    """
+    Get all roles.
+
+    Required privilege: Role.Audit
+    """
+
+    return await rbac_repo.get_roles()
+
+
+@router.post(
+    "",
+    response_model=schemas.Role,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Role.Allocate"))]
+)
+async def create_role(
+        role_create: schemas.RoleCreate,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> schemas.Role:
+    """
+    Create a new role.
+
+    Required privilege: Role.Allocate
+    """
+
+    if await rbac_repo.get_role_by_name(role_create.name):
+        raise ControllerBadRequestError(f"Role '{role_create.name}' already exists")
+
+    return await rbac_repo.create_role(role_create)
+
+
+@router.get(
+    "/{role_id}",
+    response_model=schemas.Role,
+    dependencies=[Depends(has_privilege("Role.Audit"))]
+)
+async def get_role(
+        role_id: UUID,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> schemas.Role:
+    """
+    Get a role.
+
+    Required privilege: Role.Audit
+    """
+
+    role = await rbac_repo.get_role(role_id)
+    if not role:
+        raise ControllerNotFoundError(f"Role '{role_id}' not found")
+    return role
+
+
+@router.put(
+    "/{role_id}",
+    response_model=schemas.Role,
+    dependencies=[Depends(has_privilege("Role.Modify"))]
+)
+async def update_role(
+        role_id: UUID,
+        role_update: schemas.RoleUpdate,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> schemas.Role:
+    """
+    Update a role.
+
+    Required privilege: Role.Modify
+    """
+
+    role = await rbac_repo.get_role(role_id)
+    if not role:
+        raise ControllerNotFoundError(f"Role '{role_id}' not found")
+
+    if role.is_builtin:
+        raise ControllerForbiddenError(f"Built-in role '{role_id}' cannot be updated")
+
+    return await rbac_repo.update_role(role_id, role_update)
+
+
+@router.delete(
+    "/{role_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Role.Allocate"))]
+)
+async def delete_role(
+    role_id: UUID,
+    rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> None:
+    """
+    Delete a role.
+
+    Required privilege: Role.Allocate
+    """
+
+    role = await rbac_repo.get_role(role_id)
+    if not role:
+        raise ControllerNotFoundError(f"Role '{role_id}' not found")
+
+    if role.is_builtin:
+        raise ControllerForbiddenError(f"Built-in role '{role_id}' cannot be deleted")
+
+    success = await rbac_repo.delete_role(role_id)
+    if not success:
+        raise ControllerError(f"Role '{role_id}' could not be deleted")
+    await rbac_repo.delete_all_ace_starting_with_path(f"/roles/{role_id}")
+
+
+@router.get(
+    "/{role_id}/privileges",
+    response_model=List[schemas.Privilege],
+    dependencies=[Depends(has_privilege("Role.Audit"))]
+)
+async def get_role_privileges(
+        role_id: UUID,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> List[schemas.Privilege]:
+    """
+    Get all role privileges.
+
+    Required privilege: Role.Audit
+    """
+
+    return await rbac_repo.get_role_privileges(role_id)
+
+
+@router.put(
+    "/{role_id}/privileges/{privilege_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Role.Modify"))]
+)
+async def add_privilege_to_role(
+        role_id: UUID,
+        privilege_id: UUID,
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Add a privilege to a role.
+
+    Required privilege: Role.Modify
+    """
+
+    privilege = await rbac_repo.get_privilege(privilege_id)
+    if not privilege:
+        raise ControllerNotFoundError(f"Privilege '{privilege_id}' not found")
+
+    role = await rbac_repo.add_privilege_to_role(role_id, privilege)
+    if not role:
+        raise ControllerNotFoundError(f"Role '{role_id}' not found")
+
+
+@router.delete(
+    "/{role_id}/privileges/{privilege_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Role.Modify"))]
+)
+async def remove_privilege_from_role(
+    role_id: UUID,
+    privilege_id: UUID,
+    rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
+) -> None:
+    """
+    Remove privilege from a role.
+
+    Required privilege: Role.Modify
+    """
+
+    privilege = await rbac_repo.get_privilege(privilege_id)
+    if not privilege:
+        raise ControllerNotFoundError(f"Privilege '{privilege_id}' not found")
+
+    role = await rbac_repo.remove_privilege_from_role(role_id, privilege)
+    if not role:
+        raise ControllerNotFoundError(f"Role '{role_id}' not found")

gns3server/api/routes/controller/snapshots.py

@@ -0,0 +1,124 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for snapshots.
+"""
+
+import logging
+
+log = logging.getLogger()
+
+from fastapi import APIRouter, Depends, status
+from typing import List
+from uuid import UUID
+
+from gns3server.controller.project import Project
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server import schemas
+from gns3server.controller import Controller
+
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or snapshot"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_project(project_id: UUID) -> Project:
+    """
+    Dependency to retrieve a project.
+    """
+
+    project = Controller.instance().get_project(str(project_id))
+    return project
+
+
+@router.post(
+    "",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Snapshot,
+    dependencies=[Depends(has_privilege("Snapshot.Allocate"))]
+)
+async def create_snapshot(
+        snapshot_data: schemas.SnapshotCreate,
+        project: Project = Depends(dep_project)
+) -> schemas.Snapshot:
+    """
+    Create a new snapshot of a project.
+
+    Required privilege: Snapshot.Allocate
+    """
+
+    snapshot = await project.snapshot(snapshot_data.name)
+    return snapshot.asdict()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Snapshot],
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Snapshot.Audit"))]
+)
+def get_snapshots(project: Project = Depends(dep_project)) -> List[schemas.Snapshot]:
+    """
+    Return all snapshots belonging to a given project.
+
+    Required privilege: Snapshot.Audit
+    """
+
+    snapshots = [s for s in project.snapshots.values()]
+    return [s.asdict() for s in sorted(snapshots, key=lambda s: (s.created_at, s.name))]
+
+
+@router.delete(
+    "/{snapshot_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Snapshot.Allocate"))]
+)
+async def delete_snapshot(
+        snapshot_id: UUID,
+        project: Project = Depends(dep_project),
+        rbac_repo=Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a snapshot.
+
+    Required privilege: Snapshot.Allocate
+    """
+
+    await project.delete_snapshot(str(snapshot_id))
+    await rbac_repo.delete_all_ace_starting_with_path(f"/projects/{project.id}/snapshots/{snapshot_id}")
+
+
+@router.post(
+    "/{snapshot_id}/restore",
+    status_code=status.HTTP_201_CREATED,
+    response_model=schemas.Project,
+    dependencies=[Depends(has_privilege("Snapshot.Restore"))]
+)
+async def restore_snapshot(snapshot_id: UUID, project: Project = Depends(dep_project)) -> schemas.Project:
+    """
+    Restore a snapshot.
+
+    Required privilege: Snapshot.Restore
+    """
+
+    snapshot = project.get_snapshot(str(snapshot_id))
+    project = await snapshot.restore()
+    return project.asdict()

gns3server/api/routes/controller/symbols.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for symbols.
+"""
+
+import os
+
+from fastapi import APIRouter, Request, Depends, Response, status
+from fastapi.responses import FileResponse
+from typing import List
+
+from gns3server.controller import Controller
+from gns3server import schemas
+from gns3server.controller.controller_error import ControllerError, ControllerNotFoundError
+
+from .dependencies.rbac import has_privilege
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+router = APIRouter()
+
+
+@router.get(
+    "",
+    dependencies=[Depends(has_privilege("Symbol.Audit"))]
+)
+def get_symbols() -> List[dict]:
+    """
+    Return all symbols.
+
+    Required privilege: Symbol.Audit
+    """
+
+    controller = Controller.instance()
+    return controller.symbols.list()
+
+
+@router.get(
+    "/{symbol_id:path}/raw",
+    responses={404: {"model": schemas.ErrorMessage, "description": "Could not find symbol"}},
+    # FIXME: this is a temporary workaround due to a bug in the web-ui: https://github.com/GNS3/gns3-web-ui/issues/1466
+    # dependencies=[Depends(has_privilege("Symbol.Audit"))]
+)
+async def get_symbol(symbol_id: str) -> FileResponse:
+    """
+    Download a symbol file.
+
+    Required privilege: Symbol.Audit
+    """
+
+    controller = Controller.instance()
+    try:
+        symbol = controller.symbols.get_path(symbol_id)
+        return FileResponse(symbol)
+    except (KeyError, OSError) as e:
+        raise ControllerNotFoundError(f"Could not get symbol file: {e}")
+
+
+@router.get(
+    "/{symbol_id:path}/dimensions",
+    responses={404: {"model": schemas.ErrorMessage, "description": "Could not find symbol"}},
+    dependencies=[Depends(has_privilege("Symbol.Audit"))]
+)
+async def get_symbol_dimensions(symbol_id: str) -> dict:
+    """
+    Get a symbol dimensions.
+
+    Required privilege: Symbol.Audit
+    """
+
+    controller = Controller.instance()
+    try:
+        width, height, _ = controller.symbols.get_size(symbol_id)
+        symbol_dimensions = {"width": width, "height": height}
+        return symbol_dimensions
+    except (KeyError, OSError, ValueError) as e:
+        raise ControllerNotFoundError(f"Could not get symbol file: {e}")
+
+
+@router.get("/default_symbols", dependencies=[Depends(has_privilege("Symbol.Audit"))])
+def get_default_symbols() -> dict:
+    """
+    Return all default symbols.
+
+    Required privilege: Symbol.Audit
+    """
+
+    controller = Controller.instance()
+    return controller.symbols.default_symbols()
+
+
+@router.post(
+    "/{symbol_id:path}/raw",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Symbol.Allocate"))]
+)
+async def upload_symbol(symbol_id: str, request: Request) -> None:
+    """
+    Upload a symbol file.
+
+    Required privilege: Symbol.Allocate
+    """
+
+    controller = Controller.instance()
+    path = os.path.join(controller.symbols.symbols_path(), os.path.basename(symbol_id))
+
+    try:
+        with open(path, "wb") as f:
+            f.write(await request.body())
+    except (UnicodeEncodeError, OSError) as e:
+        raise ControllerError(f"Could not write symbol file '{path}': {e}")
+
+    # Reset the symbol list
+    controller.symbols.list()

gns3server/api/routes/controller/templates.py

@@ -0,0 +1,192 @@
+#
+# Copyright (C) 2021 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for templates.
+"""
+
+import hashlib
+import json
+
+import logging
+
+log = logging.getLogger(__name__)
+
+from fastapi import APIRouter, Request, HTTPException, Depends, Response, status
+from typing import List, Optional
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.db.repositories.templates import TemplatesRepository
+from gns3server.services.templates import TemplatesService
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.db.repositories.images import ImagesRepository
+
+from .dependencies.authentication import get_current_active_user
+from .dependencies.rbac import has_privilege
+from .dependencies.database import get_repository
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find template"}}
+
+router = APIRouter(responses=responses)
+
+
+@router.post(
+    "",
+    response_model=schemas.Template,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Template.Allocate"))]
+)
+async def create_template(
+    template_create: schemas.TemplateCreate,
+    templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository))
+) -> schemas.Template:
+    """
+    Create a new template.
+
+    Required privilege: Template.Allocate
+    """
+
+    template = await TemplatesService(templates_repo).create_template(template_create)
+    return template
+
+
+@router.get(
+    "/{template_id}",
+    response_model=schemas.Template,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(get_current_active_user)],
+    #dependencies=[Depends(has_privilege("Template.Audit"))]  # FIXME: this is a temporary workaround due to a bug in the web-ui
+)
+async def get_template(
+    template_id: UUID,
+    request: Request,
+    response: Response,
+    templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+) -> schemas.Template:
+    """
+    Return a template.
+
+    Required privilege: Template.Audit
+    """
+
+    request_etag = request.headers.get("If-None-Match", "")
+    template = await TemplatesService(templates_repo).get_template(template_id)
+    data = json.dumps(template)
+    template_etag = '"' + hashlib.md5(data.encode()).hexdigest() + '"'
+    if template_etag == request_etag:
+        raise HTTPException(status_code=status.HTTP_304_NOT_MODIFIED)
+    else:
+        response.headers["ETag"] = template_etag
+        return template
+
+
+@router.put(
+    "/{template_id}",
+    response_model=schemas.Template,
+    response_model_exclude_unset=True,
+    dependencies=[Depends(has_privilege("Template.Modify"))]
+)
+async def update_template(
+    template_id: UUID,
+    template_update: schemas.TemplateUpdate,
+    templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+) -> schemas.Template:
+    """
+    Update a template.
+
+    Required privilege: Template.Modify
+    """
+
+    return await TemplatesService(templates_repo).update_template(template_id, template_update)
+
+
+@router.delete(
+    "/{template_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("Template.Allocate"))]
+)
+async def delete_template(
+        template_id: UUID,
+        prune_images: Optional[bool] = False,
+        templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+        images_repo: RbacRepository = Depends(get_repository(ImagesRepository)),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a template.
+
+    Required privilege: Template.Allocate
+    """
+
+    await TemplatesService(templates_repo).delete_template(template_id)
+    await rbac_repo.delete_all_ace_starting_with_path(f"/templates/{template_id}")
+    if prune_images:
+        await images_repo.prune_images()
+
+
+@router.get(
+    "",
+    response_model=List[schemas.Template],
+    response_model_exclude_unset=True,
+    dependencies=[Depends(get_current_active_user)],
+    #dependencies=[Depends(has_privilege("Template.Audit"))]  # FIXME: this is a temporary workaround due to a bug in the web-ui
+)
+async def get_templates(
+        templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
+        current_user: schemas.User = Depends(get_current_active_user),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> List[schemas.Template]:
+    """
+    Return all templates.
+
+    Required privilege: Template.Audit
+    """
+
+    templates = await TemplatesService(templates_repo).get_templates()
+    if current_user.is_superadmin:
+        return templates
+    else:
+        user_templates = []
+        for template in templates:
+            # if template.get("builtin") is True:
+            #     user_templates.append(template)
+            #     continue
+            # template_id = template.get("template_id")
+            # authorized = await rbac_repo.check_user_is_authorized(
+            #     current_user.user_id, "GET", f"/templates/{template_id}")
+            # if authorized:
+            user_templates.append(template)
+    return user_templates
+
+
+@router.post(
+    "/{template_id}/duplicate",
+    response_model=schemas.Template,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("Template.Allocate"))]
+)
+async def duplicate_template(
+        template_id: UUID, templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository))
+) -> schemas.Template:
+    """
+    Duplicate a template.
+
+    Required privilege: Template.Allocate
+    """
+
+    template = await TemplatesService(templates_repo).duplicate_template(template_id)
+    return template

gns3server/api/routes/controller/users.py

@@ -0,0 +1,254 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2023 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for users.
+"""
+
+from fastapi import APIRouter, Depends, HTTPException, Response, status
+from fastapi.security import OAuth2PasswordRequestForm
+from uuid import UUID
+from typing import List
+
+from gns3server import schemas
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerBadRequestError,
+    ControllerNotFoundError,
+    ControllerForbiddenError,
+)
+
+from gns3server.db.repositories.users import UsersRepository
+from gns3server.db.repositories.rbac import RbacRepository
+from gns3server.services import auth_service
+
+from .dependencies.authentication import get_current_active_user
+from .dependencies.database import get_repository
+from .dependencies.rbac import has_privilege
+
+import logging
+
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.post("/login", response_model=schemas.Token)
+async def login(
+    users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+    form_data: OAuth2PasswordRequestForm = Depends(),
+) -> schemas.Token:
+    """
+    Default user login method using forms (x-www-form-urlencoded).
+    Example: curl -X POST http://host:port/v3/access/users/login -H "Content-Type: application/x-www-form-urlencoded" -d "username=admin&password=admin"
+    """
+
+    user = await users_repo.authenticate_user(username=form_data.username, password=form_data.password)
+    if not user:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Authentication was unsuccessful.",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+
+    token = schemas.Token(access_token=auth_service.create_access_token(user.username), token_type="bearer")
+    return token
+
+
+@router.post("/authenticate", response_model=schemas.Token)
+async def authenticate(
+    user_credentials: schemas.Credentials,
+    users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+) -> schemas.Token:
+    """
+    Alternative authentication method using json.
+    Example: curl -X POST http://host:port/v3/access/users/authenticate -d '{"username": "admin", "password": "admin"}' -H "Content-Type: application/json"
+    """
+
+    user = await users_repo.authenticate_user(username=user_credentials.username, password=user_credentials.password)
+    if not user:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Authentication was unsuccessful.",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+
+    token = schemas.Token(access_token=auth_service.create_access_token(user.username), token_type="bearer")
+    return token
+
+
+@router.get("/me", response_model=schemas.User)
+async def get_logged_in_user(current_user: schemas.User = Depends(get_current_active_user)) -> schemas.User:
+    """
+    Get the current active user.
+    """
+
+    return current_user
+
+
+@router.put("/me", response_model=schemas.User)
+async def update_logged_in_user(
+        user_update: schemas.LoggedInUserUpdate,
+        current_user: schemas.User = Depends(get_current_active_user),
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
+    """
+    Update the current active user.
+    """
+
+    if user_update.email and await users_repo.get_user_by_email(user_update.email):
+        raise ControllerBadRequestError(f"Email '{user_update.email}' is already registered")
+
+    return await users_repo.update_user(current_user.user_id, user_update)
+
+
+@router.get(
+    "",
+    response_model=List[schemas.User],
+    dependencies=[Depends(has_privilege("User.Audit"))]
+)
+async def get_users(
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> List[schemas.User]:
+    """
+    Get all users.
+
+    Required privilege: User.Audit
+    """
+
+    return await users_repo.get_users()
+
+
+@router.post(
+    "",
+    response_model=schemas.User,
+    status_code=status.HTTP_201_CREATED,
+    dependencies=[Depends(has_privilege("User.Allocate"))]
+)
+async def create_user(
+        user_create: schemas.UserCreate,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
+    """
+    Create a new user.
+
+    Required privilege: User.Allocate
+    """
+
+    if await users_repo.get_user_by_username(user_create.username):
+        raise ControllerBadRequestError(f"Username '{user_create.username}' is already registered")
+
+    if user_create.email and await users_repo.get_user_by_email(user_create.email):
+        raise ControllerBadRequestError(f"Email '{user_create.email}' is already registered")
+
+    return await users_repo.create_user(user_create)
+
+
+@router.get(
+    "/{user_id}",
+    response_model=schemas.User,
+    dependencies=[Depends(has_privilege("User.Audit"))]
+)
+async def get_user(
+        user_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+) -> schemas.User:
+    """
+    Get a user.
+
+    Required privilege: User.Audit
+    """
+
+    user = await users_repo.get_user(user_id)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+    return user
+
+
+@router.put(
+    "/{user_id}",
+    response_model=schemas.User,
+    dependencies=[Depends(has_privilege("User.Modify"))]
+)
+async def update_user(
+        user_id: UUID,
+        user_update: schemas.UserUpdate,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
+    """
+    Update a user.
+
+    Required privilege: User.Modify
+    """
+
+    if user_update.username and await users_repo.get_user_by_username(user_update.username):
+        raise ControllerBadRequestError(f"Username '{user_update.username}' is already registered")
+
+    if user_update.email and await users_repo.get_user_by_email(user_update.email):
+        raise ControllerBadRequestError(f"Email '{user_update.email}' is already registered")
+
+    user = await users_repo.update_user(user_id, user_update)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+    return user
+
+
+@router.delete(
+    "/{user_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    dependencies=[Depends(has_privilege("User.Allocate"))]
+)
+async def delete_user(
+        user_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+        rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
+) -> None:
+    """
+    Delete a user.
+
+    Required privilege: User.Allocate
+    """
+
+    user = await users_repo.get_user(user_id)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+
+    if user.is_superadmin:
+        raise ControllerForbiddenError("The super admin cannot be deleted")
+
+    success = await users_repo.delete_user(user_id)
+    if not success:
+        raise ControllerError(f"User '{user_id}' could not be deleted")
+    await rbac_repo.delete_all_ace_starting_with_path(f"/users/{user_id}")
+
+
+@router.get(
+    "/{user_id}/groups",
+    response_model=List[schemas.UserGroup],
+    dependencies=[Depends(has_privilege("Group.Audit"))]
+)
+async def get_user_memberships(
+        user_id: UUID,
+        users_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> List[schemas.UserGroup]:
+    """
+    Get user memberships.
+
+    Required privilege: Group.Audit
+    """
+
+    return await users_repo.get_user_memberships(user_id)

gns3server/api/routes/index.py

@@ -0,0 +1,93 @@
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+from fastapi import APIRouter, Request, HTTPException, status
+from fastapi.responses import RedirectResponse, HTMLResponse, FileResponse
+from fastapi.templating import Jinja2Templates
+
+from gns3server.version import __version__
+from gns3server.utils.get_resource import get_resource
+
+router = APIRouter()
+templates = Jinja2Templates(directory=os.path.join("gns3server", "templates"))
+
+
+@router.get("/")
+async def root():
+
+    return RedirectResponse("/static/web-ui/bundled", status_code=308)  # permanent redirect
+
+
+@router.get("/debug", response_class=HTMLResponse, deprecated=True)
+def debug(request: Request):
+
+    kwargs = {"request": request, "gns3_version": __version__, "gns3_host": request.client.host}
+    return templates.TemplateResponse("index.html", kwargs)
+
+
+@router.get("/static/web-ui/{file_path:path}", description="Web user interface")
+async def web_ui(file_path: str):
+
+    file_path = os.path.normpath(file_path).strip("/")
+    file_path = os.path.join("static", "web-ui", file_path)
+
+    # Raise error if user try to escape
+    if file_path[0] == ".":
+        raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
+
+    static = get_resource(file_path)
+
+    if static is None or not os.path.exists(static):
+        static = get_resource(os.path.join("static", "web-ui", "index.html"))
+
+    if static is None:
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    # guesstype prefers to have text/html type than application/javascript
+    # which results with warnings in Firefox 66 on Windows
+    # Ref. gns3-server#1559
+    _, ext = os.path.splitext(static)
+    mimetype = ext == ".js" and "application/javascript" or None
+    return FileResponse(static, media_type=mimetype)
+
+
+# class Version(BaseModel):
+#     version: str
+#     local: Optional[bool] = False
+#
+#
+# @router.get("/v2/version",
+#             description="Retrieve the server version number",
+#             response_model=Version,
+# )
+# def version():
+#
+#     config = Config.instance()
+#     local_server = config.get_section_config("Server").getboolean("local", False)
+#     return {"version": __version__, "local": local_server}
+#
+#
+# @router.post("/v2/version",
+#             description="Check if version is the same as the server",
+#             response_model=Version,
+# )
+# def check_version(version: str):
+#
+#     if version != __version__:
+#         raise HTTPException(status_code=409, detail="Client version {} is not the same as server version {}".format(version, __version__))
+#     return {"version": __version__}

gns3server/api/server.py

@@ -0,0 +1,189 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+FastAPI app
+"""
+
+import time
+
+from fastapi import FastAPI, Request, HTTPException, status
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from fastapi.exceptions import RequestValidationError
+from sqlalchemy.exc import SQLAlchemyError
+from uvicorn.main import Server as UvicornServer
+
+from gns3server.controller.controller_error import (
+    ControllerError,
+    ControllerNotFoundError,
+    ControllerBadRequestError,
+    ControllerTimeoutError,
+    ControllerForbiddenError,
+    ControllerUnauthorizedError,
+    ComputeConflictError
+)
+
+from gns3server.api.routes import controller, index
+from gns3server.api.routes.compute import compute_api
+from gns3server.core import tasks
+from gns3server.version import __version__
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def get_application() -> FastAPI:
+
+    application = FastAPI(
+        title="GNS3 controller API", description="This page describes the public controller API for GNS3", version="v3"
+    )
+
+    application.add_middleware(
+        CORSMiddleware,
+        allow_origin_regex=r"http(s)?://(localhost|127.0.0.1)(:\d+)?",
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+    application.add_event_handler("startup", tasks.create_startup_handler(application))
+    application.add_event_handler("shutdown", tasks.create_shutdown_handler(application))
+    application.include_router(index.router, tags=["Index"])
+    application.include_router(controller.router, prefix="/v3")
+    application.mount("/v3/compute", compute_api, name="compute")
+
+    return application
+
+
+app = get_application()
+
+# Monkey Patch uvicorn signal handler to detect the application is shutting down
+app.state.exiting = False
+unicorn_exit_handler = UvicornServer.handle_exit
+
+
+def handle_exit(*args, **kwargs):
+    app.state.exiting = True
+    unicorn_exit_handler(*args, **kwargs)
+
+
+UvicornServer.handle_exit = handle_exit
+
+
+@app.exception_handler(ControllerError)
+async def controller_error_handler(request: Request, exc: ControllerError):
+    log.error(f"Controller error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_409_CONFLICT,
+        content={"message": str(exc)},
+    )
+
+
+@app.exception_handler(ControllerTimeoutError)
+async def controller_timeout_error_handler(request: Request, exc: ControllerTimeoutError):
+    log.error(f"Controller timeout error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_408_REQUEST_TIMEOUT,
+        content={"message": str(exc)},
+    )
+
+
+@app.exception_handler(ControllerUnauthorizedError)
+async def controller_unauthorized_error_handler(request: Request, exc: ControllerUnauthorizedError):
+    log.error(f"Controller unauthorized error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        content={"message": str(exc)},
+    )
+
+
+@app.exception_handler(ControllerForbiddenError)
+async def controller_forbidden_error_handler(request: Request, exc: ControllerForbiddenError):
+    log.error(f"Controller forbidden error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_403_FORBIDDEN,
+        content={"message": str(exc)},
+    )
+
+
+@app.exception_handler(ControllerNotFoundError)
+async def controller_not_found_error_handler(request: Request, exc: ControllerNotFoundError):
+    log.error(f"Controller not found error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_404_NOT_FOUND,
+        content={"message": str(exc)},
+    )
+
+
+@app.exception_handler(ControllerBadRequestError)
+async def controller_bad_request_error_handler(request: Request, exc: ControllerBadRequestError):
+    log.error(f"Controller bad request error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_400_BAD_REQUEST,
+        content={"message": str(exc)},
+    )
+
+
+@app.exception_handler(ComputeConflictError)
+async def compute_conflict_error_handler(request: Request, exc: ComputeConflictError):
+    log.error(f"Controller received error from compute for request '{exc.url()}': {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_409_CONFLICT,
+        content={"message": str(exc)},
+    )
+
+
+# make sure the content key is "message", not "detail" per default
+@app.exception_handler(HTTPException)
+async def http_exception_handler(request: Request, exc: HTTPException):
+    return JSONResponse(
+        status_code=exc.status_code,
+        content={"message": exc.detail},
+        headers=exc.headers
+    )
+
+
+@app.exception_handler(SQLAlchemyError)
+async def sqlalchemry_error_handler(request: Request, exc: SQLAlchemyError):
+    log.error(f"Controller database error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+        content={"message": "Database error detected, please check logs to find details"},
+    )
+
+
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(request: Request, exc: RequestValidationError):
+    log.error(f"Request validation error in {request.url.path} ({request.method}): {exc}")
+    return JSONResponse(
+        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+        content={"message": str(exc)}
+    )
+
+# FIXME: do not use this middleware since it creates issue when using StreamingResponse
+# see https://starlette-context.readthedocs.io/en/latest/middleware.html#why-are-there-two-middlewares-that-do-the-same-thing
+
+# @app.middleware("http")
+# async def add_extra_headers(request: Request, call_next):
+#     start_time = time.time()
+#     response = await call_next(request)
+#     process_time = time.time() - start_time
+#     response.headers["X-Process-Time"] = str(process_time)
+#     response.headers["X-GNS3-Server-Version"] = f"{__version__}"
+#     return response

gns3server/appliances/6wind-turbo-router.gns3a

@@ -0,0 +1,47 @@
+{
+    "appliance_id": "bf0a4dd0-9e1f-491e-918a-1d1ac0e23161",
+    "name": "6WIND Turbo Router",
+    "category": "router",
+    "description": "6WIND Turbo Router is a high performance, ready-to-use software virtual router. It can be deployed bare metal or in virtual machines on commercial-off-the-shelf (COTS) servers. It is a carrier-grade solution for Service Prodivers aiming at using white boxes to deploy network functions. Typical use-cases are transit/peering router, IPsec VPN gateway and CGNAT.",
+    "vendor_name": "6WIND",
+    "vendor_url": "https://www.6wind.com/",
+    "documentation_url": "https://doc.6wind.com/turbo-router-3/latest/turbo-router/",
+    "product_name": "6WIND Turbo Router",
+    "product_url": "https://www.6wind.com/vrouter-solutions/turbo-router/",
+    "registry_version": 4,
+    "status": "stable",
+    "maintainer": "GNS3 Team",
+    "maintainer_email": "developers@gns3.net",
+    "usage": "Default username / password is admin / admin.",
+    "symbol": "6wind.svg",
+    "port_name_format": "eth{0}",
+    "qemu": {
+        "adapter_type": "virtio-net-pci",
+        "adapters": 8,
+        "ram": 4096,
+        "cpus": 4,
+        "hda_disk_interface": "virtio",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "boot_priority": "c",
+        "kvm": "require",
+        "options": "-cpu host"
+    },
+    "images": [
+        {
+            "filename": "6wind-vrouter-tr-ae-x86_64-v3.1.4.m1.qcow2",
+            "version": "3.1.4.m1",
+            "md5sum": "bc84b81fba4f2f01eda6a338469e37a5",
+            "filesize": 693829632,
+            "download_url": "https://portal.6wind.com/register.php?utm_campaign=GNS3-2021-EVAL"
+        }
+    ],
+    "versions": [
+        {
+            "name": "3.1.4.m1",
+            "images": {
+                "hda_disk_image": "6wind-vrouter-tr-ae-x86_64-v3.1.4.m1.qcow2"
+            }
+        }
+    ]
+}

gns3server/appliances/IPCop.gns3a

@@ -0,0 +1,52 @@
+{
+    "appliance_id": "c30ea423-b6f8-443e-b599-955ea5647ef0",
+    "name": "IP Cop",
+    "category": "firewall",
+    "description": "The IPCop Firewall is a Linux firewall distribution. It is geared towards home and SOHO users. The IPCop web-interface is very user-friendly and makes usage easy.",
+    "vendor_name": "IP Cop",
+    "vendor_url": "https://www.kali.org/",
+    "documentation_url": "http://www.ipcop.org/docs.html",
+    "product_name": "IP Cop",
+    "registry_version": 4,
+    "status": "stable",
+    "maintainer": "Brent Stewart",
+    "maintainer_email": "brent@stewart.tc",
+    "usage": "",
+    "symbol": "shieldedtux.png",
+    "port_name_format": "eth{0}",
+    "qemu": {
+        "adapter_type": "e1000",
+        "adapters": 3,
+        "ram": 1024,
+        "arch": "x86_64",
+        "console_type": "vnc",
+        "kvm": "require"
+    },
+    "images": [
+        {
+            "filename": "ipcop-2.1.8-install-cd.i486.iso",
+            "version": "2.1.9",
+            "md5sum": "1394a7bd4e5c6fe8db70007278826101",
+            "filesize": 65011712,
+            "download_url": "http://www.ipcop.org/download.html",
+            "direct_download_url": "https://sourceforge.net/projects/ipcop/files/IPCop/IPCop%202.1.8/ipcop-2.1.8-install-cd.i486.iso"
+        },
+        {
+            "filename": "empty8G.qcow2",
+            "version": "1.0",
+            "md5sum": "f1d2c25b6990f99bd05b433ab603bdb4",
+            "filesize": 197120,
+            "download_url": "https://sourceforge.net/projects/gns-3/files/Empty%20Qemu%20disk/",
+            "direct_download_url": "https://sourceforge.net/projects/gns-3/files/Empty%20Qemu%20disk/empty8G.qcow2/download"
+        }
+    ],
+    "versions": [
+        {
+            "name": "2.1.9",
+            "images": {
+                "hda_disk_image": "empty8G.qcow2",
+                "cdrom_image": "ipcop-2.1.8-install-cd.i486.iso"
+            }
+        }
+    ]
+}

gns3server/appliances/a10-vthunder.gns3a

@@ -0,0 +1,72 @@
+{
+    "appliance_id": "7aa41b5b-3ae9-40a7-be38-5c109c59e086",
+    "name": "A10 vThunder",
+    "category": "router",
+    "description": "vThunder, part of A10 Networks' award-winning A10 Thunder and AX Series Application Delivery Controller (ADC) family, is designed to meet the growing needs of organizations that require a flexible and easy-to-deploy application delivery and server load balancer solution running within a virtualized infrastructure.",
+    "vendor_name": "A10",
+    "vendor_url": "https://www.a10networks.com/",
+    "documentation_url": "https://www.a10networks.com/support",
+    "product_name": "A10 vThunder",
+    "product_url": "https://www.a10networks.com/products/vthunder-trial/",
+    "registry_version": 4,
+    "status": "stable",
+    "maintainer": "GNS3 Team",
+    "maintainer_email": "developers@gns3.net",
+    "usage": "Default credentials:\n- CLI: admin / a10.\n- Enable mode: <none>\n\nDefault management IP: 172.31.31.31/24",
+    "symbol": "loadbalancer.svg",
+    "first_port_name": "mgmt",
+    "port_name_format": "ethernet {port1}",
+    "qemu": {
+        "adapter_type": "virtio-net-pci",
+        "adapters": 4,
+        "ram": 4096,
+        "hda_disk_interface": "virtio",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "boot_priority": "cd",
+        "kvm": "require"
+    },
+    "images": [
+        {
+            "filename": "vThunder_410_P9.qcow2",
+            "version": "4.1.0.P9",
+            "md5sum": "6ef0f69ba7a099a7f43b5815c2abc691",
+            "filesize": 6311706624,
+            "download_url": "https://www.a10networks.com/vthunder-embed"
+        },
+        {
+            "filename": "vThunder_410_P3.qcow2",
+            "version": "4.1.0.P3",
+            "md5sum": "daacefa4e0eb1cad9b253926624be4b9",
+            "filesize": 6098780160,
+            "download_url": "https://www.a10networks.com/vthunder-embed"
+        },
+        {
+            "filename": "vth401.GA.12G_Disk.qcow2",
+            "version": "4.0.1",
+            "md5sum": "311806ad414403359216da6119ddb823",
+            "filesize": 4768464896,
+            "download_url": "https://www.a10networks.com/vthunder-embed"
+        }
+    ],
+    "versions": [
+        {
+            "name": "4.1.0.P9",
+            "images": {
+                "hda_disk_image": "vThunder_410_P9.qcow2"
+            }
+        },
+        {
+            "name": "4.1.0.P3",
+            "images": {
+                "hda_disk_image": "vThunder_410_P3.qcow2"
+            }
+        },
+        {
+            "name": "4.0.1",
+            "images": {
+                "hda_disk_image": "vth401.GA.12G_Disk.qcow2"
+            }
+        }
+    ]
+}

gns3server/appliances/aaa.gns3a

@@ -0,0 +1,20 @@
+{
+    "appliance_id": "99920801-829d-4689-8231-7183c21ff878",
+    "name": "AAA",
+    "category": "guest",
+    "description": "This appliance provides RADIUS and TACACS+ services with preconfigured users and groups.",
+    "vendor_name": "Ubuntu",
+    "vendor_url": "https://www.ubuntu.com/",
+    "product_name": "AAA",
+    "registry_version": 4,
+    "status": "stable",
+    "maintainer": "Andras Dosztal",
+    "maintainer_email": "developers@gns3.net",
+    "usage": "RADIUS users:\n- alice\n- bob\n\nTACACS+ users:\n- gns3 (role: admin)\n- readonly\n\nAll users, as well as the RADIUS/TACACS+ clients have the password 'gns3' set.",
+    "symbol": "linux_guest.svg",
+    "docker": {
+        "adapters": 1,
+        "image": "adosztal/aaa:latest",
+        "console_type": "telnet"
+    }
+}

gns3server/appliances/alcatel-7750.gns3a

@@ -0,0 +1,74 @@
+{
+    "appliance_id": "4d06be08-ce6d-4ee7-b5a7-79729fa75489",
+    "name": "Alcatel 7750",
+    "category": "router",
+    "description": "The Alcatel-Lucent 7750 Service Router (SR) portfolio is a suite of multiservice edge routing platforms that deliver high performance, service richness, and creates exceptional value for networking in the cloud era. It is designed for the concurrent delivery of advanced residential, business and wireless broadband IP services, and provides cloud, data center and branch office connectivity for enterprise networking on a common IP edge routing platform.",
+    "vendor_name": "Alcatel",
+    "vendor_url": "https://www.alcatel-lucent.com/",
+    "documentation_url": "https://www.alcatel-lucent.com/support",
+    "product_name": "Alcatel 7750",
+    "product_url": "https://www.alcatel-lucent.com/products/7750-service-router",
+    "registry_version": 4,
+    "status": "experimental",
+    "maintainer": "GNS3 Team",
+    "maintainer_email": "developers@gns3.net",
+    "usage": "Login is admin and password is admin",
+    "first_port_name": "A/1",
+    "port_name_format": "1/1/{port1}",
+    "qemu": {
+        "adapter_type": "e1000",
+        "adapters": 6,
+        "ram": 2048,
+        "hda_disk_interface": "ide",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "kvm": "require",
+        "options": ""
+    },
+    "images": [
+        {
+            "filename": "TiMOS-SR-13.0.R4-vm.qcow2",
+            "version": "13.0.R4",
+            "md5sum": "d7a3609e506acdcb55f6db5328dba8ed",
+            "filesize": 368508928,
+            "download_url": "https://www.alcatel-lucent.com/support",
+            "compression": "zip"
+        },
+        {
+            "filename": "TiMOS-SR-12.0.R6-vm.qcow2",
+            "version": "12.0.R6",
+            "md5sum": "7d84d97a5664af2e3546bfa832fc1848",
+            "filesize": 221511680,
+            "download_url": "https://www.alcatel-lucent.com/support",
+            "compression": "zip"
+        },
+        {
+            "filename": "TiMOS-SR-12.0.R18.qcow2",
+            "version": "12.0.R18",
+            "md5sum": "d0bba5feaaf09fd02185f25898a6afc7",
+            "filesize": 223870976,
+            "download_url": "https://www.alcatel-lucent.com/support",
+            "compression": "zip"
+        }
+    ],
+    "versions": [
+        {
+            "name": "13.0.R4",
+            "images": {
+                "hda_disk_image": "TiMOS-SR-13.0.R4-vm.qcow2"
+            }
+        },
+        {
+            "name": "12.0.R6",
+            "images": {
+                "hda_disk_image": "TiMOS-SR-12.0.R6-vm.qcow2"
+            }
+        },
+        {
+            "name": "12.0.R18",
+            "images": {
+                "hda_disk_image": "TiMOS-SR-12.0.R18.qcow2"
+            }
+        }
+    ]
+}

gns3server/appliances/almalinux.gns3a

@@ -0,0 +1,84 @@
+{
+    "appliance_id": "5c09a704-0e38-48ac-8392-52e0c5890cf3",
+    "name": "AlmaLinux",
+    "category": "guest",
+    "description": "An Open Source, community-governed and forever-free enterprise Linux distribution, focused on long-term stability, providing a robust production-grade platform. AlmaLinux OS is 1:1 binary compatible with RHEL and pre-Stream CentOS.",
+    "vendor_name": "Alma Linux",
+    "vendor_url": "https://almalinux.org/",
+    "documentation_url": "https://wiki.almalinux.org/",
+    "product_name": "Alma Linux",
+    "product_url": "https://almalinux.org/",
+    "registry_version": 4,
+    "status": "stable",
+    "maintainer": "Da-Geek",
+    "maintainer_email": "dageek@dageeks-geeks.gg",
+    "usage": "Username:\talmalinux\nPassword:\talmalinux\nTo become root, use \"sudo -i\".\n",
+    "port_name_format": "eth{0}",
+    "qemu": {
+        "adapter_type": "virtio-net-pci",
+        "adapters": 1,
+        "ram": 1536,
+        "hda_disk_interface": "sata",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "kvm": "allow",
+        "options": "-cpu host -nographic"
+    },
+    "images": [
+        {
+            "filename": "AlmaLinux-9-GenericCloud-9.2-20230513.x86_64.qcow2",
+            "version": "9.2",
+            "md5sum": "c5bc76e8c95ac9f810a3482c80a54cc7",
+            "filesize": 563347456,
+            "download_url": "https://vault.almalinux.org/9.2/cloud/x86_64/images/",
+            "direct_download_url": "https://vault.almalinux.org/9.2/cloud/x86_64/images/AlmaLinux-9-GenericCloud-9.2-20230513.x86_64.qcow2"
+        },
+        {
+            "filename": "AlmaLinux-8-GenericCloud-8.8-20230524.x86_64.qcow2",
+            "version": "8.8",
+            "md5sum": "3958c5fc25770ef63cf97aa5d93f0a0b",
+            "filesize": 565444608,
+            "download_url": "https://vault.almalinux.org/8.8/cloud/x86_64/images/",
+            "direct_download_url": "https://vault.almalinux.org/8.8/cloud/x86_64/images/AlmaLinux-8-GenericCloud-8.8-20230524.x86_64.qcow2"
+        },
+        {
+            "filename": "AlmaLinux-8-GenericCloud-8.7-20221111.x86_64.qcow2",
+            "version": "8.7",
+            "md5sum": "b2b8c7fd3b6869362f3f8ed47549c804",
+            "filesize": 566231040,
+            "download_url": "https://vault.almalinux.org/8.7/cloud/x86_64/images/",
+            "direct_download_url": "https://vault.almalinux.org/8.7/cloud/x86_64/images/AlmaLinux-8-GenericCloud-8.7-20221111.x86_64.qcow2"
+        },
+        {
+            "filename": "almalinux-cloud-init-data.iso",
+            "version": "1.0",
+            "md5sum": "72fb52af76e9561d125dd99224e2c1d1",
+            "filesize": 374784,
+            "download_url": "https://github.com/GNS3/gns3-registry/tree/master/cloud-init/AlmaLinux",
+            "direct_download_url": "https://github.com/GNS3/gns3-registry/raw/master/cloud-init/AlmaLinux/almalinux-cloud-init-data.iso"
+        }
+    ],
+    "versions": [
+        {
+            "name": "9.2",
+            "images": {
+                "hda_disk_image": "AlmaLinux-9-GenericCloud-9.2-20230513.x86_64.qcow2",
+                "cdrom_image": "almalinux-cloud-init-data.iso"
+            }
+        },
+        {
+            "name": "8.8",
+            "images": {
+                "hda_disk_image": "AlmaLinux-8-GenericCloud-8.8-20230524.x86_64.qcow2",
+                "cdrom_image": "almalinux-cloud-init-data.iso"
+            }
+        },
+        {
+            "name": "8.7",
+            "images": {
+                "hda_disk_image": "AlmaLinux-8-GenericCloud-8.7-20221111.x86_64.qcow2",
+                "cdrom_image": "almalinux-cloud-init-data.iso"
+            }
+        }
+    ]
+}

gns3server/appliances/alpine-linux-virt.gns3a

@@ -0,0 +1,59 @@
+{
+    "appliance_id": "3da5c614-772c-4963-af86-f24e058c9216",
+    "name": "Alpine Linux Virt",
+    "category": "guest",
+    "description": "Alpine Linux is a security-oriented, lightweight Linux distribution based on musl libc and busybox.\n\nThis is the qemu version of Alpine Linux, stripped down to the maximum, only the default packages are installed without an SSH server.",
+    "vendor_name": "Alpine Linux Development Team",
+    "vendor_url": "http://alpinelinux.org",
+    "documentation_url": "http://wiki.alpinelinux.org",
+    "product_name": "Alpine Linux Virt",
+    "registry_version": 4,
+    "status": "stable",
+    "availability": "free",
+    "maintainer": "Adnan RIHAN",
+    "maintainer_email": "adnan@rihan.fr",
+    "usage": "Autologin is enabled as \"root\" with no password.\n\nThe network interfaces aren't configured, you can do either of the following:\n- Use alpine's DHCP client: `udhcpc`\n- Configure them manually (ip address add \u2026, ip route add \u2026)\n- Modify interfaces file in /etc/network/interfaces\n- Use alpine's wizard: `setup-interfaces`",
+    "symbol": "alpine-virt-qemu.svg",
+    "port_name_format": "eth{0}",
+    "qemu": {
+        "adapter_type": "virtio-net-pci",
+        "adapters": 1,
+        "ram": 128,
+        "hda_disk_interface": "virtio",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "kvm": "allow"
+    },
+    "images": [
+        {
+            "filename": "alpine-virt-3.18.4.qcow2",
+            "version": "3.18.4",
+            "md5sum": "99d393c16c870e12c4215aadd82ca998",
+            "filesize": 51066880,
+            "download_url": "https://sourceforge.net/projects/gns-3/files/Qemu%20Appliances/",
+            "direct_download_url": "https://sourceforge.net/projects/gns-3/files/Qemu%20Appliances/alpine-virt-3.18.4.qcow2/download"
+        },
+        {
+            "filename": "alpine-virt-3.16.img",
+            "version": "3.16",
+            "md5sum": "ce90ff64b8f8e5860c49ea4a038e54cc",
+            "filesize": 96468992,
+            "download_url": "https://sourceforge.net/projects/gns-3/files/Qemu%20Appliances/",
+            "direct_download_url": "https://sourceforge.net/projects/gns-3/files/Qemu%20Appliances/alpine-virt-3.16.img/download"
+        }
+    ],
+    "versions": [
+        {
+            "name": "3.18.4",
+            "images": {
+                "hda_disk_image": "alpine-virt-3.18.4.qcow2"
+            }
+        },
+        {
+            "name": "3.16",
+            "images": {
+                "hda_disk_image": "alpine-virt-3.16.img"
+            }
+        }
+    ]
+}

gns3server/appliances/alpine-linux.gns3a

@@ -0,0 +1,21 @@
+{
+    "appliance_id": "fc520ae2-a4e5-48c3-9a13-516bb2e94668",
+    "name": "Alpine Linux",
+    "category": "guest",
+    "description": "Alpine Linux is a security-oriented, lightweight Linux distribution based on musl libc and busybox.",
+    "vendor_name": "Alpine Linux Development Team",
+    "vendor_url": "http://alpinelinux.org",
+    "vendor_logo_url": "https://raw.githubusercontent.com/GNS3/gns3-registry/master/vendor-logos/Alpine Linux.png",
+    "documentation_url": "http://wiki.alpinelinux.org",
+    "product_name": "Alpine Linux",
+    "registry_version": 4,
+    "status": "stable",
+    "maintainer": "GNS3 Team",
+    "maintainer_email": "developers@gns3.net",
+    "symbol": "linux_guest.svg",
+    "docker": {
+        "adapters": 1,
+        "image": "alpine",
+        "console_type": "telnet"
+    }
+}

gns3server/appliances/arista-ceos.gns3a

@@ -0,0 +1,20 @@
+{
+    "appliance_id": "a7eec173-9680-4c1f-bf79-1bf29d485375",
+    "name": "cEOS",
+    "category": "multilayer_switch",
+    "description": "Arista cEOS\u2122 introduces the containerized packaging of EOS software and its agents for deployment in cloud infrastructure with the same proven EOS software image that runs on all Arista products. These flexible deployment options empower cloud network operators that are customizing their operating environments to provide a uniform workflow for development, testing and deployment of differentiated services.",
+    "vendor_name": "Arista",
+    "vendor_url": "http://www.arista.com/",
+    "product_name": "cEOS",
+    "registry_version": 4,
+    "status": "experimental",
+    "maintainer": "GNS3 Team",
+    "maintainer_email": "developers@gns3.net",
+    "usage": "Download:\nCreate a (free) Arista account and login.\nThen navigate to Support / Software Download and download the cEOS-lab image.\n\nInstallation:\nCopy the image to your GNS3VM (or other Linux) server, then run the following commands:\n\ncEOS-4.21.0F and newer, replace <version> by the cEOS version:\ndocker import cEOS-lab.tar.xz ceosimage:<version>\necho \"rm /etc/systemd/system/getty.target.wants/getty@tty1.service\" | \\\ndocker run --name=ceos-container -e CEOS=1 -e container=docker -e EOS_PLATFORM=ceoslab -e SKIP_ZEROTOUCH_BARRIER_IN_SYSDBINIT=1 -e ETBA=1 -e INTFTYPE=eth -i ceosimage:<version> sh\ndocker commit --change='CMD [\"/sbin/init\"]' --change='VOLUME /mnt/flash' ceos-container ceosimage:GNS3\ndocker rm ceos-container\n\ncEOS-4.20.5F:\ndocker import cEOS-lab.tar.xz ceosimage:4.20.5F\necho \"rm /etc/systemd/system/getty.target.wants/getty@tty1.service\" | \\\ndocker run --name=ceos-container -e CEOS=1 -e container=docker -e EOS_PLATFORM=ceossim -e SKIP_ZEROTOUCH_BARRIER_IN_SYSDBINIT=1 -e ETBA=1 -e INTFTYPE=eth -i ceosimage:4.20.5F sh\ndocker commit --change='CMD [\"/sbin/init\"]' --change='VOLUME /mnt/flash' ceos-container ceosimage:GNS3\ndocker rm ceos-container\n\nUsage:\nStart an auxiliary console on the cEOS and issue the \"Cli\" command.\nOnly cEOS-4.20.5F: Login on the console with username \"admin\".",
+    "symbol": ":/symbols/multilayer_switch.svg",
+    "docker": {
+        "adapters": 8,
+        "image": "ceosimage:GNS3",
+        "console_type": "telnet"
+    }
+}

gns3server/appliances/arista-veos.gns3a

@@ -0,0 +1,577 @@
+{
+    "appliance_id": "c90f3ff3-4ed2-4437-9afb-21232fa92015",
+    "name": "Arista vEOS",
+    "category": "multilayer_switch",
+    "description": "Arista EOS\u00ae is the core of Arista cloud networking solutions for next-generation data centers and cloud networks. Cloud architectures built with Arista EOS scale to tens of thousands of compute and storage nodes with management and provisioning capabilities that work at scale. Through its programmability, EOS enables a set of software applications that deliver workflow automation, high availability, unprecedented network visibility and analytics and rapid integration with a wide range of third-party applications for virtualization, management, automation and orchestration services.\n\nArista Extensible Operating System (EOS) is a fully programmable and highly modular, Linux-based network operation system, using familiar industry standard CLI and runs a single binary software image across the Arista switching family. Architected for resiliency and programmability, EOS has a unique multi-process state sharing architecture that separates state information and packet forwarding from protocol processing and application logic.",
+    "vendor_name": "Arista",
+    "vendor_url": "http://www.arista.com/",
+    "documentation_url": "https://www.arista.com/assets/data/docs/Manuals/EOS-4.17.2F-Manual.pdf",
+    "product_name": "vEOS",
+    "product_url": "https://eos.arista.com/",
+    "registry_version": 4,
+    "status": "experimental",
+    "maintainer": "GNS3 Team",
+    "maintainer_email": "developers@gns3.net",
+    "usage": "The login is admin, with no password by default",
+    "symbol": ":/symbols/multilayer_switch.svg",
+    "first_port_name": "Management1",
+    "port_name_format": "Ethernet{port1}",
+    "qemu": {
+        "adapter_type": "e1000",
+        "adapters": 13,
+        "ram": 2048,
+        "hda_disk_interface": "ide",
+        "hdb_disk_interface": "ide",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "kvm": "require",
+        "options": "-cpu host"
+    },
+    "images": [
+        {
+            "filename": "vEOS64-lab-4.32.0F.vmdk",
+            "version": "4.32.0F",
+            "md5sum": "851771260bb18ad3e90fa6956f0c6161",
+            "filesize": 591724544,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS64-lab-4.31.3M.vmdk",
+            "version": "4.31.3M",
+            "md5sum": "7df107da137f4a4e752014d4f0e94cd3",
+            "filesize": 577961984,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS64-lab-4.30.6M.vmdk",
+            "version": "4.30.6M",
+            "md5sum": "19721aace820b9ebf6d7ae6524803cf5",
+            "filesize": 553123840,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS64-lab-4.29.8M.vmdk",
+            "version": "4.29.8M",
+            "md5sum": "131888f74cd63a93894521d40eb4d0b6",
+            "filesize": 548405248,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS64-lab-4.28.11M.vmdk",
+            "version": "4.28.11M",
+            "md5sum": "6cac0e7b04a74ee0dc358327a00accfd",
+            "filesize": 513343488,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS64-lab-4.27.12M.vmdk",
+            "version": "4.27.12M",
+            "md5sum": "34c4f785c7fc054cda8754dd13c0d7c7",
+            "filesize": 496697344,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.32.0F.vmdk",
+            "version": "4.32.0F",
+            "md5sum": "584b901a1249717504050e48f74fb8dd",
+            "filesize": 591396864,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.31.3M.vmdk",
+            "version": "4.31.3M",
+            "md5sum": "a2e130697cdf8547006eebebde6eefca",
+            "filesize": 590086144,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.30.6M.vmdk",
+            "version": "4.30.6M",
+            "md5sum": "a4467648bcfa7b19640af8a4ad3153c6",
+            "filesize": 565968896,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.29.8M.vmdk",
+            "version": "4.29.8M",
+            "md5sum": "1952f6114a4376212c525db9ec8efd5f",
+            "filesize": 558039040,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.28.11M.vmdk",
+            "version": "4.28.11M",
+            "md5sum": "5502df24dfc231c45afb33d6018c16d0",
+            "filesize": 521338880,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.27.12M.vmdk",
+            "version": "4.27.12M",
+            "md5sum": "e08a97e7c1977993f947fedeb4c6ddd5",
+            "filesize": 504299520,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "Aboot-veos-serial-8.0.2.iso",
+            "version": "8.0.2",
+            "md5sum": "8d7e754efebca1930a93a2587ff7606c",
+            "filesize": 6291456,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.26.2F.vmdk",
+            "version": "4.26.2F",
+            "md5sum": "de8ce9750fddb63bd3f71bccfcd7651e",
+            "filesize": 475332608,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.25.3M.vmdk",
+            "version": "4.25.3M",
+            "md5sum": "2f196969036b4d283e86f15118d59c26",
+            "filesize": 451543040,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.24.3M.vmdk",
+            "version": "4.24.3M",
+            "md5sum": "0a28e44c7ce4a8965f24a4a463a89b7d",
+            "filesize": 455213056,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.24.2.1F.vmdk",
+            "version": "4.24.2.1F",
+            "md5sum": "6bab8b59ce5230e243e56f4127448fc8",
+            "filesize": 455213056,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.23.4.2M.vmdk",
+            "version": "4.23.4.2M",
+            "md5sum": "d21cbef4e39f1e783b13a926cb54a242",
+            "filesize": 454295552,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.23.0.1F.vmdk",
+            "version": "4.23.0.1F",
+            "md5sum": "08d52154aa11a834aef9f42bbf29f977",
+            "filesize": 439484416,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.22.2.1F.vmdk",
+            "version": "4.22.2.1F",
+            "md5sum": "2a425bf8efe569a2bdf0e328f240cd16",
+            "filesize": 426377216,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.22.0F.vmdk",
+            "version": "4.22.0F",
+            "md5sum": "cfcc75c2b8176cfd819afcfd6799b74c",
+            "filesize": 414121984,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.21.1.1F.vmdk",
+            "version": "4.21.1F",
+            "md5sum": "02bfb7e53781fd44ff02357f201586d9",
+            "filesize": 358809600,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.20.10M-combined.vmdk",
+            "version": "4.20.10M-combined",
+            "md5sum": "d1f2d650f93dbf24e04fdd2c9d62bd62",
+            "filesize": 334626816,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.20.1F.vmdk",
+            "version": "4.20.1F",
+            "md5sum": "aadb6f3dbff28317f68cb4c4502d0db8",
+            "filesize": 662044672,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.19.10M-combined.vmdk",
+            "version": "4.19.10M-combined",
+            "md5sum": "103daa45c33be4584cbe6adc60de46a3",
+            "filesize": 324141056,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.19.10M.vmdk",
+            "version": "4.19.10M",
+            "md5sum": "665ed14389411ae5f16ba0a2ff84240a",
+            "filesize": 637337600,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.18.10M-combined.vmdk",
+            "version": "4.18.10M-combined",
+            "md5sum": "e33e0ef5b8cecc84c5bb57569b36b9c6",
+            "filesize": 317652992,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.18.10M.vmdk",
+            "version": "4.18.10M",
+            "md5sum": "1d87e9ace37fe3706dbf3e49c8d4d231",
+            "filesize": 624427008,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.18.5M.vmdk",
+            "version": "4.18.5M",
+            "md5sum": "b1ee6268dbaf2b2276fd7a5286c7ce2b",
+            "filesize": 623116288,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.18.1F.vmdk",
+            "version": "4.18.1F",
+            "md5sum": "9648c63185f3b793b47528a858ca4364",
+            "filesize": 620625920,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.17.8M.vmdk",
+            "version": "4.17.8M",
+            "md5sum": "afc79a06f930ea2cc0ae3e03cbfd3f23",
+            "filesize": 608829440,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.17.2F.vmdk",
+            "version": "4.17.2F",
+            "md5sum": "3b4845edfa77cf9aaeb9c0a005d3e277",
+            "filesize": 609615872,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.16.13M.vmdk",
+            "version": "4.16.13M",
+            "md5sum": "4d0facf90140fc3aab031f0f8f88a32f",
+            "filesize": 521404416,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.16.6M.vmdk",
+            "version": "4.16.6M",
+            "md5sum": "b3f7b7cee17f2e66bb38b453a4939fef",
+            "filesize": 519962624,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.15.10M.vmdk",
+            "version": "4.15.10M",
+            "md5sum": "98e08281a9c48ddf6f3c5d62a124a20f",
+            "filesize": 517079040,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.15.5M.vmdk",
+            "version": "4.15.5M",
+            "md5sum": "cd74bb69c7ee905ac3d33c4d109f3ab7",
+            "filesize": 516030464,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.14.14M.vmdk",
+            "version": "4.14.14M",
+            "md5sum": "d81ba0522f4d7838d96f7985e41cdc47",
+            "filesize": 422641664,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.13.16M.vmdk",
+            "version": "4.13.16M",
+            "md5sum": "5763b2c043830c341c8b1009f4ea9a49",
+            "filesize": 404684800,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "vEOS-lab-4.13.8M.vmdk",
+            "version": "4.13.8M",
+            "md5sum": "a47145b9e6e7a24171c0850f8755535e",
+            "filesize": 409010176,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        },
+        {
+            "filename": "Aboot-veos-serial-8.0.0.iso",
+            "version": "8.0.0",
+            "md5sum": "488ad1c435d18c69bb8d69c7806457c9",
+            "filesize": 5242880,
+            "download_url": "https://www.arista.com/en/support/software-download"
+        }
+    ],
+    "versions": [
+        {
+            "name": "4.32.0F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS64-lab-4.32.0F.vmdk"
+            }
+        },
+        {
+            "name": "4.31.3M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS64-lab-4.31.3M.vmdk"
+            }
+        },
+        {
+            "name": "4.30.6M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS64-lab-4.30.6M.vmdk"
+            }
+        },
+        {
+            "name": "4.29.8M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS64-lab-4.29.8M.vmdk"
+            }
+        },
+        {
+            "name": "4.28.11M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS64-lab-4.28.11M.vmdk"
+            }
+        },
+        {
+            "name": "4.27.12M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS64-lab-4.27.12M.vmdk"
+            }
+        },
+        {
+            "name": "4.32.0F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS-lab-4.32.0F.vmdk"
+            }
+        },
+        {
+            "name": "4.31.3M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS-lab-4.31.3M.vmdk"
+            }
+        },
+        {
+            "name": "4.30.6M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS-lab-4.30.6M.vmdk"
+            }
+        },
+        {
+            "name": "4.29.8M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS-lab-4.29.8M.vmdk"
+            }
+        },
+        {
+            "name": "4.28.11M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS-lab-4.28.11M.vmdk"
+            }
+        },
+        {
+            "name": "4.27.12M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.2.iso",
+                "hdb_disk_image": "vEOS-lab-4.27.12M.vmdk"
+            }
+        },
+        {
+            "name": "4.26.2F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.26.2F.vmdk"
+            }
+        },
+        {
+            "name": "4.25.3M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.25.3M.vmdk"
+            }
+        },
+        {
+            "name": "4.24.3M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.24.3M.vmdk"
+            }
+        },
+        {
+            "name": "4.24.2.1F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.24.2.1F.vmdk"
+            }
+        },
+        {
+            "name": "4.23.4.2M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.23.4.2M.vmdk"
+            }
+        },
+        {
+            "name": "4.23.0.1F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.23.0.1F.vmdk"
+            }
+        },
+        {
+            "name": "4.22.2.1F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.22.2.1F.vmdk"
+            }
+        },
+        {
+            "name": "4.22.0F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.22.0F.vmdk"
+            }
+        },
+        {
+            "name": "4.21.1F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.21.1.1F.vmdk"
+            }
+        },
+        {
+            "name": "4.20.10M-combined",
+            "images": {
+                "hda_disk_image": "vEOS-lab-4.20.10M-combined.vmdk"
+            }
+        },
+        {
+            "name": "4.20.1F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.20.1F.vmdk"
+            }
+        },
+        {
+            "name": "4.19.10M-combined",
+            "images": {
+                "hda_disk_image": "vEOS-lab-4.19.10M-combined.vmdk"
+            }
+        },
+        {
+            "name": "4.19.10M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.19.10M.vmdk"
+            }
+        },
+        {
+            "name": "4.18.10M-combined",
+            "images": {
+                "hda_disk_image": "vEOS-lab-4.18.10M-combined.vmdk"
+            }
+        },
+        {
+            "name": "4.18.10M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.18.10M.vmdk"
+            }
+        },
+        {
+            "name": "4.18.5M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.18.5M.vmdk"
+            }
+        },
+        {
+            "name": "4.18.1F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.18.1F.vmdk"
+            }
+        },
+        {
+            "name": "4.17.8M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.17.8M.vmdk"
+            }
+        },
+        {
+            "name": "4.17.2F",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.17.2F.vmdk"
+            }
+        },
+        {
+            "name": "4.16.13M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.16.13M.vmdk"
+            }
+        },
+        {
+            "name": "4.16.6M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.16.6M.vmdk"
+            }
+        },
+        {
+            "name": "4.15.10M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.15.10M.vmdk"
+            }
+        },
+        {
+            "name": "4.15.5M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.15.5M.vmdk"
+            }
+        },
+        {
+            "name": "4.14.14M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.14.14M.vmdk"
+            }
+        },
+        {
+            "name": "4.13.16M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.13.16M.vmdk"
+            }
+        },
+        {
+            "name": "4.13.8M",
+            "images": {
+                "hda_disk_image": "Aboot-veos-serial-8.0.0.iso",
+                "hdb_disk_image": "vEOS-lab-4.13.8M.vmdk"
+            }
+        }
+    ]
+}

gns3server/appliances/aruba-arubaoscx.gns3a

@@ -0,0 +1,233 @@
+{
+    "appliance_id": "8f074218-9d61-4e99-ab89-35ca19ad44ee",
+    "name": "ArubaOS-CX Simulation Software",
+    "category": "multilayer_switch",
+    "description": "The Aruba AOS-CX Switch Simulator is a virtual platform to enable simulation of the Aruba AOS-CX Network Operating System. Simulated networks can be created using many of the protocols in the ArubaOS-CX Operating system like OSPF, BGP (inc. EVPN). Key features like the Aruba Network Analytics Engine and the REST API can be simulated, providing a lightweight development platform to building the modern network.",
+    "vendor_name": "HPE Aruba",
+    "vendor_url": "https://www.arubanetworks.com",
+    "documentation_url": "https://asp.arubanetworks.com/downloads;search=Aruba%20AOS%20CX%20Switch%20Simulator;products=Aruba%20Switches",
+    "product_name": "Aruba AOS-CX Switch Simulator",
+    "product_url": "https://www.arubanetworks.com/products/switches/",
+    "registry_version": 4,
+    "status": "stable",
+    "availability": "service-contract",
+    "maintainer": "Aruba",
+    "maintainer_email": "vincent.giles@hpe.com",
+    "usage": "Default username: admin, no password. New Password has to be set at first login.",
+    "symbol": ":/symbols/route_switch_processor.svg",
+    "first_port_name": "mgmt",
+    "port_name_format": "1/1/{port1}",
+    "qemu": {
+        "adapter_type": "virtio-net-pci",
+        "adapters": 8,
+        "ram": 4096,
+        "cpus": 2,
+        "hda_disk_interface": "ide",
+        "hdb_disk_interface": "ide",
+        "hdc_disk_interface": "ide",
+        "arch": "x86_64",
+        "console_type": "telnet",
+        "kvm": "require",
+        "options": "-nographic",
+        "process_priority": "normal"
+    },
+    "images": [
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20240129204649.vmdk",
+            "version": "10.13.1000",
+            "md5sum": "a1a24b15e3b8a09b0c0f14bdfacc4a75",
+            "filesize": 395342848,
+            "download_url": "https://networkingsupport.hpe.com"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20231110145644.vmdk",
+            "version": "10.13.0005",
+            "md5sum": "427fd4580e2ee3eac55a9e7d629d1375",
+            "filesize": 394995200,
+            "download_url": "https://networkingsupport.hpe.com"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20230810165021.vmdk",
+            "version": "10.12.1000",
+            "md5sum": "ea89f94dda9d28bf583dc35e0299b106",
+            "filesize": 384622080,
+            "download_url": "https://networkingsupport.hpe.com"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20230531220439.vmdk",
+            "version": "10.12.0006",
+            "md5sum": "c4f80fecd02ef93b431b75dd610e0063",
+            "filesize": 384638464,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20221130174651.vmdk",
+            "version": "10.11.0001",
+            "md5sum": "ed5434173c898f47f19bfda51000611a",
+            "filesize": 364597760,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20220815162137.vmdk",
+            "version": "10.10.1000",
+            "md5sum": "40f9ddf1e12640376af443b5d982f2f6",
+            "filesize": 356162560,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20220616193419.vmdk",
+            "version": "10.10.0002",
+            "md5sum": "ed031aeb6caf92adb408c7603d294fd4",
+            "filesize": 355858944,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20220223012712.vmdk",
+            "version": "10.09.1000",
+            "md5sum": "7b47c4442d825562e73e3f09b2f1f999",
+            "filesize": 556828672,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20211206170615.vmdk",
+            "version": "10.09.0002",
+            "md5sum": "3c772546482013495e31fc9cb0591b46",
+            "filesize": 555656704,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20210812172945.vmdk",
+            "version": "10.08.0001",
+            "md5sum": "762b139432aef1012d8be5afdfcb286e",
+            "filesize": 542237696,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20210610000730.vmdk",
+            "version": "10.07.0010",
+            "md5sum": "396dc7ad964b7c517e01bc408e3bf84a",
+            "filesize": 531603968,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20210316185909.vmdk",
+            "version": "10.06.0110",
+            "md5sum": "f1ed67d5c7e009e21bfb6a91d9183e8e",
+            "filesize": 381285376,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20201110192651.vmdk",
+            "version": "10.06.0001",
+            "md5sum": "f8b45bc52f6bad79b5ff563e0c1ea73b",
+            "filesize": 380304896,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20200311173823.vmdk",
+            "version": "10.04.1000",
+            "md5sum": "4e000d73c3593dfed6c49259c31401ea",
+            "filesize": 356249088,
+            "download_url": "https://asp.arubanetworks.com/"
+        },
+        {
+            "filename": "arubaoscx-disk-image-genericx86-p4-20180712161119.vmdk",
+            "version": "10.01.0001",
+            "md5sum": "9146ae0ac650d8206c9600e03753f022",
+            "filesize": 287734784,
+            "download_url": "http://support.arubanetworks.com/"
+        }
+    ],
+    "versions": [
+        {
+            "name": "10.13.1000",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20240129204649.vmdk"
+            }
+        },
+        {
+            "name": "10.13.0005",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20231110145644.vmdk"
+            }
+        },
+        {
+            "name": "10.12.1000",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20230810165021.vmdk"
+            }
+        },
+        {
+            "name": "10.12.0006",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20230531220439.vmdk"
+            }
+        },
+        {
+            "name": "10.11.0001",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20221130174651.vmdk"
+            }
+        },
+        {
+            "name": "10.10.1000",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20220815162137.vmdk"
+            }
+        },
+        {
+            "name": "10.10.0002",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20220616193419.vmdk"
+            }
+        },
+        {
+            "name": "10.09.1000",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20220223012712.vmdk"
+            }
+        },
+        {
+            "name": "10.09.0002",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20211206170615.vmdk"
+            }
+        },
+        {
+            "name": "10.08.0001",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20210812172945.vmdk"
+            }
+        },
+        {
+            "name": "10.07.0010",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20210610000730.vmdk"
+            }
+        },
+        {
+            "name": "10.06.0110",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20210316185909.vmdk"
+            }
+        },
+        {
+            "name": "10.06.0001",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20201110192651.vmdk"
+            }
+        },
+        {
+            "name": "10.04.1000",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20200311173823.vmdk"
+            }
+        },
+        {
+            "name": "10.01.0001",
+            "images": {
+                "hda_disk_image": "arubaoscx-disk-image-genericx86-p4-20180712161119.vmdk"
+            }
+        }
+    ]
+}