# [SCA3S](https://github.com/scarv/sca3s): command-line interface
<!--- -------------------------------------------------------------------- --->
*Acting as a component part of the wider
[SCARV](https://www.scarv.org)
project,
SCA3S is a collection of resources that support the development
and analysis of cryptographic implementations wrt.
[side-channel attack](https://en.wikipedia.org/wiki/Side-channel_attack):
SCA3A is, more specifically, pitched as offering
"side-channel analysis as a service":
it allows users to acquire and analyse side-channel data-sets which stem
from execution of their implementation, without (necessarily) owning or
operating the associated infrastructure.
Mirroring the goals of SCARV, it places particular emphasis on analogue
side-channels (e.g., power and EM) stemming from
[RISC-V](https://riscv.org)-based
platforms.
The main
[repository](https://github.com/scarv/sca3s)
acts as a general container for associated resources;
this specific submodule houses
a [CLI](https://en.wikipedia.org/wiki/Command-line_interface) which allows interaction with the front-end infrastructure without using the web-based UI.*
<!--- -------------------------------------------------------------------- --->
## Organisation
```
├── bin - scripts (e.g., environment configuration)
├── build - working directory for build
├── extern - external resources (e.g., submodules)
│ └── wiki - submodule: scarv/sca3s-cli.wiki
└── src
└── sca3s
└── cli
```
<!--- -------------------------------------------------------------------- --->
## Installation
```bash
pip install sca3s_cli
```
## Configuration
- SCA3S CLI links to a pre-existing SCA3S account via an API token which can be obtained via the user profile page.
- Once a token is obtained and `sca3s-cli` installed, edit the config file in `~/.sca3s/config` as follows:
```bash
[default]
token
```
This will link the cli to your SCA3S account. If you possess multiple SCA3S accounts you can add additional tokens
with friendly names to the config file and utilise these tokens via the `scope` parameter in the cli.
<!--- -------------------------------------------------------------------- --->
## Questions?
- read the
[wiki](https://github.com/scarv/sca3s-cli/wiki),
- raise an
[issue](https://github.com/scarv/sca3s-cli/issues),
- raise a
[pull request](https://github.com/scarv/sca3s-cli/pulls),
- drop us an
[email](mailto:sca3s@scarv.org).
<!--- -------------------------------------------------------------------- --->
## Acknowledgements
This work has been supported in part
- by EPSRC via grant
[EP/R012288/1](https://gow.epsrc.ukri.org/NGBOViewGrant.aspx?GrantRef=EP/R012288/1) (under the [RISE](https://www.ukrise.org) programme),
and
- by the
[AWS Cloud Credits for Research](https://aws.amazon.com/research-credits)
programme.
<!--- -------------------------------------------------------------------- --->
Raw data
{
"_id": null,
"home_page": "https://github.com/jwsi/sca3s-cli",
"name": "sca3s-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sca3s sca3s_cli",
"author": "James Webb",
"author_email": "james.webb@bristol.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/01/a9/bf9f2c49990f2c2706ccee628b7f74893622fcc2acbd9742880841029091/sca3s_cli-1.0.6.tar.gz",
"platform": null,
"description": "# [SCA3S](https://github.com/scarv/sca3s): command-line interface\n\n<!--- -------------------------------------------------------------------- --->\n\n*Acting as a component part of the wider\n[SCARV](https://www.scarv.org)\nproject,\nSCA3S is a collection of resources that support the development \nand analysis of cryptographic implementations wrt.\n[side-channel attack](https://en.wikipedia.org/wiki/Side-channel_attack):\nSCA3A is, more specifically, pitched as offering\n\"side-channel analysis as a service\":\nit allows users to acquire and analyse side-channel data-sets which stem \nfrom execution of their implementation, without (necessarily) owning or \noperating the associated infrastructure.\nMirroring the goals of SCARV, it places particular emphasis on analogue \nside-channels (e.g., power and EM) stemming from\n[RISC-V](https://riscv.org)-based\nplatforms.\nThe main\n[repository](https://github.com/scarv/sca3s)\nacts as a general container for associated resources;\nthis specific submodule houses\na [CLI](https://en.wikipedia.org/wiki/Command-line_interface) which allows interaction with the front-end infrastructure without using the web-based UI.*\n\n<!--- -------------------------------------------------------------------- --->\n\n## Organisation\n\n```\n\u251c\u2500\u2500 bin - scripts (e.g., environment configuration)\n\u251c\u2500\u2500 build - working directory for build\n\u251c\u2500\u2500 extern - external resources (e.g., submodules)\n\u2502 \u2514\u2500\u2500 wiki - submodule: scarv/sca3s-cli.wiki\n\u2514\u2500\u2500 src\n \u2514\u2500\u2500 sca3s\n \u2514\u2500\u2500 cli\n```\n\n<!--- -------------------------------------------------------------------- --->\n\n## Installation \n\n```bash\npip install sca3s_cli\n```\n\n## Configuration\n\n- SCA3S CLI links to a pre-existing SCA3S account via an API token which can be obtained via the user profile page.\n- Once a token is obtained and `sca3s-cli` installed, edit the config file in `~/.sca3s/config` as follows:\n\n```bash\n[default]\ntoken\n```\n\nThis will link the cli to your SCA3S account. If you possess multiple SCA3S accounts you can add additional tokens\nwith friendly names to the config file and utilise these tokens via the `scope` parameter in the cli.\n\n<!--- -------------------------------------------------------------------- --->\n\n## Questions?\n\n- read the\n [wiki](https://github.com/scarv/sca3s-cli/wiki),\n- raise an\n [issue](https://github.com/scarv/sca3s-cli/issues),\n- raise a\n [pull request](https://github.com/scarv/sca3s-cli/pulls),\n- drop us an \n [email](mailto:sca3s@scarv.org).\n\n<!--- -------------------------------------------------------------------- --->\n\n## Acknowledgements\n\nThis work has been supported in part \n\n- by EPSRC via grant \n [EP/R012288/1](https://gow.epsrc.ukri.org/NGBOViewGrant.aspx?GrantRef=EP/R012288/1) (under the [RISE](https://www.ukrise.org) programme), \n and \n- by the\n [AWS Cloud Credits for Research](https://aws.amazon.com/research-credits)\n programme.\n\n<!--- -------------------------------------------------------------------- --->\n\n",
"bugtrack_url": null,
"license": "Apache2",
"summary": "Toolkit to enable job submission to SCA3S from the command line",
"version": "1.0.6",
"split_keywords": [
"sca3s",
"sca3s_cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71319c9b92e8462c17d406d11be70647f4be9012a02e41eac2ee3b830850e0cf",
"md5": "be0316e3f09027ce7cb21f087cbc42e3",
"sha256": "da849f215ef89b3c682e6f410042af23d8b8f993398a7263749e33d7438d3270"
},
"downloads": -1,
"filename": "sca3s_cli-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be0316e3f09027ce7cb21f087cbc42e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12010,
"upload_time": "2023-01-11T12:52:38",
"upload_time_iso_8601": "2023-01-11T12:52:38.388319Z",
"url": "https://files.pythonhosted.org/packages/71/31/9c9b92e8462c17d406d11be70647f4be9012a02e41eac2ee3b830850e0cf/sca3s_cli-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01a9bf9f2c49990f2c2706ccee628b7f74893622fcc2acbd9742880841029091",
"md5": "a161b1db0f47d03bdc2fa31d4b76a2de",
"sha256": "16a69b71adde577a50f8425067abe2f0794902ddfb26543afaeea883aad5999f"
},
"downloads": -1,
"filename": "sca3s_cli-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "a161b1db0f47d03bdc2fa31d4b76a2de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11873,
"upload_time": "2023-01-11T12:52:39",
"upload_time_iso_8601": "2023-01-11T12:52:39.622074Z",
"url": "https://files.pythonhosted.org/packages/01/a9/bf9f2c49990f2c2706ccee628b7f74893622fcc2acbd9742880841029091/sca3s_cli-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 12:52:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jwsi",
"github_project": "sca3s-cli",
"lcname": "sca3s-cli"
}
JSON
