Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/celerium/rocketcyber-powershellwrapper
PowerShell wrapper for the RocketCyber API
https://github.com/celerium/rocketcyber-powershellwrapper
api powershell rest rest-api rocketcyber
Last synced: about 2 months ago
JSON representation
PowerShell wrapper for the RocketCyber API
- Host: GitHub
- URL: https://github.com/celerium/rocketcyber-powershellwrapper
- Owner: Celerium
- License: mit
- Created: 2022-02-24T01:37:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-29T22:49:24.000Z (about 1 year ago)
- Last Synced: 2023-10-30T21:32:02.961Z (about 1 year ago)
- Topics: api, powershell, rest, rest-api, rocketcyber
- Language: PowerShell
- Homepage: https://celerium.github.io/RocketCyber-PowerShellWrapper/
- Size: 882 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Celerium_RocketCyberAPI
[![Az_Pipeline][Az_Pipeline-shield]][Az_Pipeline-url]
[![GitHub_Pages][GitHub_Pages-shield]][GitHub_Pages-url]
[![PoshGallery_Version][PoshGallery_Version-shield]][PoshGallery_Version-url]
[![PoshGallery_Platforms][PoshGallery_Platforms-shield]][PoshGallery_Platforms-url]
[![PoshGallery_Downloads][PoshGallery_Downloads-shield]][PoshGallery_Downloads-url]
[![codeSize][codeSize-shield]][codeSize-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Blog][Website-shield]][Website-url]
[![GitHub_License][GitHub_License-shield]][GitHub_License-url]
---
## Buy me a coffee
Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)
---
---
## About The Project
The [RocketCyberAPI](https://www.RocketCyber.com/) offers users the ability to extract data from RocketCyber into third-party reporting tools and aims to abstract away the details of interacting with RocketCyber's API endpoints in such a way that is consistent with PowerShell nomenclature. This gives system administrators and PowerShell developers a convenient and familiar way of using RocketCyber's API to create documentation scripts, automation, and integrations.
- :book: Project documentation can be found on [Github Pages](https://celerium.github.io/RocketCyber-PowerShellWrapper/)
- :book: RocketCyber's [REST API documentation here](https://api-doc.rocketcyber.com/).
RocketCyber features a REST API that makes use of common HTTPs GET actions. In order to maintain PowerShell best practices, only approved verbs are used.
- GET -> Get-
Additionally, PowerShell's `verb-noun` nomenclature is respected. Each noun is prefixed with `RocketCyber` in an attempt to prevent naming problems.
For example, one might access the `/agent` endpoint by running the following PowerShell command with the appropriate parameters:
```posh
Get-RocketCyberAgents -id e9487ac5443c1b514f8f2c7ca256bb46
```
## Install
This module can be installed directly from the [PowerShell Gallery](https://www.powershellgallery.com/packages/RocketCyberAPI) with the following command:
```posh
Install-Module -Name RocketCyberAPI
```
- :information_source: This module supports PowerShell 5.0+ and *should* work in PowerShell Core.
- :information_source: If you are running an older version of PowerShell, or if PowerShellGet is unavailable, you can manually download the *main* branch and place the *RocketCyberAPI* folder into the (default) `C:\Program Files\WindowsPowerShell\Modules` folder.
Project documentation can be found on [Github Pages](https://celerium.github.io/RocketCyber-PowerShellWrapper/)
- A full list of functions can be retrieved by running `Get-Command -Module RocketCyberAPI`.
- Help info and a list of parameters can be found by running `Get-Help `, such as:
```posh
Get-Help Get-RocketCyberAgents
Get-Help Get-RocketCyberAgents -Full
```
## Initial Setup
After installing this module, you will need to configure both the *base URI* & *API key* that are used to talk with the RocketCyber API.
1. Run `Add-RocketCyberBaseURI`
- By default, RocketCyber's `https://api-us.rocketcyber.com/v3` URI is used.
- If you have your own API gateway or proxy, you may put in your own custom URI by specifying the `-base_uri` parameter:
- `Add-RocketCyberBaseURI -base_uri http://myapi.gateway.celerium.org`
2. Run `Add-RocketCyberAPIKey -Api_Key '12345'`
- It will prompt you to enter your API key if you do not specify it.
- RocketCyber API keys are generated via the RocketCyber portal under *Provider settings > RocketCyber API*
3. [**optional**] Run `Export-RocketCyberModuleSettings`
- This will create a config file at `%UserProfile%\RocketCyberAPI` that holds the *base uri* & *API key* information.
- Next time you run `Import-Module -Name RocketCyberAPI`, this configuration file will automatically be loaded.
- :warning: Exporting module settings encrypts your API keys in a format that can **only be unencrypted by the user principal** that encrypted the secret. It makes use of .NET DPAPI, which for Windows uses reversible encrypted tied to your user principal. This means that you **cannot copy** your configuration file to another computer or user account and expect it to work.
- :warning: However in Linux\Unix operating systems the secret keys are more obfuscated than encrypted so it is recommend to use a more secure & cross-platform storage method.
## Usage
Calling an API resource is as simple as running `Get-RocketCyber`
- The following is a table of supported functions and their corresponding API resources:
- Table entries with [ `-` ] indicate that the functionality is **NOT** supported by the RocketCyber API at this time.
| API Resource | Create | Read | Update | Delete |
| ----------------- | --------- | --------------------------------- | --------- | --------- |
| Account | - | `Get-RocketCyberAccounts` | - | - |
| Agents | - | `Get-RocketCyberAgents` | - | - |
| Apps | - | `Get-RocketCyberApps` | - | - |
| Defender | - | `Get-RocketCyberDefender` | - | - |
| Events | - | `Get-RocketCyberEvents` | - | - |
| EventSummary | - | `Get-RocketCyberEvents` | - | - |
| Firewalls | - | `Get-RocketCyberFirewalls` | - | - |
| Incidents | - | `Get-RocketCyberIncidents` | - | - |
| Office | - | `Get-RocketCyberOffice` | - | - |
Each `Get-RocketCyber*` function will respond with the raw data that RocketCyber's API provides.
- :warning: Returned data is mostly structured the same but does vary between commands.
## Roadmap
- [ ] Add Changelog
- [x] Build more robust Pester & ScriptAnalyzer tests
- [ ] Add example scripts & automation
See the [open issues](https://github.com/Celerium/RocketCyber-PowerShellWrapper/issues) for a full list of proposed features (and known issues).
---
## Contributing
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
See the [CONTRIBUTING](https://github.com/Celerium/RocketCyber-PowerShellWrapper/blob/main/.github/CONTRIBUTING.md) guide for more information about contributing.
## License
Distributed under the MIT License. See [`LICENSE`](https://github.com/Celerium/RocketCyber-PowerShellWrapper/blob/main/LICENSE) for more information.
[![GitHub_License][GitHub_License-shield]][GitHub_License-url]
## Contact
## Acknowledgments
Big thank you to the following people and services as they have provided me with lots of helpful information as I continue this project!
- [GitHub Pages](https://pages.github.com)
- [Img Shields](https://shields.io)
- [Font Awesome](https://fontawesome.com)
- [Choose an Open Source License](https://choosealicense.com)
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
[Az_Pipeline-shield]: https://img.shields.io/azure-devops/build/AzCelerium/RocketCyberAPI/6?style=for-the-badge&label=DevOps_Build
[Az_Pipeline-url]: https://dev.azure.com/AzCelerium/RocketCyberAPI/_build?definitionId=6
[GitHub_Pages-shield]: https://img.shields.io/github/actions/workflow/status/celerium/RocketCyber-PowerShellWrapper/pages%2Fpages-build-deployment?style=for-the-badge&label=GitHub%20Pages
[GitHub_Pages-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper/actions/workflows/pages/pages-build-deployment
[GitHub_License-shield]: https://img.shields.io/github/license/celerium/RocketCyber-PowerShellWrapper?style=for-the-badge
[GitHub_License-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper/blob/main/LICENSE
[PoshGallery_Version-shield]: https://img.shields.io/powershellgallery/v/RocketCyberapi?include_prereleases&style=for-the-badge
[PoshGallery_Version-url]: https://www.powershellgallery.com/packages/RocketCyberAPI
[PoshGallery_Platforms-shield]: https://img.shields.io/powershellgallery/p/RocketCyberapi?style=for-the-badge
[PoshGallery_Platforms-url]: https://www.powershellgallery.com/packages/RocketCyberAPI
[PoshGallery_Downloads-shield]: https://img.shields.io/powershellgallery/dt/RocketCyberAPI?style=for-the-badge
[PoshGallery_Downloads-url]: https://www.powershellgallery.com/packages/RocketCyberAPI
[website-shield]: https://img.shields.io/website?up_color=blue&url=https%3A%2F%2Fcelerium.org&style=for-the-badge&label=Blog
[website-url]: https://celerium.org
[codeSize-shield]: https://img.shields.io/github/repo-size/celerium/RocketCyber-PowerShellWrapper?style=for-the-badge
[codeSize-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper
[contributors-shield]: https://img.shields.io/github/contributors/celerium/RocketCyber-PowerShellWrapper?style=for-the-badge
[contributors-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/celerium/RocketCyber-PowerShellWrapper?style=for-the-badge
[forks-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper/network/members
[stars-shield]: https://img.shields.io/github/stars/celerium/RocketCyber-PowerShellWrapper?style=for-the-badge
[stars-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper/stargazers
[issues-shield]: https://img.shields.io/github/issues/Celerium/RocketCyber-PowerShellWrapper?style=for-the-badge
[issues-url]: https://github.com/Celerium/RocketCyber-PowerShellWrapper/issues
