assemblyline-service-server


Nameassemblyline-service-server JSON
Version 4.5.0.75 PyPI version JSON
download
home_pagehttps://github.com/CybercentreCanada/assemblyline-service-server/
SummaryAssemblyline 4 - Service Server
upload_time2025-02-11 21:49:37
maintainerNone
docs_urlNone
authorCCCS Assemblyline development team
requires_pythonNone
licenseMIT
keywords assemblyline malware gc canada cse-cst cse cst cyber cccs
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/GUAy9wErNu)
[![](https://img.shields.io/discord/908084610158714900)](https://discord.gg/GUAy9wErNu)
[![Static Badge](https://img.shields.io/badge/github-assemblyline-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline)
[![Static Badge](https://img.shields.io/badge/github-assemblyline--service--server-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline-service-server)
[![GitHub Issues or Pull Requests by label](https://img.shields.io/github/issues/CybercentreCanada/assemblyline/service-server)](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:service-server)
[![License](https://img.shields.io/github/license/CybercentreCanada/assemblyline-service-server)](./LICENCE.md)

# Assemblyline 4 - Service Server

The service server is a API that the service clients can call to interface with the system. This is the only access the services have to the system as they are completely segregated from the other components.

## Image variants and tags

| **Tag Type** | **Description**                                                                                  |      **Example Tag**       |
| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |
|    latest    | The most recent build (can be unstable).                                                         |          `latest`          |
|  build_type  | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. |     `stable` or `dev`      |
|    series    | Complete build details, including version and build type: `version.buildType`.                   | `4.5.stable`, `4.5.1.dev3` |

## API functionality

Service server provides the following functions via API to the client:

- File download and upload
- Register service to the system
- Get a new task
- Publish results for a task
- Checking if certain tags or files have a reputation relative to the system (ie. safe vs malicious)

#### Running this component

```bash
docker run --name service-server cccs/assemblyline-service-server
```

## Documentation

For more information about this Assemblyline component, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.

---

# Assemblyline 4 - Serveur de service

Le serveur de service est une API que les clients des services peuvent contacter pour interagir avec le système. C'est le seul accès que les services ont avec le système. Autrement, ils sont complètement isolés des autres composants du système.

## Variantes et étiquettes d'image

| **Type d'étiquette** | **Description**                                                                                                  |  **Exemple d'étiquette**   |
| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |
|       dernière       | La version la plus récente (peut être instable).                                                                 |          `latest`          |
|      build_type      | Le type de compilation utilisé. `dev` est la dernière version instable. `stable` est la dernière version stable. |     `stable` ou `dev`      |
|        séries        | Le détail de compilation utilisé, incluant la version et le type de compilation : `version.buildType`.           | `4.5.stable`, `4.5.1.dev3` |

## Fonctionnalité de l'API

Le serveur de service fournit les fonctionnalités suivantes au client via l'API :

- Téléchargement et chargement de fichiers
- Enregistrement d'un service dans le système
- Obtenir une nouvelle tâche
- Publier les résultats d'une tâche
- Vérifier si certaines étiquettes ou fichiers ont une réputation liée au système (c'est-à-dire sûrs ou malveillants).

#### Exécuter ce composant

```bash
docker run --name service-server cccs/assemblyline-service-server
```

## Documentation

Pour plus d'informations sur ce composant Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du système.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/CybercentreCanada/assemblyline-service-server/",
    "name": "assemblyline-service-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "assemblyline malware gc canada cse-cst cse cst cyber cccs",
    "author": "CCCS Assemblyline development team",
    "author_email": "assemblyline@cyber.gc.ca",
    "download_url": null,
    "platform": null,
    "description": "[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/GUAy9wErNu)\n[![](https://img.shields.io/discord/908084610158714900)](https://discord.gg/GUAy9wErNu)\n[![Static Badge](https://img.shields.io/badge/github-assemblyline-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline)\n[![Static Badge](https://img.shields.io/badge/github-assemblyline--service--server-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline-service-server)\n[![GitHub Issues or Pull Requests by label](https://img.shields.io/github/issues/CybercentreCanada/assemblyline/service-server)](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:service-server)\n[![License](https://img.shields.io/github/license/CybercentreCanada/assemblyline-service-server)](./LICENCE.md)\n\n# Assemblyline 4 - Service Server\n\nThe service server is a API that the service clients can call to interface with the system. This is the only access the services have to the system as they are completely segregated from the other components.\n\n## Image variants and tags\n\n| **Tag Type** | **Description**                                                                                  |      **Example Tag**       |\n| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |\n|    latest    | The most recent build (can be unstable).                                                         |          `latest`          |\n|  build_type  | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. |     `stable` or `dev`      |\n|    series    | Complete build details, including version and build type: `version.buildType`.                   | `4.5.stable`, `4.5.1.dev3` |\n\n## API functionality\n\nService server provides the following functions via API to the client:\n\n- File download and upload\n- Register service to the system\n- Get a new task\n- Publish results for a task\n- Checking if certain tags or files have a reputation relative to the system (ie. safe vs malicious)\n\n#### Running this component\n\n```bash\ndocker run --name service-server cccs/assemblyline-service-server\n```\n\n## Documentation\n\nFor more information about this Assemblyline component, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.\n\n---\n\n# Assemblyline 4 - Serveur de service\n\nLe serveur de service est une API que les clients des services peuvent contacter pour interagir avec le syst\u00e8me. C'est le seul acc\u00e8s que les services ont avec le syst\u00e8me. Autrement, ils sont compl\u00e8tement isol\u00e9s des autres composants du syst\u00e8me.\n\n## Variantes et \u00e9tiquettes d'image\n\n| **Type d'\u00e9tiquette** | **Description**                                                                                                  |  **Exemple d'\u00e9tiquette**   |\n| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |\n|       derni\u00e8re       | La version la plus r\u00e9cente (peut \u00eatre instable).                                                                 |          `latest`          |\n|      build_type      | Le type de compilation utilis\u00e9. `dev` est la derni\u00e8re version instable. `stable` est la derni\u00e8re version stable. |     `stable` ou `dev`      |\n|        s\u00e9ries        | Le d\u00e9tail de compilation utilis\u00e9, incluant la version et le type de compilation : `version.buildType`.           | `4.5.stable`, `4.5.1.dev3` |\n\n## Fonctionnalit\u00e9 de l'API\n\nLe serveur de service fournit les fonctionnalit\u00e9s suivantes au client via l'API :\n\n- T\u00e9l\u00e9chargement et chargement de fichiers\n- Enregistrement d'un service dans le syst\u00e8me\n- Obtenir une nouvelle t\u00e2che\n- Publier les r\u00e9sultats d'une t\u00e2che\n- V\u00e9rifier si certaines \u00e9tiquettes ou fichiers ont une r\u00e9putation li\u00e9e au syst\u00e8me (c'est-\u00e0-dire s\u00fbrs ou malveillants).\n\n#### Ex\u00e9cuter ce composant\n\n```bash\ndocker run --name service-server cccs/assemblyline-service-server\n```\n\n## Documentation\n\nPour plus d'informations sur ce composant Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du syst\u00e8me.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Assemblyline 4 - Service Server",
    "version": "4.5.0.75",
    "project_urls": {
        "Homepage": "https://github.com/CybercentreCanada/assemblyline-service-server/"
    },
    "split_keywords": [
        "assemblyline",
        "malware",
        "gc",
        "canada",
        "cse-cst",
        "cse",
        "cst",
        "cyber",
        "cccs"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "975e321395555161bba543242d4953f32cd0a332c8ea2ead90d1c4eb638ea97d",
                "md5": "8c1a5de4aebbb702d8e7a847f833b34d",
                "sha256": "33c6a24ad89792b172d37c781170ae2c861a4f112aedf92531d9dc6dcc331d30"
            },
            "downloads": -1,
            "filename": "assemblyline_service_server-4.5.0.75-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8c1a5de4aebbb702d8e7a847f833b34d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19513,
            "upload_time": "2025-02-11T21:49:37",
            "upload_time_iso_8601": "2025-02-11T21:49:37.191811Z",
            "url": "https://files.pythonhosted.org/packages/97/5e/321395555161bba543242d4953f32cd0a332c8ea2ead90d1c4eb638ea97d/assemblyline_service_server-4.5.0.75-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-11 21:49:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CybercentreCanada",
    "github_project": "assemblyline-service-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "assemblyline-service-server"
}
        
Elapsed time: 0.59358s