/SafeguardCustomPlatform

Sample custom platform management scripts and documentation for Safeguard

Apache License 2.0Apache-2.0

SafeguardCustomPlatform

Support and documentation for custom platform management


Check out our wiki documentation to get started with your own custom integration to Safeguard!


Introduction

Safeguard provides support for common platforms from which an asset administrator can create assets and asset accounts for managing privileged passwords. However, sometimes customer environments include unique applications, uncommon platforms/operating systems, or specialized customizations that Safeguard does not include in its common platforms. In order to support assets that represent these scenarios, Safeguard includes a custom platform feature which allows the asset administrator to write a platform definition that instructs Safeguard on how to communicate with these assets. We call these platform definitions custom platform scripts.

Get started quickly with one of our sample scripts.

Getting Started

The best place to start is to read the wiki documentation included in this repository. The custom platform scripts themselves may be thought of as an object model representing an intermediate language that is executed by Safeguard to manage the asset. The custom platform intermediate language is similar to a parsed syntax tree. Safeguard uses JSON to represent this intermediate language object model to avoid complications and security vulnerabilities related to parsing and interpreting a domain-specific language or a common scripting language.

After reading the wiki documentation, rather than writing a custom platform script from scratch, the best approach may be to start with a sample and modify it. We include sample custom platform scripts that are organized by the protocol used for managing the asset. Currently, Safeguard custom platforms support: SSH, Telnet (TN3270), and HTTP.