LogoLogo
Documentation and Guides
Documentation and Guides
  • ABOUT APONO
    • Why Choose Apono
    • Security and Architecture
    • Glossary
  • GETTING STARTED
    • How Apono Works
    • Getting started
    • Access Discovery
    • Integrating with Apono
  • CONNECTORS AND SECRETS
    • Apono Integration Secret
    • High Availability for Connectors
    • Installing a connector with Docker
    • Manage integrations
    • Manage connectors
  • AWS ENVIRONMENT
    • AWS Overview
    • Apono Connector for AWS
      • Installing a connector on EKS Using Terraform
      • Updating a connector in AWS
      • Installing a connector on AWS ECS using Terraform
    • AWS Integrations
      • Integrate an AWS account or organization
        • Auto Discover AWS RDS Instances
        • AWS Best Practices
      • Amazon Redshift
      • RDS PostgreSQL
      • AWS RDS MySQL
      • Integrate with EKS
      • AWS Lambda Custom Integration
      • EC2 via Systems Manager Agent (SSM)
  • AZURE ENVIRONMENT
    • Apono Connector for Azure
      • Install an Azure connector on ACI using Azure CLI
      • Install an Azure connector on ACI using PowerShell
      • Install an Azure connector on ACI using Terraform
      • Updating a connector in Azure
    • Azure Integrations
      • Integrate with Azure Management Group or Subscription
        • Auto Discover Azure SQL Databases
      • Azure MySQL
      • Azure PostgreSQL
      • Integrate with AKS
  • GCP ENVIRONMENT
    • Apono Connector for GCP
      • Installing a GCP connector on Cloud Run using CLI
      • Installing a GCP connector on GKE using CLI (Helm)
      • Installing a GCP connector on GKE using Terraform
      • Updating a connector in Google Cloud
    • GCP Integrations
      • Integrate a GCP organization or project
      • CloudSQL - MySQL
      • CloudSQL - PostgreSQL
      • Google Cloud Functions
      • Integrate with GKE
      • AlloyDB
  • KUBERNETES ENVIRONMENT
    • Apono Connector for Kubernetes
      • Installing a connector on Kubernetes with AWS permissions
      • Updating a Kubernetes connector
    • Kubernetes Integrations
      • Integrate with Self-Managed Kubernetes
  • ADDITIONAL INTEGRATIONS
    • Databases and Data Repositories
      • Microsoft SQL Server
      • MongoDB
      • MongoDB Atlas
      • MongoDB Atlas Portal
      • MySQL
      • Oracle Database
      • PostgreSQL
      • Redis Cloud (Redislabs)
      • Snowflake
      • Vertica
      • MariaDB
    • Network Management
      • SSH Servers
      • RDP Servers
      • Windows Domain Controller
      • AWS EC2 SSH Servers
      • Azure VM SSH Servers
      • Installing the Apono HTTP Proxy
    • Development Tools
      • GitHub
      • Rancher
    • Identity Providers
      • Okta SCIM
      • Okta Groups
      • Okta SSO for Apono logins
      • Google Workspace (Gsuite)
      • Google Workspace (GSuite) Groups
      • Azure Active Directory (Microsoft Entra ID)
      • Azure Active Directory (Entra ID) Groups
      • Jumpcloud
      • JumpCloud Groups
      • OneLogin
      • OneLogin Group
      • LDAP Groups
      • The Manager Attribute in Access Flows
      • HiBob
      • Ping Identity SSO
    • Incident Response Integrations
      • Opsgenie
      • PagerDuty
      • VictorOps (Splunk On-Call)
      • Zenduty
    • ChatOps Integrations
      • Slack integration
      • Teams integration
      • Backstage Integration
  • WEBHOOK INTEGRATIONS
    • Webhooks Overview
    • Anomaly Webhook
    • Audit Log Webhook
    • Request Webhook
      • Custom Webhooks
      • Communications and Notifications
        • Slack Outbound Webhooks
        • Teams
        • Outlook and Gmail (Using Azure Logic App)
      • ITSM
        • Freshdesk
        • Jira
        • ServiceNow
        • Zendesk
        • Freshservice
        • ServiceDesk Plus
      • Logs and SIEMs
        • Coralogix
        • Datadog
        • Logz.io
        • Grafana
        • New Relic
        • SolarWinds
        • Sumo Logic
        • Cortex
        • Logpoint
        • Splunk
        • Microsoft Sentinel
      • Orchestration and workflow builders
        • Okta Workflows
        • Torq
    • Integration Webhook
    • Webhook Payload References
      • Audit Log Webhook Payload Schema Reference
      • Webhook Payload Schema Reference
    • Manage webhooks
    • Troubleshoot a webhook
    • Manual Webhook
      • ITSM
        • PagerDuty
  • ACCESS FLOWS
    • Access Flows
      • What are Access Flows?
    • Create Access Flows
      • Self Serve Access Flows
      • Automatic Access Flows
      • Access Duration
    • Manage Access Flows
      • Right Sizing
    • Revoke Access
    • Dynamic Access Management
      • Resource and Integration Owners
    • Common Use Cases
      • Ensuring SLA
      • Protecting PII and Customer Data
      • Production Stability and Management
      • Break Glass Protocol
    • Create Bundles
    • Manage Bundles
  • ACCESS REQUESTS AND APPROVALS
    • Slack
      • Requesting Access with Slack
      • Approving Access with Slack
    • Teams
      • Requesting Access with Teams
      • Approving Access with Teams
    • CLI
      • Install and manage the Apono CLI
      • Requesting Access with CLI
    • Web Portal
      • Requesting Access with the Web Portal
      • Approving Access with the Web Portal
      • Reviewing historical requests with the Web Portal
    • Freshservice
    • Favorites
  • Inventory
    • Inventory Overview
    • Inventory
    • Access Scopes
    • Risk Scores
    • Apono Query Language
  • AUDITS AND REPORTS
    • Activity Overview
      • Activity
      • Create Reports
      • Manage Reports
    • Compliance: Audit and Reporting
    • Auditing Access in Apono
    • Admin Audit Log (Syslog)
  • HELP AND DEBUGGING
    • Integration Status Page
    • Troubleshooting Errors
  • ARCHITECTURE AND SECURITY
    • Anomaly Detection
    • Multi-factor Authentication
    • Credentials Rotation Policy
    • Periodic User Cleanup & Deletion
    • End-user Authentication
    • Personal API Tokens
  • User Administration
    • Role-Based Access Control (RBAC) Reference
    • Create Identities
    • Manage Identities
Powered by GitBook
On this page
  • Prerequisites
  • Integrate SSH servers

Was this helpful?

Export as PDF
  1. ADDITIONAL INTEGRATIONS
  2. Network Management

SSH Servers

Create an integration to manage access to SSH servers

PreviousNetwork ManagementNextRDP Servers

Last updated 2 months ago

Was this helpful?

SSH servers are secure, remote access points that allow users to connect to and manage systems over encrypted connections.

Through this integration, Apono enables managing secure Just-in-Time (JIT) access to SSH servers. Admins can create access flows for specific SSH servers and define approval processes and access durations for different users, groups, and shifts.

When a user's access request is approved, Apono creates a certificate that grants access to the server and assigns the requester to the appropriate access group(s). Apono may also use the user's default Linux group.


Prerequisites

Item
Description

Apono Connector

On-prem connection serving as a bridge between an SSH server and Apono:

Minimum Required Version: 1.4.0

Apono Secret

Value generated with the credentials of the SSH server user

To find the private key in base64 format, run the following command.

User with Key Pair Authentication

Dedicated SSH server user account that authenticates with SSH key pairs

In the sudoers file, add the following line to allow Apono to execute commands with sudo privileges without a password prompt.

JSON List of Servers

Structured list of SSH servers to which Apono will connect

The following information should be provided for each server:

  • name: Unique identifier for the server

  • host: IP address or hostname of the server

  • user: (Optional) Username for the SSH connection. Default: apono

  • port: (Optional) SSH port number. Default: 22

JSON List of Servers Example

User Groups

(Optional) User groups representing access to the SSH servers

Default: Default

The default represents access to the server with the user's default Linux group.

IMPORTANT: Learn more about user groups and permissions

When setting up the integration, be sure to list the groups and their associated permissions. This is important for granting sudo or other elevated permissions.

Follow these steps to grant users sudo permissions:

  1. Create a dedicated sudoers group.

  2. Add the group to the sudoers file. Replace %GROUP_NAME with the sudoers group name.

  1. Update the integration and workflow to assign users to this group when they request SSH access

Alternatively, you can use existing groups listed in the sudoers file (such as admin, sudo) if you prefer not to create a dedicated group.


Integrate SSH servers

You can also use the steps below to integrate with Apono using Terraform.

In step 10, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

Follow these steps to complete the integration:

  1. Under Discovery, click Next. The Apono connector section expands.

  2. From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

  1. Click Next. The Integration Config page appears.

  2. Define the Integration Config settings.

Setting
Description

Integration Name

Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow

Servers

Minified JSON list of servers

User Groups

(Optional) Names of groups in the server representing the sudoer role

User's Login Shell

(Optional) Command-line interface program used to log in to an account via SSH

User Key Name

(Optional) Filename of the SSH key pair used for authentication

  1. Click Next. The Secret Store section expands.

  2. Click Next. The Get more with Apono section expands.

  3. Define the Get more with Apono settings.

Setting
Description

Credential Rotation

(Optional) Number of days after which the database credentials must be rotated

User cleanup after access is revoked (in days)

(Optional) Defines the number of days after access has been revoked that the user should be deleted

Custom Access Details

(Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.

Integration Owner

  1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.

  2. From the Value dropdown menu, select one or multiple users or groups.

NOTE: When Resource Owner is defined, an Integration Owner must be defined.

Resource Owner

  1. Enter a Key name. This value is the name of the tag created in your cloud environment.

  2. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.

NOTE: When this setting is defined, an Integration Owner must also be defined.

  1. Click Confirm.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

  1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

  2. Click to copy the code.

  3. Make any additional edits.

  4. Deploy the code in your Terraform.

Learn how to update an existing , , , or connector.

based on your SSH server private key in base64 format.

Apono does not store credentials. The Apono connector uses the secret to communicate with services in your environment and separates the Apono web app from the environment for security.

tags: (Optional) Labels for grouping server resources for .

On the tab, click SSH. The Connect Integration page appears.

If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (, , , ).

.

Learn more about the .

Learn more about .

(Optional) Fallback approver if no is found Follow these steps to define one or several integration owners:

(Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several :

Refer to for more details about the schema definition.

Now that you have completed this integration, you can create that grant permission to your SSH instance.

"key": "base64_private_key"
"value": "<SSH_SERVER_PRIVATE_KEY>"
cat /PATH-TO-KEY/key.pem | base64
apono ALL=(ALL) NOPASSWD:ALL
[{"name":"My Server 1","host":"10.0.100.1","user":"apono","port":22,"tags":{"key1":"value1","key2":"value2"}},{"name":"My Server 2","host":"10.0.100.2","user":"ec2-user","port":22,"tags":{"key1":"value1","key2":"value2"}},{"name":"My Server 3","host":"10.0.100.3","port":4422,"user":"ec2-user"},{"name":"My Server 4","host":"10.0.100.4","user":"root","port":22,"tags":{"key1":"value1","key2":"value2"}},{"name":"My Server 5","host":"10.0.100.5","user":"root","port":4422,"tags":{"key1":"value1","key2":"value2"}}]
%GROUP_NAME ALL=(ALL:ALL) ALL
Catalog
AWS
Azure
GCP
Kubernetes
Associate the secret or credentials
Integration Config Metadata
access flows
AWS
Azure
GCP
Kubernetes
AWS
Azure
GCP
Kubernetes
Create your secret
maximal
dynamic access management
Credentials Rotation Policy
Periodic User Cleanup & Deletion
resource owner
resource owners
SSH tile