ページ内の SQLly: リレープロキシモード

実装済み

自分で管理するリレー経由で、自分のデータベースに対してブラウザ版ビルドを実行します。認証情報はリレーが保持するため、ページがパスワードを知ることはありません。

その ブラウザービルド 版の SQLly は通常、Web ページがデータベースソケットを開けないため、タブ内のサンプルデータに対して実行されます。 リレープロキシモード 実際のサーバーを与えます: sqlly-relay 実行したものには次が渡されます 認証情報ファイル、そしてそのリレーのアドレスで開いたブラウザー版は、ファイル内のすべてのサーバーとデータベースにクエリできます。オブジェクトエクスプローラー、IntelliSense、実行プラン、行の編集もすべて含まれ、パスワードがリレーホストの外に出ることはありません。

対象となる方。 ページ、社内ポータル、サポートコンソール、教室などで、インストール不要の SQLly を、管理者が管理する固定のデータベースに対して使いたいチーム。これは ではなく デスクトップアプリの リレー経由 パス: あちらはエンドツーエンドで暗号化されているため、リレーは通信内容を読めません。こちらでは意図的にリレーが資格情報を保持するので、ブラウザータブが保持する必要はありません。

全体の構成

browser (SQLly on a page)  --wss-->  sqlly-relay proxy  --local-->  SQLly engine  --TDS / PG / MySQL / ...-->  your databases
                                     holds the credential file        one per browser session
  • リレーは、クレデンシャルファイルを提供します。 その中のすべての接続 (サーバー、データベース、ログイン、パスワード、共有ログイン、SSH トンネル、プロキシ、クライアント・プロジェクト・環境のラベル) が、ブラウザーから到達できるすべてです。それ以外はありません。
  • セッションごとに 1 つのエンジン。 各ブラウザーセッションにはリレーホスト上に専用の SQLly エンジンが割り当てられ、ファイルに記載された接続だけを開くロックダウンモードで起動します。独自のサーバーを指定したり、独自のパスワードを含んだりするリクエストは拒否されます。
  • ブラウザーが受け取るのは名前だけで、シークレットは受け取りません。 パスワード、トンネル設定、トークンを取り除いた接続リストを受け取ります。リレーはページを読み込むたびに新しく送信するため、リストを保存することはありません。
  • リレーのもう一つの役割には影響しません。 プロキシは、独立したオプトインのリスナーです。これを有効にしていないリレーは、「リレー経由」のトラフィックを、従来とまったく同じように転送します。

リレーを設定する

データベースに到達でき、次を備えたホストで、 sqlly-cli の隣にインストールされます sqlly-relay、資格情報ファイルを書き込みます(デスクトップアプリで次を使ってエクスポートできます ファイル → 接続をエクスポート (認証情報付き)…、または手書きします)。通常の設定にプロキシ用のフラグを追加してリレーを起動します:

sqlly-relay \
  --tls-cert /certs/relay.crt --tls-key /certs/relay.key \
  --proxy-credentials /etc/sqlly/browser-connections.json \
  --proxy-token 'a-long-random-secret' \
  --proxy-bind 0.0.0.0:8444 \
  --proxy-allowed-origins https://sqlly.app
フラグ何ができるか
--proxy-credentials資格情報ファイル。これを設定すると、プロキシが有効になります。ファイルは新しいブラウザーセッションごとに再読み込みされるため、編集は再起動なしで反映されます。
--proxy-tokenブラウザーが提示しなければならない共有シークレット。必須です。これがないと、リレーは起動を拒否します(次を指定した場合を除く --proxy-insecure-no-token、ポートに到達できる相手には誰でも、一覧にあるすべてのデータベースを提供します。
--proxy-bindプロキシが待ち受ける場所です。既定はポート 8444 です。リレーの TLS 証明書を、次のために使用します wss://; --proxy-plain 提供します ws:// ローカルでのテスト用、または TLS を終端するリバースプロキシの背後で使用する場合。
--proxy-allowed-originsセッションを開くことを許可するオリジン(Web オリジン)のカンマ区切りリスト。これにより、自分がホストしているページだけがプロキシを使えます。省略すると任意のオリジンを許可します(トークンは引き続き適用されます)。
--proxy-max-sessions同時に開けるブラウザーセッションの数(各セッションは 1 つのエンジンプロセス)。既定値は 32 です。満杯になったプロキシは、新しいセッションに後で再試行するよう求めます。
--proxy-engine-binary場所 sqlly-cli つまり、次の隣にない場合は sqlly-relay または次の上で PATH.

すべてのフラグには環境変数の形式があります (RELAY_PROXY_CREDENTIALS, RELAY_PROXY_TOKEN、など)。リレーのコンテナーイメージには、次のフラグを付けてビルドした場合にエンジンが含まれます --build-arg WITH_PROXY_ENGINE=1.

デスクトップ版のインポートとは 2 つのルールが異なります。共有ログインとトンネルプロファイルは同じファイルで定義する必要があります(リレーには、代わりに使える保存済み接続がありません)。また、 via-relay リレーホストが自ら各サーバーに接続するため、接続に指定されたルートは無視されます。

ブラウザー版をそれに向けて開く

ブラウザービルドの URL にプロキシのアドレスとトークンを追加します:

https://sqlly.app/app/?proxy=wss://relay.example.com:8444/proxy&token=a-long-random-secret

ビルドを埋め込むページでは、次を設定できます SQLLY_PROXY_URL そして SQLLY_PROXY_TOKEN アプリの起動前にアドレスバーに入れるのではなくグローバル変数として。読み込み時にアプリが接続し、ステータス行にリレーの名前と提供する接続数が表示され、それらの接続はすぐに使える状態でエクスプローラーに表示されます。このモードでは、サンプルデータベースは一切ダウンロードされません。

ページを自分でホストする。 ブラウザーは、セキュリティ ポリシーで許可されたオリジンにのみ、ページがソケットを開くことを許します。sqlly.app が配信するビルドは自分自身のオリジンを許可しています。別のホストのプロキシを使う場合は、そのポリシーを広げるか、リレー自身のドメインからビルドを配信する必要があります。ページは読み込めるのにリレー プロキシに到達できないと表示される場合、まずここを確認してください。

アプリでの変更点

  • 接続は読み取り専用です。 一覧はリレー側のものです。サーバーの追加、複製、削除、接続のインポートは無効になり、接続マネージャーの追加、削除、複製の各ボタンとクライアント、プロジェクト、環境の各エディターはロックされ、接続を開くと次のラベルで開きます 接続の表示 保存は無効になり、リレーが資格情報を持っている旨の注記が表示されます。ユーザーに表示される内容を変えるには、リレー上の資格情報ファイルを変更します。
  • 接続テストは引き続き動作します - 他のクエリと同様にプロキシ経由で実行され、すべてのクエリ機能、オブジェクトエクスプローラー、IntelliSense カタログの同期、実行プラン、スクリプト生成、行の編集も同様です。
  • ラベルも一緒に引き継がれます。 ファイル内のクライアント、プロジェクト、環境の名前・色・安全スイッチは、デスクトップ版と同じようにエクスプローラーをグループ化します。ページを軽く保つため、アイコンは省略されています。
  • リレーがなくなった場合 - ステータス行にその旨が表示され、ページを再読み込みするまで、プロキシ経由の接続でのクエリは分かりやすいメッセージとともに失敗します。