# RDP Servers

Microsoft Remote Desktop Protocol (RDP) enables users to connect to and control a remote computer or virtual machine over a network. It provides secure and efficient remote access to desktops, servers, and applications, allowing employees to work from anywhere with an internet connection.

With this integration, Apono enables you to manage access to an RDP server with Connect permission or custom permissions group, so that only specific users or groups can provide remote access to resources in your environment on a temporary, as-needed basis.

***

### Prerequisites

<table><thead><tr><th width="252">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>Apono Connector</strong></td><td><p>On-prem connection serving as a bridge between an RDP server and Apono:</p><ul><li><a href="../../aws-environment/apono-connector-for-aws">AWS</a></li><li><a href="../../azure-environment/apono-connector-for-azure">Azure</a></li><li><a href="../../gcp-environment/apono-connector-for-gcp">GCP</a></li><li><a href="../../kubernetes-environment/apono-connector-for-kubernetes">Kubernetes</a></li></ul></td></tr><tr><td><strong>User</strong></td><td><p>Microsoft RDP user for Apono<br><br>The RDP user must be one of the following:</p><ul><li>Admin user</li><li><p>Custom role user with the following permissions:</p><ul><li><code>GenericRead</code></li><li><code>ListChildren</code></li><li><code>CreateChild</code></li><li><code>DeleteChild</code></li><li><code>ListObject</code></li><li><code>WriteMember</code></li><li><code>ResetPassword</code></li><li><code>Delete</code></li></ul></li></ul></td></tr><tr><td><strong>Secret</strong></td><td><p>Value generated with the credentials of the user you create</p><p><br><a href="../../connectors-and-secrets/apono-integration-secret">Create your secret</a> based on the connector you are using.<br></p><p>You can also <a href="../../connectors-and-secrets/apono-secret-alternative">input the user credentials directly</a>.</p><p><em>Apono does not store credentials. The Apono Connector uses the secret to communicate with services in your environment and separate the Apono web app from the environment for maximal</em> <a href="../../about-apono/security-and-architecture"><em>security</em></a><em>.</em></p></td></tr></tbody></table>

***

### Configure the RDP server

Before you begin integrating RDP with Apono, you must configure the Windows Remote Management (WinRM) service on a Windows machine to allow remote access using unencrypted and basic authentication.

You can allow [unencrypted](#unencrypted-communication) or [encrypted](#encrypted-communication) communication.

{% tabs %}
{% tab title="Unencrypted Communication" %}
Follow these steps to configure the RDP server:

1. Add the WinRM port *5985* to the allowlist in the server firewall.
2. Turn on the WinRM firewall rule in the Windows server.
3. Analyze and configure the WinRM service to allow remote management on the local machine.

{% hint style="info" %}
If a confirmation prompt appears after running the following command, enter `y.`
{% endhint %}

```sh
winrm quickconfig
```

4. Set the WinRM service configuration to allow unencrypted traffic.

```shell
winrm set winrm/config/service @{AllowUnencrypted="true"}
```

5. Enable basic authentication for the WinRM service. Basic authentication transmits credentials in cleartext.Shell

```shell
winrm set winrm/config/service/Auth @{Basic="true"}
```

You can now [integrate an RDP server](#integrate-an-rdp-server).
{% endtab %}

{% tab title="Encrypted Communication" %}
Follow these steps to configure the RDP server:

1. Add the WinRM port *5985* to the allowlist in the server firewall.
2. Turn on the WinRM firewall rule in the Windows server.
3. Analyze and configure the WinRM service to allow remote management on the local machine.

{% hint style="info" %}
If a confirmation prompt appears after running the following command, enter `y.`
{% endhint %}

```sh
winrm quickconfig
```

4. Enable basic authentication for the WinRM service. Basic authentication transmits credentials in cleartext.

```shell
winrm set winrm/config/service/Auth @{Basic="true"}
```

5. Configure WinRM HTTPS access on the target machine.

{% hint style="info" %}
Configuring WinRM to use HTTPS encrypts data transmitted between the client and server, protecting sensitive information from interception. To enable HTTPS, ensure a valid server authentication certificate is installed on the target machine.
{% endhint %}

You can now [integrate an RDP server](#integrate-an-rdp-server).
{% endtab %}
{% endtabs %}

***

### Integrate an RDP server

{% hint style="warning" %}
WinRM HTTPS requires a local computer Server Authentication certificate with a CN matching the hostname to be installed. The certificate must not be expired, revoked, or self-signed.
{% endhint %}

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-211a4286dcdff74f754c03f8121a3ff092b51483%2FIntegrate-rdp-1.png?alt=media" alt="" width="563"><figcaption><p>RDP tile</p></figcaption></figure>

{% hint style="success" %}
You can also use the steps below to integrate with Apono using Terraform.

In step **11**, instead of clicking **Confirm**, follow the **Are you integrating with Apono using Terraform?** guidance.
{% endhint %}

Follow these steps to complete the integration:

1. On the [**Catalog**](https://app.apono.io/catalog?search=rdp) tab, click **RDP** The **Connect Integration** page appears.
2. Under **Discovery**, select one or multiple resource types for Apono to discover in all instances of the environment.
3. Click **Next**. The **Apono connector** section expands.
4. From the dropdown menu, select a connector.

{% hint style="success" %}
If the desired connector is not listed, click **+ Add new connector** and follow the instructions for creating a connector ([AWS](https://docs.apono.io/docs/aws-environment/apono-connector-for-aws), [Azure](https://docs.apono.io/docs/azure-environment/apono-connector-for-azure), [GCP](https://docs.apono.io/docs/gcp-environment/apono-connector-for-gcp), [Kubernetes](https://docs.apono.io/docs/kubernetes-environment/apono-connector-for-kubernetes)).
{% endhint %}

5. Click **Next**. The **Integration Config** page appears.
6. Define the **Integration Config** settings.

   <table><thead><tr><th width="203">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Integration Name</strong></td><td>Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow</td></tr><tr><td><strong>Host</strong></td><td>DNS name or IP address of the RDP server to connect</td></tr><tr><td><strong>WinRM Port</strong></td><td>WinRM port value for the server<br><br>By default, Apono sets this value to <em>5985</em>.</td></tr><tr><td><strong>RDP Port</strong></td><td>(Optional) RDP port value<br><br>By default, Apono sets this value to <em>3389</em>.</td></tr><tr><td><strong>Use SSL connection</strong></td><td><p>Encrypted or unencrypted connection indicator<br><br><strong>Possible Values</strong>:</p><ul><li><strong>false</strong>: Unencrypted (unsecure) connection</li><li><strong>true</strong>: Encrypted (secure) connection</li></ul></td></tr></tbody></table>
7. Click **Next**. The **Secret Store** section expands.
8. [Associate the secret or credentials](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret).
9. Click **Next**. The **Get more with Apono** section expands.
10. Define the **Get more with Apono** settings.

    <table><thead><tr><th width="199">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Credential Rotation</strong></td><td>(Optional) Number of days after which the database credentials must be rotated<br><br>Learn more about the <a href="../../architecture-and-security/credentials-rotation-policy">Credentials Rotation Policy</a>.</td></tr><tr><td><strong>User cleanup after access is revoked (in days)</strong></td><td><p>(Optional) Defines the number of days after access has been revoked that the user should be deleted</p><p><br>Learn more about <a href="../../architecture-and-security/periodic-user-cleanup-and-deletion">Periodic User Cleanup &#x26; Deletion</a>.</p></td></tr><tr><td><strong>Custom Access Details</strong></td><td>(Optional) Instructions explaining how to access this integration's resources<br><br>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 <strong>400 characters</strong>.<br><br>To view the message as it appears to end users, click <strong>Preview</strong>.</td></tr><tr><td><strong>Integration Owner</strong></td><td><p>(Optional) Fallback approver if no <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owner</a> is found<br><br>Follow these steps to define one or several integration owners:</p><ol><li>From the <strong>Attribute</strong> dropdown menu, select <strong>User</strong> or <strong>Group</strong> under the relevant identity provider (IdP) platform.</li><li>From the <strong>Value</strong> dropdown menu, select one or multiple users or groups.</li></ol><p><br><strong>NOTE</strong>: When <strong>Resource Owner</strong> is defined, an <strong>Integration Owner</strong> must be defined.</p></td></tr><tr><td><strong>Resource Owner</strong></td><td><p>(Optional) Group or role responsible for managing access approvals or rejections for the resource<br><br>Follow these steps to define one or several <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owners</a>:</p><ol><li>Enter a <strong>Key name</strong>. This value is the name of the tag created in your cloud environment.</li><li>From the <strong>Attribute</strong> dropdown menu, select an attribute under the IdP platform to which the key name is associated.<br><br>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.</li></ol><p><br><strong>NOTE</strong>: When this setting is defined, an <strong>Integration Owner</strong> must also be defined.</p></td></tr></tbody></table>
11. Click **Confirm**.

<details>

<summary>💡Are you integrating with Apono using Terraform?</summary>

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.

Refer to [Integration Config Metadata](https://docs.apono.io/metadata-for-integration-config/integration-metadata/rdp) for more details about the schema definition.

</details>

Now that you have completed this integration, you can [create access flows](https://docs.apono.io/docs/access-flows/access-flows) that grant permission to your RDP server.