TailscaleMiddleware

TailscaleMiddleware provides support for protecting routes behind a tailnet.

Install the gem:

gem install tailscale_middleware

Or in your Gemfile:

gem 'tailscale_middleware'

For Rails, you'll need to add this middleware on application startup. A practical way to do this is with an initializer file, like this:

# config/initializers/tailscale_middleware.rb

Rails.application.config.middleware.insert_before 0, TailscaleMiddleware do
  ...
end

Use insert_before to make sure TailscaleMiddleware runs at the beginning of the stack; this ensures it isn't interfered with by other middleware.

See The Rails Guide to Rack for more details on Rack middleware. Read more about configuring middleware in the Rails Guides

NOTE: If you're running Rails, adding a config/initializers/tailscale_middleware.rb should be enough.

For pure Rack, in config.ru, configure TailscaleMiddleware by passing a block to the use command:

use TailscaleMiddleware do
  ...
end

TailscaleMiddleware do
  allow do
    tailnet "rubber-duck"
    route "*"
  end
end

In this example:

1. If your server is not connected to a tailnet, the request is denied
2. If your client is not connected to the rubber-duck tailnet, the request is denied
3. If your client is connected to the rubber-duck tailnet, the request is passed along

TailscaleMiddleware do
  allow do
    tailnet "crab-cake"
    route "/staff"
  end
end

In this example:

1. If your client is does not request anything under /staff, the request is passed along
2. If your client requests something under /staff, but is not connected to the crab-cake tailnet, the request is denied
3. If your client requests something under /staff, and is connected to the crab-cake tailnet, the request is passed along

TailscaleMiddleware do
  allow do
    tailnet "black-cat"
    route "/secrets"
  end

  allow do
    tailnet "crab-cake"
    route "/staff"
  end
end

In this example:

1. If your client is does not request anything under /secrets or /staff, the request is passed along
2. If your client requests something under /secrets, but is not connected to the black-cat tailnet, the request is denied
3. If your client requests something under /secrets, and is connected to the black-cat tailnet, the request is passed along
4. If your client requests something under /staff, but is not connected to the crab-cake tailnet, the request is denied
5. If your client requests something under /staff, and is connected to the crab-cake tailnet, the request is passed along

Pass these options along with the middleware, like:

Rails.application.config.middleware.insert_before 0, TailscaleMiddleware, debug: false, logger: (-> { Rails.logger }) do

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/gjtorikian/tailscale_middleware. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the TailscaleMiddleware project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.