{"id":948,"date":"2018-07-10T18:12:37","date_gmt":"2018-07-10T12:42:37","guid":{"rendered":"https:\/\/rzpwp.blog\/?p=948"},"modified":"2024-02-12T15:28:28","modified_gmt":"2024-02-12T09:58:28","slug":"secret-management-razorpay","status":"publish","type":"post","link":"https:\/\/razorpay.com\/blog\/secret-management-razorpay\/","title":{"rendered":"How We Do Secret Management at Razorpay"},"content":{"rendered":"

As a payment processor<\/a>, we deal with many secrets – Encryption Keys, database configurations, application secrets, signing certificates etc. Most of these secrets are required by a specific service (say the Razorpay dashboard) to do routine tasks (such as connecting to the database).<\/span><\/p>\n

Secret Management<\/strong> is how you make sure that the specific service (and only that specific service) gets access to the correct (and latest) secrets. <\/span><\/p>\n

This is mostly a non-problem when you are a small startup, but as we\u2019ve grown from a small startup managing just a couple of servers, to managing large Kubernetes clusters, the way we store\/use secrets has changed considerably. <\/span><\/p>\n

Over time we’ve switched through various approaches in how we store and ship these secrets to our services. <\/span><\/p>\n

Secret Management is a common orchestration problem and has multiple different solutions. This blog post walks you through Razorpay\u2019s Secret Journey: how we\u2019ve tried out various solutions over various timelines and what benefits did they bring us.<\/span><\/p>\n

Stage 1: Ansible Vault<\/b><\/h2>\n

We started out with all of the secrets being stored in a common <\/span>Ansible Vault file<\/span><\/a>. Ansible is part of our DevOps tooling and used to configure servers. This vault file was used on automated Ansible runs, which would run on the live servers using Ansible-ssh.<\/span><\/p>\n

However, this resulted in our CI pipeline having access to our production servers, which we weren’t comfortable with. Ansible-vault also did not permit any granularity on the secret access – everyone with access to the vault key had access to all the secrets.<\/span><\/p>\n

To mitigate the CI-access issue, we moved to <\/span>Hashicorp Packer<\/span><\/a>, imitating the <\/span>Netflix model of infrastructure deployments<\/span><\/a>:<\/span><\/p>\n

    \n
  1. Spin up a new base VM in EC2.<\/span><\/li>\n
  2. Run ansible-ssh on the instance against the correct role<\/span><\/li>\n
  3. Push the final image to Amazon as an AMI (Amazon Machine Image)<\/span><\/li>\n<\/ol>\n

    This is a very common infrastructure setup (<\/span>Ansible+Packer<\/span><\/a>) and works reasonably well.<\/span><\/p>\n

    Stage 2: Credstash<\/b><\/h2>\n

    In order to get more granular control over our bakes, we switched to <\/span>Credstash<\/span><\/a>. Credstash is a well-established project (written in Python) for storing secrets safely in AWS. It does the following:<\/span><\/p>\n

      \n
    1. Uses <\/span>Amazon KMS<\/span><\/a> to encrypt\/decrypt secrets<\/span><\/li>\n
    2. Uses <\/span>AWS DynamoDB<\/span><\/a> to store the encrypted secrets<\/span><\/li>\n
    3. Supports a few nifty extras such as secret versioning<\/span><\/li>\n<\/ol>\n

      While we continued to use Ansible, <\/span>Ansible’s Credstash module <\/span><\/a>was an easy replacement for Ansible vault. It allows us to use:<\/span><\/p>\n

      lookup ('credstash', 'super_secret')<\/code><\/pre>\n
      inside the Ansible jinja templates. We managed access using AWS IAM roles granted only to the Packer instance (we called these “baker instances”).<\/span><\/p>\n
      Stage 3: Alohomora<\/b><\/h2>\n
      While Credstash served us well, we faced challenges with development velocity because of the bake process being slow. Each layer on our Ansible build system took anywhere between 10-45 minutes to run and led us to look for faster alternatives.<\/span><\/p>\n
      Since we were pretty happy with Credstash as our vetted secure storage method, we decided to take a leaf out of <\/span>Etsy’s book and try out “configuration deployments”<\/span><\/a>. The basic idea is to allow configuration updates on the same footing as your regular deployments – fast, easy, and accessible. <\/span><\/p>\n
      We\u2019d already been using AWS CodeDeploy for deployments to our codebase and decided to merge the two approaches.<\/span><\/p>\n
      Instead of splitting deployments into two categories (which is what Etsy does), we decided to make some changes to our Code Deploy infrastructure. Because of our current usage of Ansible Vault and switch to Credstash, most of our applications relied on secrets being readable from specific files. <\/span><\/p>\n
      We worked around this problem by writing a small wrapper on Credstash called Alohomora. It does the following:<\/span><\/p>\n
        \n
      1. Fetch secrets from a specific DynamoDB table using Credstash<\/span><\/li>\n
      2. Write them to disk using a <\/span>jinja template<\/span><\/a><\/li>\n<\/ol>\n
        The Jinja template is shipped alongside our codebase, and lets developers know exactly what secrets are exposed to the application. We run Alohomora as part of our deployment:<\/span><\/p>\n
        alohomora cast --env $CODEDEPLOY_GROUP \r\n--app $CODEDEPLOY_APP secrets.j2 license.j2<\/code><\/pre>\n
        The extra variables <\/span>($CODEDEPLOY_*) <\/span>are exposed by AWS <\/span>CodeDeploy<\/span><\/a> and let Alohomora decide which table to read the secrets from (It standardizes a naming scheme of <\/span>credstash-$env-$app<\/code>.<\/span><\/p>\n
        In case a secret is missing in the DynamoDB table, the deployment fails with an error message since we prefer to fail a deployment than allow it to go through with a missing secret.<\/span><\/p>\n
        We\u2019re open sourcing Alohomora alongside this blog post, go check it at <\/span>https:\/\/github.com\/razorpay\/alohomora<\/span><\/a>. It has been a great enabler of faster configuration deploys at Razorpay, and we hope it can be of help to other companies pushing secret updates regularly to their applications.<\/span><\/p>\n
        Stage 4: Kubestash<\/b><\/h2>\n
        Our Devops team bet on Kubernetes early on. We were running production code on our in-house Kubernetes cluster by Q3-2017. The Alohomora deployment script was moved to the entry point for our docker images and the IAM roles maintained using <\/span>kube2iam<\/span><\/a> (we’ve since switched to <\/span>Kiam<\/span><\/a>).<\/span><\/p>\n
        Alohomora, while working decently in a Kubernetes infra, wasn’t Kubernetes-native. As such, it gave us issues with:<\/span><\/p>\n
        Resource Quotas<\/i><\/b>: <\/b>We saw CPU spikes in the application during the deployment when Alohomora ran. As a result, we had to accommodate for higher resource quotas on the applications compared to what the service was using.<\/span><\/p>\n
        Python<\/i><\/b>:<\/b> Alohomora was written with Ubuntu 16.04 based deployments in mind and supported Python 2.7. We started facing issues with python dependencies with services using Python themselves. We’d have faced this issue with our Ubuntu setup as well, but running on docker exacerbated it.<\/span><\/p>\n
        Not Kubernetes First<\/i><\/b>:<\/b> Kubernetes already provides a secret management solution in Kubernetes Secrets. It allows for both file and environment variable based secrets. Running Alohomora and fetching secrets from Credstash felt like an alien\u00a0solution in the Kubernetes world.<\/span><\/p>\n
        We found a solution in another small Credstash wrapper called Kubestash<\/a> – a small command line application to sync your Credstash secrets to Kubernetes. We’ve since contributed patches<\/a> to Kubestash that work with our specific workflow and allow for cluster level syncs.<\/span><\/p>\n
        This allows us to store our secrets using Credstash and know that they will get pushed automatically to our Kubernetes cluster using Kubestash. The primary command that we use is K<\/span>ubestash Daemonall<\/span> which syncs a complete dynamoDB table against a Kubernetes cluster. We run this as a single pod deployment in our cluster.<\/span><\/p>\n
        One caveat to keep in mind if using Kubernetes secrets is to make sure that your <\/span>etcd store is encrypted<\/span><\/a>, otherwise etcd will store all your secrets on disk, unencrypted.<\/span><\/p>\n
        You can find more details in the K<\/span>ubestash<\/span> documentation at <\/span>https:\/\/github.com\/af-inet\/kubestash<\/span><\/a>.<\/span><\/p>\n
        Alternatives<\/b><\/h2>\n
        If you’re reading this, there are several other alternatives now available to you that you might wanna consider before picking a solution:<\/span><\/p>\n
        Confidante by Lyft<\/a><\/strong> :<\/strong> We didn’t try this out since this was released after we’d switched over to Credstash, but it is fairly similar in scope (KMS for encryption + DynamoDB for Storage). It also features a Web UI where users can update secrets.<\/span><\/h3>\n
        Just Kubernetes Secrets<\/a><\/strong>:<\/strong> If you’re running on a managed Kubernetes cluster, this is a very good solution that you should consider. In our case, we wanted something other than etcd to be our primary secret store which is why we went with Kubestash (it lets us keep dynamoDB as the primary store)<\/span><\/h3>\n
        AWS Parameter Store<\/a><\/strong>:<\/strong> The AWS Parameter store allows you to store arbitrary key\/value pairs and grant access using IAM roles. There are some wrappers (similar to Credstash) that use Parameter Store instead of DynamoDB.<\/span><\/h3>\n
        AWS Secrets Manager<\/a><\/strong>:<\/strong> Recently announced at this year’s AWS: Invent, this is a slightly costlier solution that allows for secret versioning and automated secret rollover using Lambda jobs. We might consider this if it supports a native Kubernetes integration (which might show up with <\/span>AWS: EKS<\/span><\/a> perhaps?)<\/span><\/h3>\n
        \n
        Interested in automating things and helping us scale the most robust payments platform in India? We’re looking for Infrastructure Engineers at Razorpay! Check out the job postings at https:\/\/razorpay.com\/jobs<\/a><\/span><\/em><\/p>\n","protected":false},"excerpt":{"rendered":"
        Secret Management is key to data safety in payment gateways. Here’s our journey of finding the perfect secret keeper – from Ansible to Kubernetes and more..<\/p>\n","protected":false},"author":5,"featured_media":960,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[69],"tags":[53,57],"class_list":{"0":"post-948","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-razorpay-stories","8":"tag-razorpay-stories","9":"tag-technology"},"_links":{"self":[{"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/posts\/948","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/comments?post=948"}],"version-history":[{"count":0,"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/posts\/948\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/media\/960"}],"wp:attachment":[{"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/media?parent=948"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/categories?post=948"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/razorpay.com\/blog\/wp-json\/wp\/v2\/tags?post=948"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}