パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.1.5

shelf_cors_headers

Shelf用のCORSヘッダーmiddleware。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
4.2万
いいね数
41
Pub ポイント
140

パッケージをインストール

flutter pub add shelf_cors_headers

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Shelf CORS Headers は、Shelf フレームワーク向けのミドルウェアパッケージであり、HTTP 応答にクロスオリジンリソース共有(CORS)ヘッダーを追加することを簡素化します。このパッケージは、許可されたオリジン、メソッド、ヘッダー、資格情報の設定により、Shelf を使って構築されたサーバーサイドアプリケーションが、安全にクロスオリジンリクエストを処理できるようにします。既存の Shelf ベースのサーバーにシームレスに統合でき、複数のプラットフォームにおける Web サービスでの CORS ポリシー管理を軽量かつカスタマイズ可能な方法で実現します。

用途

  • ShelfベースのAPIでクロスオリジンリクエストを有効化する
  • 制御されたアクセスポリシーによるWebサービスのセキュリティ確保
  • 異なるドメインにホストされているフロントエンドアプリをサポート
  • Flutter Web バックエンドへの CORS の統合
  • プリフライトリクエストの自動処理

主な機能

  • 設定可能な許可されたオリジン
  • カスタムヘッダーとメソッドのサポート
  • OPTIONS プリフライト要求の自動処理
  • Shelf ルーターとの簡単な統合
  • 資格証明および最大年齢のための柔軟な構成

適している対象

  • バックエンドロジックに Shelf を使用する開発者
  • Flutter開発者がWeb APIを構築しています
  • セキュアなRESTfulサービスを実装するチーム
  • 細粒度のCORS制御を必要とするアプリケーション
  • 複数のプラットフォームをターゲットとするサーバーサイドのDartプロジェクト

注意事項

  • CORS基準についての基本的な理解が必要です
  • スタンドアロンのクライアントサイドでの使用には適していません
  • 本番環境では構成を慎重に管理する必要があります
  • CORSを超えるリクエスト検証は含まれません
  • シェルフベースのサーバーエンバイロメントに限定

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

CORS headers middleware for Shelf

A Shelf middleware to add CORS headers to shelf responses.

Features

  • Handles preflight requests.
  • Allows override of default headers.
  • Allows user to provide their own origin checker function.

Usage

A simple usage example:

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

void main() async {
  var handler = const Pipeline()
      // Just add corsHeaders() middleware.
      .addMiddleware(corsHeaders())
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}
Override Headers
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    ACCESS_CONTROL_ALLOW_ORIGIN: 'example.com',
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your header overrides.
      .addMiddleware(corsHeaders(headers: overrideHeaders))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}
Custom origin checker

Your origin checker function should consume a string as a parameter(the value of ORIGIN header) and return a boolean value indicating if this middleware should process the request from that origin.

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

// define our origin checker
bool dontCheckCNNRequests(String origin) {
  if (origin.contains('cnn.com')) return false;
  return true;
}

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your origin checker
      .addMiddleware(corsHeaders(headers: overrideHeaders, originChecker: dontCheckCNNRequests))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}

You can also use the inbuilt originOneOf which takes a list of origins to check:

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

// define our origin checker
final listChecker = originOneOf(['https://cnn.com', 'https://dart.dev'])

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your origin checker
      .addMiddleware(corsHeaders(headers: overrideHeaders, originChecker: listChecker))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}

カテゴリー

依存関係

依存関係一覧 1 件

ソースリポジトリ

このパッケージを使用しているプロジェクト