{"id":19645760,"url":"https://github.com/approov/quickstart-ruby-on-rails-token-check","last_synced_at":"2026-06-10T03:31:33.543Z","repository":{"id":54728316,"uuid":"300585705","full_name":"approov/quickstart-ruby-on-rails-token-check","owner":"approov","description":"Approov integration example for the Ruby on Rails framework","archived":false,"fork":false,"pushed_at":"2024-10-16T00:14:29.000Z","size":85,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-01-09T20:53:10.560Z","etag":null,"topics":["api","api-security","approov","approov-backend","approov-bakend-quickstart","approov-quickstart","backend","security"],"latest_commit_sha":null,"homepage":"https://approov.io","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/approov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-02T10:55:43.000Z","updated_at":"2024-08-07T12:28:34.000Z","dependencies_parsed_at":"2024-08-07T14:10:09.289Z","dependency_job_id":null,"html_url":"https://github.com/approov/quickstart-ruby-on-rails-token-check","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/approov%2Fquickstart-ruby-on-rails-token-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/approov%2Fquickstart-ruby-on-rails-token-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/approov%2Fquickstart-ruby-on-rails-token-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/approov%2Fquickstart-ruby-on-rails-token-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/approov","download_url":"https://codeload.github.com/approov/quickstart-ruby-on-rails-token-check/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240952991,"owners_count":19884020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-security","approov","approov-backend","approov-bakend-quickstart","approov-quickstart","backend","security"],"created_at":"2024-11-11T14:35:09.427Z","updated_at":"2026-06-10T03:31:33.533Z","avatar_url":"https://github.com/approov.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Approov QuickStart - Ruby on Rails Token Check\n\n[Approov](https://approov.io) is an API security solution used to verify that requests received by your backend services originate from trusted versions of your mobile apps.\n\nThis repo implements the Approov server-side request verification code in Ruby, which performs the verification check before allowing valid traffic to be processed by the API endpoint.\n\nThis is an Approov integration quickstart example for the Ruby on Rails framework. If you are looking for another Ruby integration you can check our list of [quickstarts](https://approov.io/docs/latest/approov-integration-examples/backend-api/), and if you don't find what you are looking for, then please let us know [here](https://approov.io/contact). Meanwhile, you can always use the framework agnostic [quickstart example](https://github.com/approov/quickstart-ruby-on-rails-token-check) for Ruby, and you may find that's easily adaptable to your framework of choice.\n\n\n## Approov Integration Quickstart\n\nThe quickstart was tested with the following Operating Systems:\n\n* Ubuntu 20.04\n* MacOS Big Sur\n* Windows 10 WSL2 - Ubuntu 20.04\n\nFirst, setup the [Approov CLI](https://approov.io/docs/latest/approov-installation/index.html#initializing-the-approov-cli).\n\nNow, register the API domain for which Approov will issues tokens:\n\n```bash\napproov api -add api.example.com\n```\n\n\u003e **NOTE:** By default a symmetric key (HS256) is used to sign the Approov token on a valid attestation of the mobile app for each API domain it's added with the Approov CLI, so that all APIs will share the same secret and the backend needs to take care to keep this secret secure.\n\u003e\n\u003e A more secure alternative is to use asymmetric keys (RS256 or others) that allows for a different keyset to be used on each API domain and for the Approov token to be verified with a public key that can only verify, but not sign, Approov tokens.\n\u003e\n\u003e To implement the asymmetric key you need to change from using the symmetric HS256 algorithm to an asymmetric algorithm, for example RS256, that requires you to first [add a new key](https://approov.io/docs/latest/approov-usage-documentation/#adding-a-new-key), and then specify it when [adding each API domain](https://approov.io/docs/latest/approov-usage-documentation/#keyset-key-api-addition). Please visit [Managing Key Sets](https://approov.io/docs/latest/approov-usage-documentation/#managing-key-sets) on the Approov documentation for more details.\n\nNext, enable your Approov `admin` role with:\n\n```bash\neval `approov role admin`\n````\n\nFor the Windows powershell:\n\n```bash\nset APPROOV_ROLE=admin:___YOUR_APPROOV_ACCOUNT_NAME_HERE___\n```\n\nNow, get your Approov Secret with the [Approov CLI](https://approov.io/docs/latest/approov-installation/index.html#initializing-the-approov-cli):\n\n```bash\napproov secret -get base64\n```\n\nNext, add the [Approov secret](https://approov.io/docs/latest/approov-usage-documentation/#account-secret-key-export) to your project `.env` file:\n\n```env\nAPPROOV_BASE64_SECRET=approov_base64_secret_here\n```\n\nNow, add to your Gemfile the [dotenv-rails](https://github.com/bkeepers/dotenv) gem to automatically load the Approov secret:\n\n```ruby\ngem 'dotenv-rails', '~\u003e 2.7.6'\n```\n\nNext, to check the Approov token you need to add the [jwt/ruby-jwt](https://github.com/jwt/ruby-jwt) gem to your Gemfile:\n\n```ruby\ngem 'jwt', '~\u003e 2.2.2'\n```\n\nNow, run the installer:\n\n```bash\nbundle install\n```\n\nNext, add the [Approov Middleware](/src/approov-protected-server/token-check/hello/app/middlewares/approov_middleware.rb) class to your project at `app/middlewares/approov_middleware.rb`:\n\n```ruby\nclass ApproovMiddleware\n    def initialize app\n        @app = app\n\n        if not ENV['APPROOV_BASE64_SECRET']\n            raise \"Missing in the .env file the value for the variable: APPROOV_BASE64_SECRET\"\n        end\n\n        @APPROOV_SECRET = Base64.decode64(ENV['APPROOV_BASE64_SECRET'])\n    end\n\n    def call env\n        # Make the code thread safe by duplicating the object\n        dup._call env\n    end\n\n    def _call env\n        # We return 401 with an empty body because we don't want to give clues\n        # to the attacker about why he is failing the request, and you can go\n        # even further and return a 400.\n        invalid_response = [401, {\"Content-Type\" =\u003e \"application/json\"}, []]\n\n        request = Rack::Request.new env\n\n        approov_token_claims = verifyApproovToken(request)\n\n        if not approov_token_claims\n            return invalid_response\n        end\n\n        # Allow later reuse of the Approov token claims in request life cycle.\n        env[\"APPROOV_TOKEN_CLAIMS\"] = approov_token_claims\n\n        return @app.call(env)\n    end\n\n    def verifyApproovToken request\n        begin\n            approov_token = request.get_header \"HTTP_APPROOV_TOKEN\"\n\n            if not approov_token\n                # You may want to add some logging here\n                # Rails.logger.debug 'Missing the Approov token header!'\n                return nil\n            end\n\n            options = { algorithm: 'HS256' }\n            approov_token_claims, header = JWT.decode approov_token, @APPROOV_SECRET, true, options\n\n            return approov_token_claims\n\n        rescue JWT::DecodeError =\u003e e\n            # You may want to add some logging here\n            # Rails.logger.debug e\n            return nil\n        rescue JWT::ExpiredSignature =\u003e e\n            # You may want to add some logging here\n            # Rails.logger.debug e\n            return nil\n        rescue JWT::InvalidIssuerError =\u003e e\n            # You may want to add some logging here\n            # Rails.logger.debug e\n            return nil\n        rescue JWT::InvalidIatError =\u003e e\n            # You may want to add some logging here\n            # Rails.logger.debug e\n            return nil\n        end\n\n        # You may want to add some logging here\n        # Rails.logger.debug 'Whoops, unknown failure when verifying the Approov token!'\n        return nil\n    end\nend\n```\n\n\u003e **NOTE:** When the Approov token validation fails we return a `401` with an empty body, because we don't want to give clues to an attacker about the reason the request failed, and you can go even further by returning a `400`.\n\n\nNow, add the [Approov Middleware](/src/approov-protected-server/token-check/hello/app/middlewares/approov_middleware.rb) to your Ruby on Rails application middleware configuration at [config/application.rb](/src/approov-protected-server/token-binding-check/hello/config/application.rb):\n\n```ruby\n# Inserted as the first middleware to protect your server from wasting\n# resources in processing requests not having a valid Approov token. This\n# increases availability for your users during peak time or in the event of a\n# DoS attack.\nconfig.middleware.insert_before ActionDispatch::HostAuthorization, ApproovMiddleware\n```\n\nNot enough details in the bare bones quickstart? No worries, check the [detailed quickstarts](QUICKSTARTS.md) that contain a more comprehensive set of instructions, including how to test the Approov integration.\n\n\n## More Information\n\n* [Approov Overview](OVERVIEW.md)\n* [Detailed Quickstarts](QUICKSTARTS.md)\n* [Examples](EXAMPLES.md)\n* [Testing](TESTING.md)\n\n\n### System Clock\n\nIn order to correctly check for the expiration times of the Approov tokens is very important that the backend server is synchronizing automatically the system clock over the network with an authoritative time source. In Linux this is usually done with a NTP server.\n\n\n## Issues\n\nIf you find any issue while following our instructions then just report it [here](https://github.com/approov/quickstart-ruby-on-rails-token-check/issues), with the steps to reproduce it, and we will sort it out and/or guide you to the correct path.\n\n\n## Useful Links\n\nIf you wish to explore the Approov solution in more depth, then why not try one of the following links as a jumping off point:\n\n* [Approov Free Trial](https://approov.io/signup)(no credit card needed)\n* [Approov Get Started](https://approov.io/product/demo)\n* [Approov QuickStarts](https://approov.io/docs/latest/approov-integration-examples/)\n* [Approov Docs](https://approov.io/docs)\n* [Approov Blog](https://approov.io/blog/)\n* [Approov Resources](https://approov.io/resource/)\n* [Approov Customer Stories](https://approov.io/customer)\n* [Approov Support](https://approov.io/contact)\n* [About Us](https://approov.io/company)\n* [Contact Us](https://approov.io/contact)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapproov%2Fquickstart-ruby-on-rails-token-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapproov%2Fquickstart-ruby-on-rails-token-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapproov%2Fquickstart-ruby-on-rails-token-check/lists"}