Skip to content

Latest commit

 

History

History
239 lines (170 loc) · 11.2 KB

snyk-runtime-sensor.md

File metadata and controls

239 lines (170 loc) · 11.2 KB
Raw

Snyk runtime sensor

{% hint style="warning" %} Release status

The Snyk runtime sensor is available in a Closed Beta state and is applicable only to the Snyk AppRisk Pro version.

Contact your salesperson if you are interested in Snyk AppRisk Pro. {% endhint %}

The Runtime Sensor watches your deployments on a Kubernetes cluster and sends the collected data to Snyk.

Prerequisites for Snyk Runtime Sensor

Ensure that your environment meets the following technical prerequisites to properly use the Snyk Runtime Sensor:

  • Kubernetes supported version - Use Kubernetes v.1.19 or higher.

{% hint style="info" %} Managed Kubernetes services such as EKS Fargate or GKE Autopilot, are not supported, as the cluster nodes are managed by the cloud provider. {% endhint %}

  • Privileged access - you need either root or the following Linux capabilities: BPF, PERFMON, SYS_RESOURCES, DAC_READ_SEARCH, SYS_PTRACE, NET_ADMIN
  • Cluster nodes must support BTF.
  • Language support - Go, Java v8 or higher, .NET v2.0.9 or higher, Node.js v10 or higher, Python 3.6 or higher.

You also need a token for a service account. The service account must have one of the following roles:

  • Group Admin
  • Custom Group Level Role with AppRisk edit permission enabled.

Install Snyk Runtime Sensor

The Snyk Runtime Sensor is a Kubernetes DeamonSet that can be easily deployed using various methods:

Using a Helm chart

There is a Helm chart within this repo in helm/runtime-sensor, that is hosted through GitHub pages in https://snyk.github.io/runtime-sensor.

To install the Snyk runtime sensor using Helm Charts, you can follow these steps:

  1. Ensure Helm is installed.

  2. Create the snyk-runtime-sensor namespace:

    kubectl create namespace snyk-runtime-sensor

  3. Create a secret with your service account token, which has the appropriate permissions (as instructed in the prerequisites section) under the created namespace:

    {% code overflow="wrap" %}

    kubectl create secret generic <<YOUR_SECRET_NAME>> --from-literal=snykToken=<<YOUR_TOKEN>> -n snyk-runtime-sensor

    {% endcode %}

  4. Add the Helm repo:

    helm repo add runtime-sensor https://snyk.github.io/runtime-sensor

  5. If your data is hosted in a different region than the default region (USA), you need to set the snykAPIBaseURL while installing the Helm chart in the following format: api.<<REGION>>.snyk.io:443, for example api.eu.snyk.io:443

  6. Install the Helm chart:

    helm install my-runtime-sensor \
--set secretName=<<YOUR_SECRET_NAME>> \
--set clusterName=<<CLUSTER_NAME>> \
--set snykGroupId=<<YOUR_GROUP_ID>> \
--set snykAPIBaseURL=<<YOUR_REGIONS_API_URL>> \ # Optional
-n snyk-runtime-sensor \
runtime-sensor/runtime-sensor

Upgrading to the latest version

  1. Check the name that was given to the sensor

    {% code overflow="wrap" %}

    helm repo list

    {% endcode %}

  2. Create a secret with your service account token, which has the appropriate permissions (as instructed in the prerequisites section) under the created namespace:

    {% code overflow="wrap" %}

    helm repo update <<SENSOR_REPO_NAME>>

    {% endcode %}

  3. Upgrade installation:

    helm upgrade --install <<SENSOR_REPO_NAME>> \
--set secretName=<<YOUR_SECRET_NAME>> \
--set clusterName=<<CLUSTER_NAME>> \
--set snykGroupId=<<YOUR_GROUP_ID>> \
-n snyk-runtime-sensor \
runtime-sensor/runtime-sensor

On OpenShift

When running your Kubernetes cluster in OpenShift, you will have to apply the privileged Security Context Constraint to the service account of the Snyk Runtime Sensor by running the following command:

oc adm policy add-scc-to-user privileged \
system:serviceaccount:<<YOUR_NAMESPACE>>:runtime-sensor

Run this command after the sensor is installed as the service account will not be available until the installation is complete.

Through the AWS Marketplace as an EKS add-on

Snyk provides a straightforward process for installing the Snyk Runtime Sensor on your AWS EKS cluster. The following steps explain how to integrate this security feature into your environment, enhancing the security of your cluster.

To deploy the Snyk Runtime Sensor on Amazon EKS with EKS Add-on, you need to meet the following prerequisites:

  1. Subscribe to Snyk Runtime Sensor on AWS Marketplace here.
  2. Install the following tools: kubectl, AWS CLI, and optionally eksctl.
  3. Ensure you have access to the Amazon EKS cluster where you want to install the sensor.
  4. Ensure you have a Snyk service account token ready with the right permissions, as described in the prerequisites.

Enable the Snyk Runtime Sensor add-on from AWS console

After you have successfully set up a subscription to Snyk Runtime Sensor on AWS Marketplace and followed the on-screen instructions, you will be redirected to Amazon EKS console.

To enable the Snyk Runtime Sensor for your Amazon EKS cluster, select your cluster on the Amazon EKS console. Then, navigate to the Add-ons tab and choose "Get more add-ons". Use the search bar to find "runtime" and follow the on-screen instructions to enable the add-on for your cluster.

Select the Snyk Runtime Sensor add-on

Select the Snyk Runtime Sensor add-on

On the next screen, select the latest version (even if already selected) and open the "Optional configuration settings".

Select the latest available version and open the 'Optional configuration settings'

Under the "configuration values", set the following attributes in a YAML or JSON format:

  • secretName - the secret name that will be created later in the process. The default value is snyk-secret .
  • clusterName - the name of the cluster where the add-on is installed.
  • snykGroupId - the Group ID associated with the used service account.
  • snykAPIBaseURL - should be configured to be api.snyk.io:443 , unless your data is hosted in a different region than the default (US).

Here is a base configuration to copy:

secretName: snyk-secret
clusterName: <<MY_CLUSTER>>
snykGroupId: <<MY_SNYK_GROUP_ID>>
snykAPIBaseURL: api.snyk.io:443

Set the appropriate configuration values under "Optional configuraiton settings"

Set the appropriate configuration values under "Optional configuraiton settings"

After you select the Next and Create options you will see the Add-on snyk-runtimesensor successfully added to cluster <<YOUR_CLUSTER>> notification on top of the page.

The success message.

The success message.

Enable Snyk Runtime Sensor add-on using AWS CLI

Run the following command on your workspace to enable the Snyk Runtime Sensor add-on for your Amazon EKS cluster. You have to set the following environment variables to match your Snyk account and your targeted EKS cluster:

  • $CLUSTER_NAME
  • $AWS_REGION
  • $SNYK_GROUP_ID
  • $SNYK_API_BASE_URL (should be set to api.snyk.io:443 unless your account is hosted on a different region than US).
aws eks create-addon \
--cluster-name $CLUSTER_NAME \
--region $AWS_REGION \
--addon-name snyk_runtime-sensor \
--configuration-values '{"secretName":"snyk-secret","clusterName":"$CLUSTER_NAME","snykGroupId":"$SNYK_GROUP_ID","snykAPIBaseURL": "$SNYK_API_BASE_URL"}' \
--resolve-conflicts OVERWRITE

After you have added the Snyk service account token as described below, ensure installation has been completed successfully by running the following command:

aws eks describe-addon --addon-name snyk_runtime-sensor --cluster-name $CLUSTER_NAME --region $AWS_REGION

Ensure the response you get is similar to this one and that the status is ACTIVE - it could take a few minutes until it reaches this status.

{
    "addon": {
        "addonName": "snyk_runtime-sensor",
        "clusterName": "<<YOUR_CLUSTER>>",
        "status": "ACTIVE",
        "addonVersion": "v1.17.2-eksbuild.1",
        "health": {
            "issues": []
        },
        "addonArn": "arn:aws:eks:us-east-1:XXXX:addon/<<YOUR_CLUSTER>>/snyk-runtimesensor/ffffffff-ffff-ffff-ffff-ffffffffffff",
        "createdAt": "2024-05-26T16:43:15.551000+03:00",
        "modifiedAt": "2024-05-26T16:43:28.714000+03:00",
        "tags": {},
        "configurationValues": "{\"secretName\":\"snyk-secret\",\"clusterName\":\"YOUR_CLUSTER\",\"snykGroupId\":\"YOUR_GROUP_ID\",\"snykAPIBaseURL\": \"api.snyk.io:443\"}"
    }
}

Add your Snyk Service Account Token to the EKS cluster

  • Set your kubectl context to control your cluster using aws eks: 
aws eks update-kubeconfig --name $CLUSTER_NAME --region $AWS_REGION
  • Create a secret name snyk-secret under the snyk-runtime-sensor namespace that contains the snykToken. The snykToken will be your service account token: 
kubectl create secret generic snyk-secret \
--from-literal=snykToken=$SNYK_TOKEN \
-n snyk-runtime-sensor
  • Data from your AWS EKS Cluster will be reported to Snyk using the Snyk Runtime Sensor.

Disable the Snyk Runtime Sensor add-on

You can disable the Snyk Runtime Sensor add-on by running the following command:

aws eks delete-addon --addon-name snyk_runtime-sensor --cluster-name $CLUSTER_NAME --region $AWS_REGION

Troubleshooting for Snyk Runtime Sensor

If the Snyk Runtime Sensor is not properly reporting the is_loaded risk factor, it may be caused by a non-default value of the Linux kernel perf_event_paranoid configuration.
In such cases, install the helm chart with either --set securityContext.privileged=true or add SYS_ADMIN as a required Linux capability --set "securityContext.capabilities={SYS_ADMIN}".

{% hint style="info" %} The Loaded package risk factor is not supported by Snyk for open-source packages, only for application packages such as npm, Maven, or PyPI. {% endhint %}

Release versions can be found on GitHub.