Skip to content

webui.md

Latest commit

 

History

History
72 lines (50 loc) · 2.21 KB

webui.md

File metadata and controls

72 lines (50 loc) · 2.21 KB
Raw

Sidekiq 8.0 Web Configuration

Quick Jump

Sidekiq 8.0 revises how Sidekiq::Web is configured.

The Problem

Before 8.0, Sidekiq used global class-methods on the Sidekiq::Web class to access and configure various options. The lack of idiomatic API made me hesitant to add more configuration knobs to Sidekiq::Web.

Sidekiq::Web.app_link "https://acmecorp.com"
Sidekiq::Web.register MyExtension
Sidekiq::Web.use Some::Rack::Middleware

The Solution

Sidekiq::Web::Config

The above API is essentially wrapped in a configure block. You can:

  1. Register 3rd party Web UI extensions
  2. Allow you to add Rack middleware for authentication or authorization
  3. Configure minor UI tweaks
require "sidekiq/web"
Sidekiq::Web.configure do |config|
  config.register(MyExtension, name: "myext", tab: "TabName", index: "tabpage/")
  config.use Some::Rack::Middleware
  config.app_url "https://acmecorp.com" # Adds "Back to App" button in the UI
end

See lib/sidekiq/web/config.rb for options.

Web UI Extensions

There is a sample Web UI extension in examples/webui-ext which shows you how to build your own UI extension. Sidekiq 8.0 took a number of steps to improve security.

Parameters

Starting in 8.0 we distinguish between URL parameters (query parameters) and route parameters (variables in the URL). Assume your extension has an endpoint like so:

# https://acmecorp.com/sidekiq/batches/b-123abc?size=10
get "/batches/:bid" do
  route_params(:bid) # => "b-123abc"
  url_params("size") # => "10"
end

Note that each param type uses Strings or Symbols so you can't mistake one for the other. This ensures an attacker can't override the bid by adding a query parameter.

https://acmecorp.com/sidekiq/batches/b-123abc?size=10&bid=b-456def

Assets

Sidekiq::Web 8.0 further locks down its Content-Security-Policy by requiring all assets to tag themselves with a per-request nonce, which makes it impossible to inject a malicious asset via XSS.

This can be done automatically for you by using the new stylesheet_tag or script_tag helpers in lib/sidekiq/web/helpers.rb.