[ { "path": ".clippy.toml", "content": "disallowed-names = [\n \"..\",\n \"e\", # no single letter error bindings\n]\ndisallowed-methods = [\n { path = \"std::cell::RefCell::default()\", reason = \"prefer explicit inner type default (remove allow-invalid when rust-lang/rust-clippy/#8581 is fixed)\", allow-invalid = true },\n { path = \"std::rc::Rc::default()\", reason = \"prefer explicit inner type default (remove allow-invalid when rust-lang/rust-clippy/#8581 is fixed)\", allow-invalid = true },\n]\n" }, { "path": ".codecov.yml", "content": "comment: false\n\ncoverage:\n status:\n project:\n default:\n threshold: 100% # make CI green\n patch:\n default:\n threshold: 100% # make CI green\n\nignore: # ignore code coverage on following paths\n - \"**/tests\"\n - \"**/benches\"\n - \"**/examples\"\n" }, { "path": ".cspell.yml", "content": "version: \"0.2\"\nwords:\n - actix\n - addrs\n - ALPN\n - bytestring\n - httparse\n - MSRV\n - realip\n - rustls\n - rustup\n - serde\n - uring\n - webpki\n - zstd\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: [robjtede, JohnTitor]\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug Report\nabout: Create a bug report.\n---\n\nYour issue may already be reported! Please search on the [Actix Web issue tracker](https://github.com/actix/actix-web/issues) before creating one.\n\n## Expected Behavior\n\n\n\n\n## Current Behavior\n\n\n\n\n## Possible Solution\n\n\n\n\n## Steps to Reproduce (for bugs)\n\n\n\n\n1.\n2.\n3.\n4.\n\n## Context\n\n\n\n\n## Your Environment\n\n\n\n- Rust Version (I.e, output of `rustc -V`):\n- Actix Web Version:\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: true\ncontact_links:\n - name: Actix Discord\n url: https://discord.gg/NWpN5mmg3x\n about: Actix developer discussion and community chat\n - name: GitHub Discussions\n url: https://github.com/actix/actix-web/discussions\n about: Actix Web Q&A\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "\n\n\n## PR Type\n\n\n\n\nPR_TYPE\n\n## PR Checklist\n\n\n\n\n- [ ] Tests for the changes have been added / updated.\n- [ ] Documentation comments have been added / updated.\n- [ ] A changelog entry has been made for the appropriate packages.\n- [ ] Format code with the latest stable rustfmt.\n- [ ] (Team) Label with affected crates and semver status.\n\n## Overview\n\n\n\n\n\n\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: github-actions\n directory: /\n schedule:\n interval: weekly\n - package-ecosystem: cargo\n directory: /\n schedule:\n interval: weekly\n versioning-strategy: lockfile-only\n" }, { "path": ".github/labeler.yml", "content": "A-files:\n - changed-files:\n - any-glob-to-any-file: actix-files/**\n\nA-http:\n - changed-files:\n - any-glob-to-any-file: actix-http/**\n\nA-http-test:\n - changed-files:\n - any-glob-to-any-file: actix-http-test/**\n\nA-multipart:\n - changed-files:\n - any-glob-to-any-file: actix-multipart/**\n\nA-multipart-derive:\n - changed-files:\n - any-glob-to-any-file: actix-multipart-derive/**\n\nA-router:\n - changed-files:\n - any-glob-to-any-file: actix-router/**\n\nA-test:\n - changed-files:\n - any-glob-to-any-file: actix-test/**\n\nA-web:\n - changed-files:\n - any-glob-to-any-file: actix-web/**\n\nA-web-actors:\n - changed-files:\n - any-glob-to-any-file: actix-web-actors/**\n\nA-web-codegen:\n - changed-files:\n - any-glob-to-any-file: actix-web-codegen/**\n\nA-awc:\n - changed-files:\n - any-glob-to-any-file: awc/**\n" }, { "path": ".github/workflows/bench.yml", "content": "name: Benchmark\n\non:\n push:\n branches: [main]\n\npermissions:\n contents: read\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n check_benchmark:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust\n run: |\n rustup set profile minimal\n rustup install nightly\n rustup override set nightly\n\n - name: Check benchmark\n run: cargo bench --bench=server -- --sample-size=15\n" }, { "path": ".github/workflows/ci-post-merge.yml", "content": "name: CI (post-merge)\n\non:\n push:\n branches: [main]\n\npermissions:\n contents: read\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n build_and_test_nightly:\n strategy:\n fail-fast: false\n matrix:\n # prettier-ignore\n target:\n - { name: Linux, os: ubuntu-latest, triple: x86_64-unknown-linux-gnu }\n - { name: macOS, os: macos-latest, triple: x86_64-apple-darwin }\n - { name: Windows, os: windows-latest, triple: x86_64-pc-windows-msvc }\n version:\n - { name: nightly, version: nightly }\n\n name: ${{ matrix.target.name }} / ${{ matrix.version.name }}\n runs-on: ${{ matrix.target.os }}\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install nasm\n if: matrix.target.os == 'windows-latest'\n uses: ilammy/setup-nasm@72793074d3c8cdda771dba85f6deafe00623038b # v1.5.2\n\n - name: Install OpenSSL\n if: matrix.target.os == 'windows-latest'\n shell: bash\n run: |\n set -e\n choco install openssl --version=1.1.1.2100 -y --no-progress\n echo 'OPENSSL_DIR=C:\\Program Files\\OpenSSL' >> $GITHUB_ENV\n echo \"RUSTFLAGS=-C target-feature=+crt-static\" >> $GITHUB_ENV\n\n - name: Install Rust (${{ matrix.version.name }})\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: ${{ matrix.version.version }}\n\n - name: Install just, cargo-hack, cargo-nextest, cargo-ci-cache-clean\n uses: taiki-e/install-action@f916cfac5d8efd040e250d0cd6b967616504b3a4 # v2.68.32\n with:\n tool: just,cargo-hack,cargo-nextest,cargo-ci-cache-clean\n\n - name: check minimal\n run: just check-min\n\n - name: check default\n run: just check-default\n\n - name: tests\n timeout-minutes: 60\n run: just test\n\n - name: CI cache clean\n run: cargo-ci-cache-clean\n\n ci_feature_powerset_check:\n name: Verify Feature Combinations\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Free Disk Space\n run: ./scripts/free-disk-space.sh\n\n - name: Setup mold linker\n uses: rui314/setup-mold@725a8794d15fc7563f59595bd9556495c0564878 # v1\n\n - name: Install Rust\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n\n - name: Install just, cargo-hack\n uses: taiki-e/install-action@f916cfac5d8efd040e250d0cd6b967616504b3a4 # v2.68.32\n with:\n tool: just,cargo-hack\n\n - name: Check feature combinations\n run: just check-feature-combinations\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n pull_request:\n types: [opened, synchronize, reopened]\n merge_group:\n types: [checks_requested]\n push:\n branches: [main]\n\npermissions:\n contents: read\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n read_msrv:\n name: Read MSRV\n uses: actions-rust-lang/msrv/.github/workflows/msrv.yml@8b553824444060021f2843d7b4d803f3624d15e5 # v0.1.0\n\n build_and_test:\n needs: read_msrv\n\n strategy:\n fail-fast: false\n matrix:\n # prettier-ignore\n target:\n - { name: Linux, os: ubuntu-latest, triple: x86_64-unknown-linux-gnu }\n - { name: macOS, os: macos-latest, triple: x86_64-apple-darwin }\n - { name: Windows, os: windows-latest, triple: x86_64-pc-windows-msvc }\n version:\n - { name: msrv, version: \"${{ needs.read_msrv.outputs.msrv }}\" }\n - { name: stable, version: stable }\n\n name: ${{ matrix.target.name }} / ${{ matrix.version.name }}\n runs-on: ${{ matrix.target.os }}\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install nasm\n if: matrix.target.os == 'windows-latest'\n uses: ilammy/setup-nasm@72793074d3c8cdda771dba85f6deafe00623038b # v1.5.2\n\n - name: Install OpenSSL\n if: matrix.target.os == 'windows-latest'\n shell: bash\n run: |\n set -e\n choco install openssl --version=1.1.1.2100 -y --no-progress\n echo 'OPENSSL_DIR=C:\\Program Files\\OpenSSL' >> $GITHUB_ENV\n echo \"RUSTFLAGS=-C target-feature=+crt-static\" >> $GITHUB_ENV\n\n - name: Setup mold linker\n if: matrix.target.os == 'ubuntu-latest'\n uses: rui314/setup-mold@725a8794d15fc7563f59595bd9556495c0564878 # v1\n\n - name: Install Rust (${{ matrix.version.name }})\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: ${{ matrix.version.version }}\n\n - name: Install just, cargo-hack, cargo-nextest, cargo-ci-cache-clean\n uses: taiki-e/install-action@f916cfac5d8efd040e250d0cd6b967616504b3a4 # v2.68.32\n with:\n tool: just,cargo-hack,cargo-nextest,cargo-ci-cache-clean\n\n - name: workaround MSRV issues\n if: matrix.version.name == 'msrv'\n run: just downgrade-for-msrv\n\n - name: check minimal\n run: just check-min\n\n - name: check default\n run: just check-default\n\n - name: tests\n timeout-minutes: 30\n run: just test\n\n - name: CI cache clean\n run: cargo-ci-cache-clean\n\n - name: deny check\n if: matrix.version.name == 'stable' && matrix.target.os == 'ubuntu-latest'\n uses: EmbarkStudios/cargo-deny-action@3fd3802e88374d3fe9159b834c7714ec57d6c979 # v2.0.15\n\n io-uring:\n name: io-uring tests\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: nightly\n\n - name: tests (io-uring)\n timeout-minutes: 30\n run: >\n sudo bash -c \"ulimit -Sl 512 && ulimit -Hl 512 && PATH=$PATH:/usr/share/rust/.cargo/bin && RUSTUP_TOOLCHAIN=stable cargo test --lib --tests -p=actix-files --all-features\"\n\n rustdoc:\n name: doc tests\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust (nightly)\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: nightly\n\n - name: Install just\n uses: taiki-e/install-action@f916cfac5d8efd040e250d0cd6b967616504b3a4 # v2.68.32\n with:\n tool: just\n\n - name: doc tests\n run: just test-docs\n" }, { "path": ".github/workflows/coverage.yml", "content": "name: Coverage\n\non:\n push:\n branches: [main]\n\npermissions:\n contents: read\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n coverage:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust (nightly)\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: nightly\n components: llvm-tools\n\n - name: Install just, cargo-llvm-cov, cargo-nextest\n uses: taiki-e/install-action@f916cfac5d8efd040e250d0cd6b967616504b3a4 # v2.68.32\n with:\n tool: just,cargo-llvm-cov,cargo-nextest\n\n - name: Generate code coverage\n run: just test-coverage-codecov\n\n - name: Upload coverage to Codecov\n uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2\n with:\n files: codecov.json\n fail_ci_if_error: true\n env:\n CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}\n" }, { "path": ".github/workflows/labeler.yml", "content": "name: Labeler\n\non:\n pull_request_target:\n types: [opened, synchronize, reopened]\n\npermissions:\n contents: read\n pull-requests: write\n\njobs:\n labeler:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - uses: actions/labeler@634933edcd8ababfe52f92936142cc22ac488b1b # v6.0.1\n" }, { "path": ".github/workflows/lint.yml", "content": "name: Lint\n\non:\n pull_request:\n types: [opened, synchronize, reopened]\n\npermissions:\n contents: read\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n fmt:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust (nightly)\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: nightly\n components: rustfmt\n\n - name: Check with Rustfmt\n run: cargo fmt --all -- --check\n\n clippy:\n permissions:\n contents: read\n checks: write # to add clippy checks to PR diffs\n\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n components: clippy\n\n - name: Check with Clippy\n uses: giraffate/clippy-action@13b9d32482f25d29ead141b79e7e04e7900281e0 # v1.0.1\n with:\n reporter: github-pr-check\n github_token: ${{ secrets.GITHUB_TOKEN }}\n clippy_flags: >-\n --workspace --all-features --tests --examples --bins --\n -A unknown_lints -D clippy::todo -D clippy::dbg_macro\n\n lint-docs:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust (nightly)\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: nightly\n components: rust-docs\n\n - name: Check for broken intra-doc links\n env:\n RUSTDOCFLAGS: -D warnings\n run: cargo +nightly doc --no-deps --workspace --all-features\n\n check-external-types:\n if: false # rustdoc mismatch currently\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Rust (${{ vars.RUST_VERSION_EXTERNAL_TYPES }})\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: ${{ vars.RUST_VERSION_EXTERNAL_TYPES }}\n\n - name: Install just\n uses: taiki-e/install-action@f916cfac5d8efd040e250d0cd6b967616504b3a4 # v2.68.32\n with:\n tool: just\n\n - name: Install cargo-check-external-types\n uses: taiki-e/cache-cargo-install-action@59027ebf20a9617c4e819eb53ccd2673cb162b89 # v3.0.3\n with:\n tool: cargo-check-external-types\n\n - name: check external types\n run: just check-external-types-all +${{ vars.RUST_VERSION_EXTERNAL_TYPES }}\n" }, { "path": ".github/workflows/semver-labeler.yml", "content": "name: Semver Labeler\n\non:\n workflow_run:\n workflows: [CI]\n types: [completed]\n\njobs:\n semver-label:\n runs-on: ubuntu-latest\n permissions:\n pull-requests: write\n contents: read\n env:\n ACTIONS_STEP_DEBUG: true\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n ref: ${{ github.event.workflow_run.head_sha }}\n\n - name: Install Rust\n uses: actions-rust-lang/setup-rust-toolchain@150fca883cd4034361b621bd4e6a9d34e5143606 # v1.15.4\n with:\n toolchain: stable\n\n - uses: JohnTitor/cargo-semver-checks@3b76737b550e48ad0bd5912e2757e80eee6294b0 # v0.2.1\n with:\n label-prefix: B-semver-\n label-strategy: skip-if-human\n" }, { "path": ".gitignore", "content": "target/\nguide/build/\n/gh-pages\n\n*.so\n*.out\n*.pyc\n*.pid\n*.sock\n*~\n.DS_Store\n\n# These are backup files generated by rustfmt\n**/*.rs.bk\n\n# Configuration directory generated by CLion\n.idea\n\n# Configuration directory generated by VSCode\n.vscode\n\n# code coverage\n/lcov.info\n/codecov.json\n" }, { "path": ".prettierrc.yml", "content": "overrides:\n - files: \"*.md\"\n options:\n printWidth: 9999\n proseWrap: never\n" }, { "path": ".rustfmt.toml", "content": "group_imports = \"StdExternalCrate\"\nimports_granularity = \"Crate\"\nuse_field_init_shorthand = true\n" }, { "path": ".taplo.toml", "content": "exclude = [\"target/*\"]\ninclude = [\"**/*.toml\"]\n\n[formatting]\ncolumn_width = 100\nalign_comments = false\n\n[[rule]]\ninclude = [\"**/Cargo.toml\"]\nkeys = [\"features\"]\nformatting.column_width = 105\nformatting.reorder_keys = false\n\n[[rule]]\ninclude = [\"**/Cargo.toml\"]\nkeys = [\n \"dependencies\",\n \"*-dependencies\",\n \"workspace.dependencies\",\n \"workspace.*-dependencies\",\n \"target.*.dependencies\",\n \"target.*.*-dependencies\",\n]\nformatting.column_width = 120\nformatting.reorder_keys = true\n\n[[rule]]\ninclude = [\"**/Cargo.toml\"]\nkeys = [\n \"dependencies.*\",\n \"*-dependencies.*\",\n \"workspace.dependencies.*\",\n \"workspace.*-dependencies.*\",\n \"target.*.dependencies\",\n \"target.*.*-dependencies\",\n]\nformatting.column_width = 120\nformatting.reorder_keys = false\n" }, { "path": "CHANGES.md", "content": "# Changelog\n\nChangelogs are kept separately for each crate in this repo.\n\nActix Web changelog [is now here →](./actix-web/CHANGES.md).\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n- Using welcoming and inclusive language\n- Being respectful of differing viewpoints and experiences\n- Gracefully accepting constructive criticism\n- Focusing on what is best for the community\n- Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n- The use of sexualized language or imagery and unwelcome sexual attention or advances\n- Trolling, insulting/derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or electronic address, without explicit permission\n- Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at robjtede@icloud.com ([@robjtede]) or huyuumi@neet.club ([@JohnTitor]). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n[@robjtede]: https://github.com/robjtede\n[@JohnTitor]: https://github.com/JohnTitor\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "Cargo.toml", "content": "[workspace]\nresolver = \"2\"\nmembers = [\n \"actix-files\",\n \"actix-http-test\",\n \"actix-http\",\n \"actix-multipart\",\n \"actix-multipart-derive\",\n \"actix-router\",\n \"actix-test\",\n \"actix-web-codegen\",\n \"actix-web\",\n \"awc\",\n]\n\n[workspace.package]\nhomepage = \"https://actix.rs\"\nrepository = \"https://github.com/actix/actix-web\"\nlicense = \"MIT OR Apache-2.0\"\nedition = \"2021\"\nrust-version = \"1.88\"\n\n[profile.dev]\n# Disabling debug info speeds up builds a bunch and we don't rely on it for debugging that much.\ndebug = 0\n\n[profile.release]\nlto = true\nopt-level = 3\ncodegen-units = 1\n\n[patch.crates-io]\nactix-files = { path = \"actix-files\" }\nactix-http = { path = \"actix-http\" }\nactix-http-test = { path = \"actix-http-test\" }\nactix-multipart = { path = \"actix-multipart\" }\nactix-multipart-derive = { path = \"actix-multipart-derive\" }\nactix-router = { path = \"actix-router\" }\nactix-test = { path = \"actix-test\" }\nactix-web = { path = \"actix-web\" }\nactix-web-codegen = { path = \"actix-web-codegen\" }\nawc = { path = \"awc\" }\n\n# uncomment for quick testing against local actix-net repo\n# actix-service = { path = \"../actix-net/actix-service\" }\n# actix-macros = { path = \"../actix-net/actix-macros\" }\n# actix-rt = { path = \"../actix-net/actix-rt\" }\n# actix-codec = { path = \"../actix-net/actix-codec\" }\n# actix-utils = { path = \"../actix-net/actix-utils\" }\n# actix-tls = { path = \"../actix-net/actix-tls\" }\n# actix-server = { path = \"../actix-net/actix-server\" }\n\n[workspace.lints.rust]\nrust_2018_idioms = { level = \"deny\" }\nfuture_incompatible = { level = \"deny\" }\nnonstandard_style = { level = \"deny\" }\n\n[workspace.lints.clippy]\n# clone_on_ref_ptr = { level = \"deny\" }\n" }, { "path": "LICENSE-APACHE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"{}\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright 2017-NOW Actix Team\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "LICENSE-MIT", "content": "Copyright (c) 2017-NOW Actix Team\n\nPermission is hereby granted, free of charge, to any\nperson obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the\nSoftware without restriction, including without\nlimitation the rights to use, copy, modify, merge,\npublish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software\nis furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice\nshall be included in all copies or substantial portions\nof the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF\nANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED\nTO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A\nPARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT\nSHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR\nIN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\nDEALINGS IN THE SOFTWARE.\n" }, { "path": "actix-files/CHANGES.md", "content": "# Changes\n\n## Unreleased\n\n- Add `Files::try_compressed()` to support serving pre-compressed static files [#2615]\n- Fix handling of `bytes=0-`\n- Fix `NamedFile` panic when serving files with pre-UNIX epoch modification times. [#2748]\n- Fix invalid `Content-Encoding: identity` header in `NamedFile` range responses. [#3191]\n\n[#2615]: https://github.com/actix/actix-web/pull/2615\n[#2748]: https://github.com/actix/actix-web/issues/2748\n[#3191]: https://github.com/actix/actix-web/issues/3191\n\n## 0.6.10\n\n### Security Notice\n\nWe addressed 2 vulnerabilities in this release:\n\n- Do not panic with empty Range header.\n- Avoid serving CWD on invalid `Files::new` inputs.\n\nWe encourage updating your `actix-files` version as soon as possible.\n\n### Other changes\n\n- Minimum supported Rust version (MSRV) is now 1.88.\n- `PathBufWrap` & `UriSegmentError` made public. [#3694]\n\n[#3694]: https://github.com/actix/actix-web/pull/3694\n\n## 0.6.9\n\n- Correct `derive_more` dependency feature requirements.\n\n## 0.6.8\n\n- Add `Files::with_permanent_redirect()` method.\n- Change default redirect status code to 307 Temporary Redirect.\n\n## 0.6.7\n\n- Add `{Files, NamedFile}::read_mode_threshold()` methods to allow faster synchronous reads of small files.\n- Minimum supported Rust version (MSRV) is now 1.75.\n\n## 0.6.6\n\n- Update `tokio-uring` dependency to `0.4`.\n- Minimum supported Rust version (MSRV) is now 1.72.\n\n## 0.6.5\n\n- Fix handling of special characters in filenames.\n\n## 0.6.4\n\n- Fix handling of newlines in filenames.\n- Minimum supported Rust version (MSRV) is now 1.68 due to transitive `time` dependency.\n\n## 0.6.3\n\n- XHTML files now use `Content-Disposition: inline` instead of `attachment`. [#2903]\n- Minimum supported Rust version (MSRV) is now 1.59 due to transitive `time` dependency.\n- Update `tokio-uring` dependency to `0.4`.\n\n[#2903]: https://github.com/actix/actix-web/pull/2903\n\n## 0.6.2\n\n- Allow partial range responses for video content to start streaming sooner. [#2817]\n- Minimum supported Rust version (MSRV) is now 1.57 due to transitive `time` dependency.\n\n[#2817]: https://github.com/actix/actix-web/pull/2817\n\n## 0.6.1\n\n- Add `NamedFile::{modified, metadata, content_type, content_disposition, encoding}()` getters. [#2021]\n- Update `tokio-uring` dependency to `0.3`.\n- Audio files now use `Content-Disposition: inline` instead of `attachment`. [#2645]\n- Minimum supported Rust version (MSRV) is now 1.56 due to transitive `hashbrown` dependency.\n\n[#2021]: https://github.com/actix/actix-web/pull/2021\n[#2645]: https://github.com/actix/actix-web/pull/2645\n\n## 0.6.0\n\n- No significant changes since `0.6.0-beta.16`.\n\n## 0.6.0-beta.16\n\n- No significant changes since `0.6.0-beta.15`.\n\n## 0.6.0-beta.15\n\n- No significant changes since `0.6.0-beta.14`.\n\n## 0.6.0-beta.14\n\n- The `prefer_utf8` option introduced in `0.4.0` is now true by default. [#2583]\n\n[#2583]: https://github.com/actix/actix-web/pull/2583\n\n## 0.6.0-beta.13\n\n- The `Files` service now rejects requests with URL paths that include `%2F` (decoded: `/`). [#2398]\n- The `Files` service now correctly decodes `%25` in the URL path to `%` for the file path. [#2398]\n- Minimum supported Rust version (MSRV) is now 1.54.\n\n[#2398]: https://github.com/actix/actix-web/pull/2398\n\n## 0.6.0-beta.12\n\n- No significant changes since `0.6.0-beta.11`.\n\n## 0.6.0-beta.11\n\n- No significant changes since `0.6.0-beta.10`.\n\n## 0.6.0-beta.10\n\n- No significant changes since `0.6.0-beta.9`.\n\n## 0.6.0-beta.9\n\n- Add crate feature `experimental-io-uring`, enabling async file I/O to be utilized. This feature is only available on Linux OSes with recent kernel versions. This feature is semver-exempt. [#2408]\n- Add `NamedFile::open_async`. [#2408]\n- Fix 304 Not Modified responses to omit the Content-Length header, as per the spec. [#2453]\n- The `Responder` impl for `NamedFile` now has a boxed future associated type. [#2408]\n- The `Service` impl for `NamedFileService` now has a boxed future associated type. [#2408]\n- Add `impl Clone` for `FilesService`. [#2408]\n\n[#2408]: https://github.com/actix/actix-web/pull/2408\n[#2453]: https://github.com/actix/actix-web/pull/2453\n\n## 0.6.0-beta.8\n\n- Minimum supported Rust version (MSRV) is now 1.52.\n\n## 0.6.0-beta.7\n\n- Minimum supported Rust version (MSRV) is now 1.51.\n\n## 0.6.0-beta.6\n\n- Added `Files::path_filter()`. [#2274]\n- `Files::show_files_listing()` can now be used with `Files::index_file()` to show files listing as a fallback when the index file is not found. [#2228]\n\n[#2274]: https://github.com/actix/actix-web/pull/2274\n[#2228]: https://github.com/actix/actix-web/pull/2228\n\n## 0.6.0-beta.5\n\n- `NamedFile` now implements `ServiceFactory` and `HttpServiceFactory` making it much more useful in routing. For example, it can be used directly as a default service. [#2135]\n- For symbolic links, `Content-Disposition` header no longer shows the filename of the original file. [#2156]\n- `Files::redirect_to_slash_directory()` now works as expected when used with `Files::show_files_listing()`. [#2225]\n- `application/{javascript, json, wasm}` mime type now have `inline` disposition by default. [#2257]\n\n[#2135]: https://github.com/actix/actix-web/pull/2135\n[#2156]: https://github.com/actix/actix-web/pull/2156\n[#2225]: https://github.com/actix/actix-web/pull/2225\n[#2257]: https://github.com/actix/actix-web/pull/2257\n\n## 0.6.0-beta.4\n\n- Add support for `.guard` in `Files` to selectively filter `Files` services. [#2046]\n\n[#2046]: https://github.com/actix/actix-web/pull/2046\n\n## 0.6.0-beta.3\n\n- No notable changes.\n\n## 0.6.0-beta.2\n\n- Fix If-Modified-Since and If-Unmodified-Since to not compare using sub-second timestamps. [#1887]\n- Replace `v_htmlescape` with `askama_escape`. [#1953]\n\n[#1887]: https://github.com/actix/actix-web/pull/1887\n[#1953]: https://github.com/actix/actix-web/pull/1953\n\n## 0.6.0-beta.1\n\n- `HttpRange::parse` now has its own error type.\n- Update `bytes` to `1.0`. [#1813]\n\n[#1813]: https://github.com/actix/actix-web/pull/1813\n\n## 0.5.0\n\n- Optionally support hidden files/directories. [#1811]\n\n[#1811]: https://github.com/actix/actix-web/pull/1811\n\n## 0.4.1\n\n- Clarify order of parameters in `Files::new` and improve docs.\n\n## 0.4.0\n\n- Add `Files::prefer_utf8` option that adds UTF-8 charset on certain response types. [#1714]\n\n[#1714]: https://github.com/actix/actix-web/pull/1714\n\n## 0.3.0\n\n- No significant changes from 0.3.0-beta.1.\n\n## 0.3.0-beta.1\n\n- Update `v_htmlescape` to 0.10\n- Update `actix-web` and `actix-http` dependencies to beta.1\n\n## 0.3.0-alpha.1\n\n- Update `actix-web` and `actix-http` dependencies to alpha\n- Fix some typos in the docs\n- Bump minimum supported Rust version to 1.40\n- Support sending Content-Length when Content-Range is specified [#1384]\n\n[#1384]: https://github.com/actix/actix-web/pull/1384\n\n## 0.2.1\n\n- Use the same format for file URLs regardless of platforms\n\n## 0.2.0\n\n- Fix BodyEncoding trait import #1220\n\n## 0.2.0-alpha.1\n\n- Migrate to `std::future`\n\n## 0.1.7\n\n- Add an additional `filename*` param in the `Content-Disposition` header of `actix_files::NamedFile` to be more compatible. (#1151)\n\n## 0.1.6\n\n- Add option to redirect to a slash-ended path `Files` #1132\n\n## 0.1.5\n\n- Bump up `mime_guess` crate version to 2.0.1\n- Bump up `percent-encoding` crate version to 2.1\n- Allow user defined request guards for `Files` #1113\n\n## 0.1.4\n\n- Allow to disable `Content-Disposition` header #686\n\n## 0.1.3\n\n- Do not set `Content-Length` header, let actix-http set it #930\n\n## 0.1.2\n\n- Content-Length is 0 for NamedFile HEAD request #914\n- Fix ring dependency from actix-web default features for #741\n\n## 0.1.1\n\n- Static files are incorrectly served as both chunked and with length #812\n\n## 0.1.0\n\n- NamedFile last-modified check always fails due to nano-seconds in file modified date #820\n\n## 0.1.0-beta.4\n\n- Update actix-web to beta.4\n\n## 0.1.0-beta.1\n\n- Update actix-web to beta.1\n\n## 0.1.0-alpha.6\n\n- Update actix-web to alpha6\n\n## 0.1.0-alpha.4\n\n- Update actix-web to alpha4\n\n## 0.1.0-alpha.2\n\n- Add default handler support\n\n## 0.1.0-alpha.1\n\n- Initial impl\n" }, { "path": "actix-files/Cargo.toml", "content": "[package]\nname = \"actix-files\"\nversion = \"0.6.10\"\nauthors = [\"Nikolay Kim \", \"Rob Ede \"]\ndescription = \"Static file serving for Actix Web\"\nkeywords = [\"actix\", \"http\", \"async\", \"futures\"]\nhomepage = \"https://actix.rs\"\nrepository = \"https://github.com/actix/actix-web\"\ncategories = [\"asynchronous\", \"web-programming::http-server\"]\nlicense = \"MIT OR Apache-2.0\"\nedition = \"2021\"\n\n[package.metadata.cargo_check_external_types]\nallowed_external_types = [\"actix_http::*\", \"actix_service::*\", \"actix_web::*\", \"http::*\", \"mime::*\"]\n\n[features]\nexperimental-io-uring = [\"actix-web/experimental-io-uring\", \"tokio-uring\"]\n\n[dependencies]\nactix-http = \"3\"\nactix-service = \"2\"\nactix-utils = \"3\"\nactix-web = { version = \"4\", default-features = false }\n\nbitflags = \"2\"\nbytes = \"1\"\nderive_more = { version = \"2\", features = [\"deref\", \"deref_mut\", \"display\", \"error\", \"from\"] }\nfutures-core = { version = \"0.3.17\", default-features = false, features = [\"alloc\"] }\nhttp-range = \"0.1.4\"\nlog = \"0.4\"\nmime = \"0.3.9\"\nmime_guess = \"2.0.1\"\npercent-encoding = \"2.1\"\npin-project-lite = \"0.2.7\"\nv_htmlescape = \"0.15.5\"\n\n# experimental-io-uring\n[target.'cfg(target_os = \"linux\")'.dependencies]\ntokio-uring = { version = \"0.5\", optional = true, features = [\"bytes\"] }\nactix-server = { version = \"2.4\", optional = true } # ensure matching tokio-uring versions\n\n[dev-dependencies]\nactix-rt = \"2.7\"\nactix-test = \"0.1\"\nactix-web = \"4\"\nenv_logger = \"0.11\"\nfiletime = \"0.2\"\ntempfile = \"3.2\"\n\n[lints]\nworkspace = true\n" }, { "path": "actix-files/README.md", "content": "# `actix-files`\n\n\n\n[![crates.io](https://img.shields.io/crates/v/actix-files?label=latest)](https://crates.io/crates/actix-files)\n[![Documentation](https://docs.rs/actix-files/badge.svg?version=0.6.9)](https://docs.rs/actix-files/0.6.9)\n![Version](https://img.shields.io/badge/rustc-1.88+-ab6000.svg)\n![License](https://img.shields.io/crates/l/actix-files.svg)\n
\n[![dependency status](https://deps.rs/crate/actix-files/0.6.9/status.svg)](https://deps.rs/crate/actix-files/0.6.9)\n[![Download](https://img.shields.io/crates/d/actix-files.svg)](https://crates.io/crates/actix-files)\n[![Chat on Discord](https://img.shields.io/discord/771444961383153695?label=chat&logo=discord)](https://discord.gg/NWpN5mmg3x)\n\n\n\n\n\nStatic file serving for Actix Web.\n\nProvides a non-blocking service for serving static files from disk.\n\n## Examples\n\n```rust\nuse actix_web::App;\nuse actix_files::Files;\n\nlet app = App::new()\n .service(Files::new(\"/static\", \".\").prefer_utf8(true));\n```\n\n\n" }, { "path": "actix-files/examples/guarded-listing.rs", "content": "use actix_files::Files;\nuse actix_web::{get, guard, middleware, App, HttpServer, Responder};\n\nconst EXAMPLES_DIR: &str = concat![env!(\"CARGO_MANIFEST_DIR\"), \"/examples\"];\n\n#[get(\"/\")]\nasync fn index() -> impl Responder {\n \"Hello world!\"\n}\n\n#[actix_web::main]\nasync fn main() -> std::io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n log::info!(\"starting HTTP server at http://localhost:8080\");\n\n HttpServer::new(|| {\n App::new()\n .service(index)\n .service(\n Files::new(\"/assets\", EXAMPLES_DIR)\n .show_files_listing()\n .guard(guard::Header(\"show-listing\", \"?1\")),\n )\n .service(Files::new(\"/assets\", EXAMPLES_DIR))\n .wrap(middleware::Compress::default())\n .wrap(middleware::Logger::default())\n })\n .bind((\"127.0.0.1\", 8080))?\n .workers(2)\n .run()\n .await\n}\n" }, { "path": "actix-files/src/chunked.rs", "content": "use std::{\n cmp, fmt,\n future::Future,\n io,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse actix_web::{error::Error, web::Bytes};\n#[cfg(feature = \"experimental-io-uring\")]\nuse bytes::BytesMut;\nuse futures_core::{ready, Stream};\nuse pin_project_lite::pin_project;\n\nuse super::named::File;\n\n#[derive(Debug, Clone, Copy)]\npub(crate) enum ReadMode {\n Sync,\n Async,\n}\n\npin_project! {\n /// Adapter to read a `std::file::File` in chunks.\n #[doc(hidden)]\n pub struct ChunkedReadFile {\n size: u64,\n offset: u64,\n #[pin]\n state: ChunkedReadFileState,\n counter: u64,\n callback: F,\n read_mode: ReadMode,\n }\n}\n\n#[cfg(not(feature = \"experimental-io-uring\"))]\npin_project! {\n #[project = ChunkedReadFileStateProj]\n #[project_replace = ChunkedReadFileStateProjReplace]\n enum ChunkedReadFileState {\n File { file: Option, },\n Future { #[pin] fut: Fut },\n }\n}\n\n#[cfg(feature = \"experimental-io-uring\")]\npin_project! {\n #[project = ChunkedReadFileStateProj]\n #[project_replace = ChunkedReadFileStateProjReplace]\n enum ChunkedReadFileState {\n File { file: Option<(File, BytesMut)> },\n Future { #[pin] fut: Fut },\n }\n}\n\nimpl fmt::Debug for ChunkedReadFile {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"ChunkedReadFile\")\n }\n}\n\npub(crate) fn new_chunked_read(\n size: u64,\n offset: u64,\n file: File,\n read_mode_threshold: u64,\n) -> impl Stream> {\n ChunkedReadFile {\n size,\n offset,\n #[cfg(not(feature = \"experimental-io-uring\"))]\n state: ChunkedReadFileState::File { file: Some(file) },\n #[cfg(feature = \"experimental-io-uring\")]\n state: ChunkedReadFileState::File {\n file: Some((file, BytesMut::new())),\n },\n counter: 0,\n callback: chunked_read_file_callback,\n read_mode: if size < read_mode_threshold {\n ReadMode::Sync\n } else {\n ReadMode::Async\n },\n }\n}\n\n#[cfg(not(feature = \"experimental-io-uring\"))]\nfn chunked_read_file_callback_sync(\n mut file: File,\n offset: u64,\n max_bytes: usize,\n) -> Result<(File, Bytes), io::Error> {\n use io::{Read as _, Seek as _};\n\n let mut buf = Vec::with_capacity(max_bytes);\n\n file.seek(io::SeekFrom::Start(offset))?;\n\n let n_bytes = file.by_ref().take(max_bytes as u64).read_to_end(&mut buf)?;\n\n if n_bytes == 0 {\n Err(io::Error::from(io::ErrorKind::UnexpectedEof))\n } else {\n Ok((file, Bytes::from(buf)))\n }\n}\n\n#[cfg(not(feature = \"experimental-io-uring\"))]\n#[inline]\nasync fn chunked_read_file_callback(\n file: File,\n offset: u64,\n max_bytes: usize,\n read_mode: ReadMode,\n) -> Result<(File, Bytes), Error> {\n let res = match read_mode {\n ReadMode::Sync => chunked_read_file_callback_sync(file, offset, max_bytes)?,\n ReadMode::Async => {\n actix_web::web::block(move || chunked_read_file_callback_sync(file, offset, max_bytes))\n .await??\n }\n };\n\n Ok(res)\n}\n\n#[cfg(feature = \"experimental-io-uring\")]\nasync fn chunked_read_file_callback(\n file: File,\n offset: u64,\n max_bytes: usize,\n mut bytes_mut: BytesMut,\n) -> io::Result<(File, Bytes, BytesMut)> {\n bytes_mut.reserve(max_bytes);\n\n let (res, mut bytes_mut) = file.read_at(bytes_mut, offset).await;\n let n_bytes = res?;\n\n if n_bytes == 0 {\n return Err(io::ErrorKind::UnexpectedEof.into());\n }\n\n let bytes = bytes_mut.split_to(n_bytes).freeze();\n\n Ok((file, bytes, bytes_mut))\n}\n\n#[cfg(feature = \"experimental-io-uring\")]\nimpl Stream for ChunkedReadFile\nwhere\n F: Fn(File, u64, usize, BytesMut) -> Fut,\n Fut: Future>,\n{\n type Item = Result;\n\n fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n let mut this = self.as_mut().project();\n match this.state.as_mut().project() {\n ChunkedReadFileStateProj::File { file } => {\n let size = *this.size;\n let offset = *this.offset;\n let counter = *this.counter;\n\n if size == counter {\n Poll::Ready(None)\n } else {\n let max_bytes = cmp::min(size.saturating_sub(counter), 65_536) as usize;\n\n let (file, bytes_mut) = file\n .take()\n .expect(\"ChunkedReadFile polled after completion\");\n\n let fut = (this.callback)(file, offset, max_bytes, bytes_mut);\n\n this.state\n .project_replace(ChunkedReadFileState::Future { fut });\n\n self.poll_next(cx)\n }\n }\n ChunkedReadFileStateProj::Future { fut } => {\n let (file, bytes, bytes_mut) = ready!(fut.poll(cx))?;\n\n this.state.project_replace(ChunkedReadFileState::File {\n file: Some((file, bytes_mut)),\n });\n\n *this.offset += bytes.len() as u64;\n *this.counter += bytes.len() as u64;\n\n Poll::Ready(Some(Ok(bytes)))\n }\n }\n }\n}\n\n#[cfg(not(feature = \"experimental-io-uring\"))]\nimpl Stream for ChunkedReadFile\nwhere\n F: Fn(File, u64, usize, ReadMode) -> Fut,\n Fut: Future>,\n{\n type Item = Result;\n\n fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n let mut this = self.as_mut().project();\n match this.state.as_mut().project() {\n ChunkedReadFileStateProj::File { file } => {\n let size = *this.size;\n let offset = *this.offset;\n let counter = *this.counter;\n\n if size == counter {\n Poll::Ready(None)\n } else {\n let max_bytes = cmp::min(size.saturating_sub(counter), 65_536) as usize;\n\n let file = file\n .take()\n .expect(\"ChunkedReadFile polled after completion\");\n\n let fut = (this.callback)(file, offset, max_bytes, *this.read_mode);\n\n this.state\n .project_replace(ChunkedReadFileState::Future { fut });\n\n self.poll_next(cx)\n }\n }\n ChunkedReadFileStateProj::Future { fut } => {\n let (file, bytes) = ready!(fut.poll(cx))?;\n\n this.state\n .project_replace(ChunkedReadFileState::File { file: Some(file) });\n\n *this.offset += bytes.len() as u64;\n *this.counter += bytes.len() as u64;\n\n Poll::Ready(Some(Ok(bytes)))\n }\n }\n }\n}\n" }, { "path": "actix-files/src/directory.rs", "content": "use std::{\n fmt::Write,\n fs::DirEntry,\n io,\n path::{Path, PathBuf},\n};\n\nuse actix_web::{dev::ServiceResponse, HttpRequest, HttpResponse};\nuse percent_encoding::{utf8_percent_encode, CONTROLS};\nuse v_htmlescape::escape as escape_html_entity;\n\n/// A directory; responds with the generated directory listing.\n#[derive(Debug)]\npub struct Directory {\n /// Base directory.\n pub base: PathBuf,\n\n /// Path of subdirectory to generate listing for.\n pub path: PathBuf,\n}\n\nimpl Directory {\n /// Create a new directory\n pub fn new(base: PathBuf, path: PathBuf) -> Directory {\n Directory { base, path }\n }\n\n /// Is this entry visible from this directory?\n pub fn is_visible(&self, entry: &io::Result) -> bool {\n if let Ok(ref entry) = *entry {\n if let Some(name) = entry.file_name().to_str() {\n if name.starts_with('.') {\n return false;\n }\n }\n if let Ok(ref md) = entry.metadata() {\n let ft = md.file_type();\n return ft.is_dir() || ft.is_file() || ft.is_symlink();\n }\n }\n false\n }\n}\n\npub(crate) type DirectoryRenderer =\n dyn Fn(&Directory, &HttpRequest) -> Result;\n\n/// Returns percent encoded file URL path.\nmacro_rules! encode_file_url {\n ($path:ident) => {\n utf8_percent_encode(&$path, CONTROLS)\n };\n}\n\n/// Returns HTML entity encoded formatter.\n///\n/// ```plain\n/// \" => "\n/// & => &\n/// ' => '\n/// < => <\n/// > => >\n/// / => /\n/// ```\nmacro_rules! encode_file_name {\n ($entry:ident) => {\n escape_html_entity(&$entry.file_name().to_string_lossy())\n };\n}\n\npub(crate) fn directory_listing(\n dir: &Directory,\n req: &HttpRequest,\n) -> Result {\n let index_of = format!(\"Index of {}\", req.path());\n let mut body = String::new();\n let base = Path::new(req.path());\n\n for entry in dir.path.read_dir()? {\n if dir.is_visible(&entry) {\n let entry = entry.unwrap();\n let p = match entry.path().strip_prefix(&dir.path) {\n Ok(p) if cfg!(windows) => base.join(p).to_string_lossy().replace('\\\\', \"/\"),\n Ok(p) => base.join(p).to_string_lossy().into_owned(),\n Err(_) => continue,\n };\n\n // if file is a directory, add '/' to the end of the name\n if let Ok(metadata) = entry.metadata() {\n if metadata.is_dir() {\n let _ = write!(\n body,\n \"
  • {}/
    • \",\n encode_file_url!(p),\n encode_file_name!(entry),\n );\n } else {\n let _ = write!(\n body,\n \"
  • {}
    • \",\n encode_file_url!(p),\n encode_file_name!(entry),\n );\n }\n } else {\n continue;\n }\n }\n }\n\n let html = format!(\n \"\\\n {}\\\n

    {}

    \\\n
      \\\n {}\\\n
    \\n\",\n index_of, index_of, body\n );\n Ok(ServiceResponse::new(\n req.clone(),\n HttpResponse::Ok()\n .content_type(\"text/html; charset=utf-8\")\n .body(html),\n ))\n}\n" }, { "path": "actix-files/src/encoding.rs", "content": "use mime::Mime;\n\n/// Transforms MIME `text/*` types into their UTF-8 equivalent, if supported.\n///\n/// MIME types that are converted\n/// - application/javascript\n/// - text/html\n/// - text/css\n/// - text/plain\n/// - text/csv\n/// - text/tab-separated-values\npub(crate) fn equiv_utf8_text(ct: Mime) -> Mime {\n // use (roughly) order of file-type popularity for a web server\n\n if ct == mime::APPLICATION_JAVASCRIPT {\n return mime::APPLICATION_JAVASCRIPT_UTF_8;\n }\n\n if ct == mime::TEXT_HTML {\n return mime::TEXT_HTML_UTF_8;\n }\n\n if ct == mime::TEXT_CSS {\n return mime::TEXT_CSS_UTF_8;\n }\n\n if ct == mime::TEXT_PLAIN {\n return mime::TEXT_PLAIN_UTF_8;\n }\n\n if ct == mime::TEXT_CSV {\n return mime::TEXT_CSV_UTF_8;\n }\n\n if ct == mime::TEXT_TAB_SEPARATED_VALUES {\n return mime::TEXT_TAB_SEPARATED_VALUES_UTF_8;\n }\n\n ct\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n\n #[test]\n fn test_equiv_utf8_text() {\n assert_eq!(equiv_utf8_text(mime::TEXT_PLAIN), mime::TEXT_PLAIN_UTF_8);\n assert_eq!(equiv_utf8_text(mime::TEXT_XML), mime::TEXT_XML);\n assert_eq!(equiv_utf8_text(mime::IMAGE_PNG), mime::IMAGE_PNG);\n }\n}\n" }, { "path": "actix-files/src/error.rs", "content": "use actix_web::{http::StatusCode, ResponseError};\nuse derive_more::Display;\n\n/// Errors which can occur when serving static files.\n#[derive(Debug, PartialEq, Eq, Display)]\npub enum FilesError {\n /// Path is not a directory.\n #[allow(dead_code)]\n #[display(\"path is not a directory. Unable to serve static files\")]\n IsNotDirectory,\n\n /// Cannot render directory.\n #[display(\"unable to render directory without index file\")]\n IsDirectory,\n}\n\nimpl ResponseError for FilesError {\n /// Returns `404 Not Found`.\n fn status_code(&self) -> StatusCode {\n StatusCode::NOT_FOUND\n }\n}\n\n/// Error which can occur with parsing/validating a request-uri path\n#[derive(Debug, PartialEq, Eq, Display)]\n#[non_exhaustive]\npub enum UriSegmentError {\n /// Segment started with the wrapped invalid character.\n #[display(\"segment started with invalid character: ('{_0}')\")]\n BadStart(char),\n\n /// Segment contained the wrapped invalid character.\n #[display(\"segment contained invalid character ('{_0}')\")]\n BadChar(char),\n\n /// Segment ended with the wrapped invalid character.\n #[display(\"segment ended with invalid character: ('{_0}')\")]\n BadEnd(char),\n\n /// Path is not a valid UTF-8 string after percent-decoding.\n #[display(\"path is not a valid UTF-8 string after percent-decoding\")]\n NotValidUtf8,\n}\n\nimpl ResponseError for UriSegmentError {\n /// Returns `400 Bad Request`.\n fn status_code(&self) -> StatusCode {\n StatusCode::BAD_REQUEST\n }\n}\n" }, { "path": "actix-files/src/files.rs", "content": "use std::{\n cell::RefCell,\n fmt, io,\n path::{Path, PathBuf},\n rc::Rc,\n};\n\nuse actix_service::{boxed, IntoServiceFactory, ServiceFactory, ServiceFactoryExt};\nuse actix_web::{\n dev::{\n AppService, HttpServiceFactory, RequestHead, ResourceDef, ServiceRequest, ServiceResponse,\n },\n error::Error,\n guard::Guard,\n http::header::DispositionType,\n HttpRequest,\n};\nuse futures_core::future::LocalBoxFuture;\n\nuse crate::{\n directory_listing, named,\n service::{FilesService, FilesServiceInner},\n Directory, DirectoryRenderer, HttpNewService, MimeOverride, PathFilter,\n};\n\n/// Static files handling service.\n///\n/// `Files` service must be registered with `App::service()` method.\n///\n/// # Examples\n/// ```\n/// use actix_web::App;\n/// use actix_files::Files;\n///\n/// let app = App::new()\n/// .service(Files::new(\"/static\", \".\"));\n/// ```\npub struct Files {\n mount_path: String,\n directory: PathBuf,\n index: Option,\n show_index: bool,\n redirect_to_slash: bool,\n with_permanent_redirect: bool,\n default: Rc>>>,\n renderer: Rc,\n mime_override: Option>,\n path_filter: Option>,\n file_flags: named::Flags,\n use_guards: Option>,\n guards: Vec>,\n hidden_files: bool,\n try_compressed: bool,\n read_mode_threshold: u64,\n}\n\nimpl fmt::Debug for Files {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"Files\")\n }\n}\n\nimpl Clone for Files {\n fn clone(&self) -> Self {\n Self {\n directory: self.directory.clone(),\n index: self.index.clone(),\n show_index: self.show_index,\n redirect_to_slash: self.redirect_to_slash,\n with_permanent_redirect: self.with_permanent_redirect,\n default: self.default.clone(),\n renderer: self.renderer.clone(),\n file_flags: self.file_flags,\n mount_path: self.mount_path.clone(),\n mime_override: self.mime_override.clone(),\n path_filter: self.path_filter.clone(),\n use_guards: self.use_guards.clone(),\n guards: self.guards.clone(),\n hidden_files: self.hidden_files,\n try_compressed: self.try_compressed,\n read_mode_threshold: self.read_mode_threshold,\n }\n }\n}\n\nimpl Files {\n /// Create new `Files` instance for a specified base directory.\n ///\n /// # Argument Order\n /// The first argument (`mount_path`) is the root URL at which the static files are served.\n /// For example, `/assets` will serve files at `example.com/assets/...`.\n ///\n /// The second argument (`serve_from`) is the location on disk at which files are loaded.\n /// This can be a relative path. For example, `./` would serve files from the current\n /// working directory.\n ///\n /// # Implementation Notes\n /// If the mount path is set as the root path `/`, services registered after this one will\n /// be inaccessible. Register more specific handlers and services first.\n ///\n /// If `serve_from` cannot be canonicalized at startup, an error is logged and the original\n /// path is preserved. Requests will return `404 Not Found` until the path exists.\n ///\n /// `Files` utilizes the existing Tokio thread-pool for blocking filesystem operations.\n /// The number of running threads is adjusted over time as needed, up to a maximum of 512 times\n /// the number of server [workers](actix_web::HttpServer::workers), by default.\n pub fn new>(mount_path: &str, serve_from: T) -> Files {\n let orig_dir = serve_from.into();\n let dir = match orig_dir.canonicalize() {\n Ok(canon_dir) => canon_dir,\n Err(_) => {\n log::error!(\"Specified path is not a directory: {:?}\", orig_dir);\n // Preserve original path so requests don't fall back to CWD.\n orig_dir\n }\n };\n\n Files {\n mount_path: mount_path.trim_end_matches('/').to_owned(),\n directory: dir,\n index: None,\n show_index: false,\n redirect_to_slash: false,\n with_permanent_redirect: false,\n default: Rc::new(RefCell::new(None)),\n renderer: Rc::new(directory_listing),\n mime_override: None,\n path_filter: None,\n file_flags: named::Flags::default(),\n use_guards: None,\n guards: Vec::new(),\n hidden_files: false,\n try_compressed: false,\n read_mode_threshold: 0,\n }\n }\n\n /// Show files listing for directories.\n ///\n /// By default show files listing is disabled.\n ///\n /// When used with [`Files::index_file()`], files listing is shown as a fallback\n /// when the index file is not found.\n pub fn show_files_listing(mut self) -> Self {\n self.show_index = true;\n self\n }\n\n /// Redirects to a slash-ended path when browsing a directory.\n ///\n /// By default never redirect.\n pub fn redirect_to_slash_directory(mut self) -> Self {\n self.redirect_to_slash = true;\n self\n }\n\n /// Redirect with permanent redirect status code (308).\n ///\n /// By default redirect with temporary redirect status code (307).\n pub fn with_permanent_redirect(mut self) -> Self {\n self.with_permanent_redirect = true;\n self\n }\n\n /// Set custom directory renderer.\n pub fn files_listing_renderer(mut self, f: F) -> Self\n where\n for<'r, 's> F:\n Fn(&'r Directory, &'s HttpRequest) -> Result + 'static,\n {\n self.renderer = Rc::new(f);\n self\n }\n\n /// Specifies MIME override callback.\n pub fn mime_override(mut self, f: F) -> Self\n where\n F: Fn(&mime::Name<'_>) -> DispositionType + 'static,\n {\n self.mime_override = Some(Rc::new(f));\n self\n }\n\n /// Sets path filtering closure.\n ///\n /// The path provided to the closure is relative to `serve_from` path.\n /// You can safely join this path with the `serve_from` path to get the real path.\n /// However, the real path may not exist since the filter is called before checking path existence.\n ///\n /// When a path doesn't pass the filter, [`Files::default_handler`] is called if set, otherwise,\n /// `404 Not Found` is returned.\n ///\n /// # Examples\n /// ```\n /// use std::path::Path;\n /// use actix_files::Files;\n ///\n /// // prevent searching subdirectories and following symlinks\n /// let files_service = Files::new(\"/\", \"./static\").path_filter(|path, _| {\n /// path.components().count() == 1\n /// && Path::new(\"./static\")\n /// .join(path)\n /// .symlink_metadata()\n /// .map(|m| !m.file_type().is_symlink())\n /// .unwrap_or(false)\n /// });\n /// ```\n pub fn path_filter(mut self, f: F) -> Self\n where\n F: Fn(&Path, &RequestHead) -> bool + 'static,\n {\n self.path_filter = Some(Rc::new(f));\n self\n }\n\n /// Sets index file for directory requests.\n ///\n /// When a directory is requested, this value is appended to the directory's path on disk.\n /// Therefore, the index file path is relative to the served directory (the `serve_from` path\n /// passed to [`Files::new`]) and should not include the `serve_from` prefix.\n ///\n /// For example, to serve `./static/index.html` when mounting `Files::new(\"/\", \"./static\")`,\n /// configure it as `.index_file(\"index.html\")` (not `.index_file(\"./static/index.html\")`).\n ///\n /// If the index file is not found, files listing is shown as a fallback if\n /// [`Files::show_files_listing()`] is set.\n pub fn index_file>(mut self, index: T) -> Self {\n self.index = Some(index.into());\n self\n }\n\n /// Sets the size threshold that determines file read mode (sync/async).\n ///\n /// When a file is smaller than the threshold (bytes), the reader will use synchronous\n /// (blocking) file reads. For larger files, it switches to async reads to avoid blocking the\n /// main thread.\n ///\n /// Tweaking this value according to your expected usage may lead to significant performance\n /// gains (or losses in other handlers, if `size` is too high).\n ///\n /// When the `experimental-io-uring` crate feature is enabled, file reads are always async.\n ///\n /// Default is 0, meaning all files are read asynchronously.\n pub fn read_mode_threshold(mut self, size: u64) -> Self {\n self.read_mode_threshold = size;\n self\n }\n\n /// Specifies whether to use ETag or not.\n ///\n /// Default is true.\n pub fn use_etag(mut self, value: bool) -> Self {\n self.file_flags.set(named::Flags::ETAG, value);\n self\n }\n\n /// Specifies whether to use Last-Modified or not.\n ///\n /// Default is true.\n pub fn use_last_modified(mut self, value: bool) -> Self {\n self.file_flags.set(named::Flags::LAST_MD, value);\n self\n }\n\n /// Specifies whether text responses should signal a UTF-8 encoding.\n ///\n /// Default is false (but will default to true in a future version).\n pub fn prefer_utf8(mut self, value: bool) -> Self {\n self.file_flags.set(named::Flags::PREFER_UTF8, value);\n self\n }\n\n /// Adds a routing guard.\n ///\n /// Use this to allow multiple chained file services that respond to strictly different\n /// properties of a request. Due to the way routing works, if a guard check returns true and the\n /// request starts being handled by the file service, it will not be able to back-out and try\n /// the next service, you will simply get a 404 (or 405) error response.\n ///\n /// To allow `POST` requests to retrieve files, see [`Files::method_guard()`].\n ///\n /// # Examples\n /// ```\n /// use actix_web::{guard::Header, App};\n /// use actix_files::Files;\n ///\n /// App::new().service(\n /// Files::new(\"/\",\"/my/site/files\")\n /// .guard(Header(\"Host\", \"example.com\"))\n /// );\n /// ```\n pub fn guard(mut self, guard: G) -> Self {\n self.guards.push(Rc::new(guard));\n self\n }\n\n /// Specifies guard to check before fetching directory listings or files.\n ///\n /// Note that this guard has no effect on routing; it's main use is to guard on the request's\n /// method just before serving the file, only allowing `GET` and `HEAD` requests by default.\n /// See [`Files::guard`] for routing guards.\n pub fn method_guard(mut self, guard: G) -> Self {\n self.use_guards = Some(Rc::new(guard));\n self\n }\n\n /// See [`Files::method_guard`].\n #[doc(hidden)]\n #[deprecated(since = \"0.6.0\", note = \"Renamed to `method_guard`.\")]\n pub fn use_guards(self, guard: G) -> Self {\n self.method_guard(guard)\n }\n\n /// Disable `Content-Disposition` header.\n ///\n /// By default Content-Disposition` header is enabled.\n pub fn disable_content_disposition(mut self) -> Self {\n self.file_flags.remove(named::Flags::CONTENT_DISPOSITION);\n self\n }\n\n /// Sets default handler which is used when no matched file could be found.\n ///\n /// # Examples\n /// Setting a fallback static file handler:\n /// ```\n /// use actix_files::{Files, NamedFile};\n /// use actix_web::dev::{ServiceRequest, ServiceResponse, fn_service};\n ///\n /// # fn run() -> Result<(), actix_web::Error> {\n /// let files = Files::new(\"/\", \"./static\")\n /// .index_file(\"index.html\")\n /// .default_handler(fn_service(|req: ServiceRequest| async {\n /// let (req, _) = req.into_parts();\n /// let file = NamedFile::open_async(\"./static/404.html\").await?;\n /// let res = file.into_response(&req);\n /// Ok(ServiceResponse::new(req, res))\n /// }));\n /// # Ok(())\n /// # }\n /// ```\n pub fn default_handler(mut self, f: F) -> Self\n where\n F: IntoServiceFactory,\n U: ServiceFactory\n + 'static,\n {\n // create and configure default resource\n self.default = Rc::new(RefCell::new(Some(Rc::new(boxed::factory(\n f.into_factory().map_init_err(|_| ()),\n )))));\n\n self\n }\n\n /// Enables serving hidden files and directories, allowing a leading dots in url fragments.\n pub fn use_hidden_files(mut self) -> Self {\n self.hidden_files = true;\n self\n }\n\n /// Attempts to search for a suitable pre-compressed version of a file on disk before falling\n /// back to the uncompressed version.\n ///\n /// Currently, `.gz`, `.br`, and `.zst` files are supported.\n pub fn try_compressed(mut self) -> Self {\n self.try_compressed = true;\n self\n }\n}\n\nimpl HttpServiceFactory for Files {\n fn register(mut self, config: &mut AppService) {\n let guards = if self.guards.is_empty() {\n None\n } else {\n let guards = std::mem::take(&mut self.guards);\n Some(\n guards\n .into_iter()\n .map(|guard| -> Box { Box::new(guard) })\n .collect::>(),\n )\n };\n\n if self.default.borrow().is_none() {\n *self.default.borrow_mut() = Some(config.default_service());\n }\n\n let rdef = if config.is_root() {\n ResourceDef::root_prefix(&self.mount_path)\n } else {\n ResourceDef::prefix(&self.mount_path)\n };\n\n config.register_service(rdef, guards, self, None)\n }\n}\n\nimpl ServiceFactory for Files {\n type Response = ServiceResponse;\n type Error = Error;\n type Config = ();\n type Service = FilesService;\n type InitError = ();\n type Future = LocalBoxFuture<'static, Result>;\n\n fn new_service(&self, _: ()) -> Self::Future {\n let mut inner = FilesServiceInner {\n directory: self.directory.clone(),\n index: self.index.clone(),\n show_index: self.show_index,\n redirect_to_slash: self.redirect_to_slash,\n default: None,\n renderer: self.renderer.clone(),\n mime_override: self.mime_override.clone(),\n path_filter: self.path_filter.clone(),\n file_flags: self.file_flags,\n guards: self.use_guards.clone(),\n hidden_files: self.hidden_files,\n try_compressed: self.try_compressed,\n size_threshold: self.read_mode_threshold,\n with_permanent_redirect: self.with_permanent_redirect,\n };\n\n if let Some(ref default) = *self.default.borrow() {\n let fut = default.new_service(());\n Box::pin(async {\n match fut.await {\n Ok(default) => {\n inner.default = Some(default);\n Ok(FilesService(Rc::new(inner)))\n }\n Err(_) => Err(()),\n }\n })\n } else {\n Box::pin(async move { Ok(FilesService(Rc::new(inner))) })\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use actix_web::{\n http::StatusCode,\n test::{self, TestRequest},\n App, HttpResponse,\n };\n\n use super::*;\n\n #[actix_web::test]\n async fn custom_files_listing_renderer() {\n let srv = test::init_service(\n App::new().service(\n Files::new(\"/\", \"./tests\")\n .show_files_listing()\n .files_listing_renderer(|dir, req| {\n Ok(ServiceResponse::new(\n req.clone(),\n HttpResponse::Ok().body(dir.path.to_str().unwrap().to_owned()),\n ))\n }),\n ),\n )\n .await;\n\n let req = TestRequest::with_uri(\"/\").to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n let body = test::read_body(res).await;\n let body_str = std::str::from_utf8(&body).unwrap();\n let actual_path = Path::new(&body_str);\n let expected_path = Path::new(\"actix-files/tests\");\n assert!(\n actual_path.ends_with(expected_path),\n \"body {:?} does not end with {:?}\",\n actual_path,\n expected_path\n );\n }\n}\n" }, { "path": "actix-files/src/lib.rs", "content": "//! Static file serving for Actix Web.\n//!\n//! Provides a non-blocking service for serving static files from disk.\n//!\n//! # Examples\n//! ```\n//! use actix_web::App;\n//! use actix_files::Files;\n//!\n//! let app = App::new()\n//! .service(Files::new(\"/static\", \".\").prefer_utf8(true));\n//! ```\n\n#![warn(missing_docs, missing_debug_implementations)]\n#![doc(html_logo_url = \"https://actix.rs/img/logo.png\")]\n#![doc(html_favicon_url = \"https://actix.rs/favicon.ico\")]\n#![cfg_attr(docsrs, feature(doc_cfg))]\n\nuse std::path::Path;\n\nuse actix_service::boxed::{BoxService, BoxServiceFactory};\nuse actix_web::{\n dev::{RequestHead, ServiceRequest, ServiceResponse},\n error::Error,\n http::header::DispositionType,\n};\nuse mime_guess::from_ext;\n\nmod chunked;\nmod directory;\nmod encoding;\nmod error;\nmod files;\nmod named;\nmod path_buf;\nmod range;\nmod service;\n\npub use self::{\n chunked::ChunkedReadFile, directory::Directory, error::UriSegmentError, files::Files,\n named::NamedFile, path_buf::PathBufWrap, range::HttpRange, service::FilesService,\n};\nuse self::{\n directory::{directory_listing, DirectoryRenderer},\n error::FilesError,\n};\n\ntype HttpService = BoxService;\ntype HttpNewService = BoxServiceFactory<(), ServiceRequest, ServiceResponse, Error, ()>;\n\n/// Return the MIME type associated with a filename extension (case-insensitive).\n/// If `ext` is empty or no associated type for the extension was found, returns\n/// the type `application/octet-stream`.\n#[inline]\npub fn file_extension_to_mime(ext: &str) -> mime::Mime {\n from_ext(ext).first_or_octet_stream()\n}\n\ntype MimeOverride = dyn Fn(&mime::Name<'_>) -> DispositionType;\n\ntype PathFilter = dyn Fn(&Path, &RequestHead) -> bool;\n\n#[cfg(test)]\nmod tests {\n use std::{\n fmt::Write as _,\n fs::{self},\n ops::Add,\n time::{Duration, SystemTime},\n };\n\n use actix_web::{\n dev::ServiceFactory,\n guard,\n http::{\n header::{self, ContentDisposition, DispositionParam},\n Method, StatusCode,\n },\n middleware::Compress,\n test::{self, TestRequest},\n web::{self, Bytes},\n App, HttpResponse, Responder,\n };\n\n use super::*;\n use crate::named::File;\n\n #[actix_web::test]\n async fn test_file_extension_to_mime() {\n let m = file_extension_to_mime(\"\");\n assert_eq!(m, mime::APPLICATION_OCTET_STREAM);\n\n let m = file_extension_to_mime(\"jpg\");\n assert_eq!(m, mime::IMAGE_JPEG);\n\n let m = file_extension_to_mime(\"invalid extension!!\");\n assert_eq!(m, mime::APPLICATION_OCTET_STREAM);\n\n let m = file_extension_to_mime(\"\");\n assert_eq!(m, mime::APPLICATION_OCTET_STREAM);\n }\n\n #[actix_rt::test]\n async fn test_if_modified_since_without_if_none_match() {\n let file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let since = header::HttpDate::from(SystemTime::now().add(Duration::from_secs(60)));\n\n let req = TestRequest::default()\n .insert_header((header::IF_MODIFIED_SINCE, since))\n .to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(resp.status(), StatusCode::NOT_MODIFIED);\n }\n\n #[actix_rt::test]\n async fn test_if_modified_since_without_if_none_match_same() {\n let file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let since = file.last_modified().unwrap();\n\n let req = TestRequest::default()\n .insert_header((header::IF_MODIFIED_SINCE, since))\n .to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(resp.status(), StatusCode::NOT_MODIFIED);\n }\n\n #[actix_rt::test]\n async fn test_if_modified_since_with_if_none_match() {\n let file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let since = header::HttpDate::from(SystemTime::now().add(Duration::from_secs(60)));\n\n let req = TestRequest::default()\n .insert_header((header::IF_NONE_MATCH, \"miss_etag\"))\n .insert_header((header::IF_MODIFIED_SINCE, since))\n .to_http_request();\n let resp = file.respond_to(&req);\n assert_ne!(resp.status(), StatusCode::NOT_MODIFIED);\n }\n\n #[actix_rt::test]\n async fn test_if_unmodified_since() {\n let file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let since = file.last_modified().unwrap();\n\n let req = TestRequest::default()\n .insert_header((header::IF_UNMODIFIED_SINCE, since))\n .to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(resp.status(), StatusCode::OK);\n }\n\n #[actix_rt::test]\n async fn test_if_unmodified_since_failed() {\n let file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let since = header::HttpDate::from(SystemTime::UNIX_EPOCH);\n\n let req = TestRequest::default()\n .insert_header((header::IF_UNMODIFIED_SINCE, since))\n .to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(resp.status(), StatusCode::PRECONDITION_FAILED);\n }\n\n #[actix_rt::test]\n async fn test_named_file_text() {\n assert!(NamedFile::open_async(\"test--\").await.is_err());\n let mut file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/x-toml\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"Cargo.toml\\\"\"\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_content_disposition() {\n assert!(NamedFile::open_async(\"test--\").await.is_err());\n let mut file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"Cargo.toml\\\"\"\n );\n\n let file = NamedFile::open_async(\"Cargo.toml\")\n .await\n .unwrap()\n .disable_content_disposition();\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert!(resp.headers().get(header::CONTENT_DISPOSITION).is_none());\n }\n\n #[actix_rt::test]\n async fn test_named_file_non_ascii_file_name() {\n let file = {\n #[cfg(feature = \"experimental-io-uring\")]\n {\n crate::named::File::open(\"Cargo.toml\").await.unwrap()\n }\n\n #[cfg(not(feature = \"experimental-io-uring\"))]\n {\n crate::named::File::open(\"Cargo.toml\").unwrap()\n }\n };\n\n let mut file = NamedFile::from_file(file, \"貨物.toml\").unwrap();\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/x-toml\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"貨物.toml\\\"; filename*=UTF-8''%E8%B2%A8%E7%89%A9.toml\"\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_set_content_type() {\n let mut file = NamedFile::open_async(\"Cargo.toml\")\n .await\n .unwrap()\n .set_content_type(mime::TEXT_XML);\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/xml\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"Cargo.toml\\\"\"\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_image() {\n let mut file = NamedFile::open_async(\"tests/test.png\").await.unwrap();\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"image/png\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"test.png\\\"\"\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_javascript() {\n let file = NamedFile::open_async(\"tests/test.js\").await.unwrap();\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/javascript\",\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"test.js\\\"\",\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_image_attachment() {\n let cd = ContentDisposition {\n disposition: DispositionType::Attachment,\n parameters: vec![DispositionParam::Filename(String::from(\"test.png\"))],\n };\n let mut file = NamedFile::open_async(\"tests/test.png\")\n .await\n .unwrap()\n .set_content_disposition(cd);\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"image/png\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"attachment; filename=\\\"test.png\\\"\"\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_binary() {\n let mut file = NamedFile::open_async(\"tests/test.binary\").await.unwrap();\n {\n file.file();\n let _f: &File = &file;\n }\n {\n let _f: &mut File = &mut file;\n }\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"application/octet-stream\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"attachment; filename=\\\"test.binary\\\"\"\n );\n }\n\n #[allow(deprecated)]\n #[actix_rt::test]\n async fn status_code_customize_same_output() {\n let file1 = NamedFile::open_async(\"Cargo.toml\")\n .await\n .unwrap()\n .set_status_code(StatusCode::NOT_FOUND);\n\n let file2 = NamedFile::open_async(\"Cargo.toml\")\n .await\n .unwrap()\n .customize()\n .with_status(StatusCode::NOT_FOUND);\n\n let req = TestRequest::default().to_http_request();\n let res1 = file1.respond_to(&req);\n let res2 = file2.respond_to(&req);\n\n assert_eq!(res1.status(), StatusCode::NOT_FOUND);\n assert_eq!(res2.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_named_file_status_code_text() {\n let mut file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n\n {\n file.file();\n let _f: &File = &file;\n }\n\n {\n let _f: &mut File = &mut file;\n }\n\n let file = file.customize().with_status(StatusCode::NOT_FOUND);\n\n let req = TestRequest::default().to_http_request();\n let resp = file.respond_to(&req);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/x-toml\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"Cargo.toml\\\"\"\n );\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_mime_override() {\n fn all_attachment(_: &mime::Name<'_>) -> DispositionType {\n DispositionType::Attachment\n }\n\n let srv = test::init_service(\n App::new().service(\n Files::new(\"/\", \".\")\n .mime_override(all_attachment)\n .index_file(\"Cargo.toml\"),\n ),\n )\n .await;\n\n let request = TestRequest::get().uri(\"/\").to_request();\n let response = test::call_service(&srv, request).await;\n assert_eq!(response.status(), StatusCode::OK);\n\n let content_disposition = response\n .headers()\n .get(header::CONTENT_DISPOSITION)\n .expect(\"To have CONTENT_DISPOSITION\");\n let content_disposition = content_disposition\n .to_str()\n .expect(\"Convert CONTENT_DISPOSITION to str\");\n assert_eq!(content_disposition, \"attachment; filename=\\\"Cargo.toml\\\"\");\n }\n\n #[actix_rt::test]\n async fn test_named_file_ranges_status_code() {\n let srv = test::init_service(\n App::new().service(Files::new(\"/test\", \".\").index_file(\"Cargo.toml\")),\n )\n .await;\n\n // Valid range header\n let request = TestRequest::get()\n .uri(\"/t%65st/Cargo.toml\")\n .insert_header((header::RANGE, \"bytes=10-20\"))\n .to_request();\n let response = test::call_service(&srv, request).await;\n assert_eq!(response.status(), StatusCode::PARTIAL_CONTENT);\n\n // Invalid range header\n let request = TestRequest::get()\n .uri(\"/t%65st/Cargo.toml\")\n .insert_header((header::RANGE, \"bytes=1-0\"))\n .to_request();\n let response = test::call_service(&srv, request).await;\n\n assert_eq!(response.status(), StatusCode::RANGE_NOT_SATISFIABLE);\n }\n\n #[actix_rt::test]\n async fn test_named_file_empty_range_headers() {\n let srv = actix_test::start(|| App::new().service(Files::new(\"/\", \".\")));\n\n for range in [\"\", \"bytes=\"] {\n let response = srv\n .get(\"/tests/test.binary\")\n .insert_header((header::RANGE, range))\n .send()\n .await\n .unwrap();\n\n assert_eq!(response.status(), StatusCode::RANGE_NOT_SATISFIABLE);\n let content_range = response.headers().get(header::CONTENT_RANGE).unwrap();\n assert_eq!(content_range.to_str().unwrap(), \"bytes */100\");\n }\n }\n\n #[actix_rt::test]\n async fn test_named_file_content_range_headers() {\n let srv = actix_test::start(|| App::new().service(Files::new(\"/\", \".\")));\n\n // Valid range header\n let response = srv\n .get(\"/tests/test.binary\")\n .insert_header((header::RANGE, \"bytes=10-20\"))\n .send()\n .await\n .unwrap();\n let content_range = response.headers().get(header::CONTENT_RANGE).unwrap();\n assert_eq!(content_range.to_str().unwrap(), \"bytes 10-20/100\");\n\n // Invalid range header\n let response = srv\n .get(\"/tests/test.binary\")\n .insert_header((header::RANGE, \"bytes=10-5\"))\n .send()\n .await\n .unwrap();\n let content_range = response.headers().get(header::CONTENT_RANGE).unwrap();\n assert_eq!(content_range.to_str().unwrap(), \"bytes */100\");\n }\n\n #[actix_rt::test]\n async fn test_named_file_range_header_from_zero_to_end_returns_partial_content() {\n let srv = actix_test::start(|| App::new().service(Files::new(\"/\", \".\")));\n\n let response = srv\n .get(\"/tests/test.binary\")\n .insert_header((header::RANGE, \"bytes=0-\"))\n .send()\n .await\n .unwrap();\n\n assert_eq!(response.status(), StatusCode::PARTIAL_CONTENT);\n\n let content_range = response.headers().get(header::CONTENT_RANGE).unwrap();\n assert_eq!(content_range.to_str().unwrap(), \"bytes 0-99/100\");\n\n let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();\n assert_eq!(content_length.to_str().unwrap(), \"100\");\n\n // Should be no transfer-encoding\n let transfer_encoding = response.headers().get(header::TRANSFER_ENCODING);\n assert!(transfer_encoding.is_none());\n }\n\n #[actix_rt::test]\n async fn test_named_file_content_length_headers() {\n let srv = actix_test::start(|| App::new().service(Files::new(\"/\", \".\")));\n\n // Valid range header\n let response = srv\n .get(\"/tests/test.binary\")\n .insert_header((header::RANGE, \"bytes=10-20\"))\n .send()\n .await\n .unwrap();\n let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();\n assert_eq!(content_length.to_str().unwrap(), \"11\");\n\n // Valid range header, starting from 0\n let response = srv\n .get(\"/tests/test.binary\")\n .insert_header((header::RANGE, \"bytes=0-20\"))\n .send()\n .await\n .unwrap();\n let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();\n assert_eq!(content_length.to_str().unwrap(), \"21\");\n\n // Without range header\n let mut response = srv.get(\"/tests/test.binary\").send().await.unwrap();\n let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();\n assert_eq!(content_length.to_str().unwrap(), \"100\");\n\n // Should be no transfer-encoding\n let transfer_encoding = response.headers().get(header::TRANSFER_ENCODING);\n assert!(transfer_encoding.is_none());\n\n // Check file contents\n let bytes = response.body().await.unwrap();\n let data = web::Bytes::from(fs::read(\"tests/test.binary\").unwrap());\n assert_eq!(bytes, data);\n }\n\n #[actix_rt::test]\n async fn test_head_content_length_headers() {\n let srv = actix_test::start(|| App::new().service(Files::new(\"/\", \".\")));\n\n let response = srv.head(\"/tests/test.binary\").send().await.unwrap();\n\n let content_length = response\n .headers()\n .get(header::CONTENT_LENGTH)\n .unwrap()\n .to_str()\n .unwrap();\n\n assert_eq!(content_length, \"100\");\n }\n\n #[actix_rt::test]\n async fn test_static_files_with_spaces() {\n let srv =\n test::init_service(App::new().service(Files::new(\"/\", \".\").index_file(\"Cargo.toml\")))\n .await;\n let request = TestRequest::get()\n .uri(\"/tests/test%20space.binary\")\n .to_request();\n let response = test::call_service(&srv, request).await;\n assert_eq!(response.status(), StatusCode::OK);\n\n let bytes = test::read_body(response).await;\n let data = web::Bytes::from(fs::read(\"tests/test space.binary\").unwrap());\n assert_eq!(bytes, data);\n }\n\n #[cfg(not(target_os = \"windows\"))]\n #[actix_rt::test]\n async fn test_static_files_with_special_characters() {\n // Create the file we want to test against ad-hoc. We can't check it in as otherwise\n // Windows can't even checkout this repository.\n let temp_dir = tempfile::tempdir().unwrap();\n let file_with_newlines = temp_dir.path().join(\"test\\n\\x0B\\x0C\\rnewline.text\");\n fs::write(&file_with_newlines, \"Look at my newlines\").unwrap();\n\n let srv = test::init_service(\n App::new().service(Files::new(\"/\", temp_dir.path()).index_file(\"Cargo.toml\")),\n )\n .await;\n let request = TestRequest::get()\n .uri(\"/test%0A%0B%0C%0Dnewline.text\")\n .to_request();\n let response = test::call_service(&srv, request).await;\n assert_eq!(response.status(), StatusCode::OK);\n\n let bytes = test::read_body(response).await;\n let data = web::Bytes::from(fs::read(file_with_newlines).unwrap());\n assert_eq!(bytes, data);\n }\n\n #[actix_rt::test]\n async fn test_files_not_allowed() {\n let srv = test::init_service(App::new().service(Files::new(\"/\", \".\"))).await;\n\n let req = TestRequest::default()\n .uri(\"/Cargo.toml\")\n .method(Method::POST)\n .to_request();\n\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);\n\n let srv = test::init_service(App::new().service(Files::new(\"/\", \".\"))).await;\n let req = TestRequest::default()\n .method(Method::PUT)\n .uri(\"/Cargo.toml\")\n .to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);\n }\n\n #[actix_rt::test]\n async fn test_files_guards() {\n let srv = test::init_service(\n App::new().service(Files::new(\"/\", \".\").method_guard(guard::Post())),\n )\n .await;\n\n let req = TestRequest::default()\n .uri(\"/Cargo.toml\")\n .method(Method::POST)\n .to_request();\n\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::OK);\n }\n\n #[actix_rt::test]\n async fn test_named_file_content_encoding() {\n let srv = test::init_service(App::new().wrap(Compress::default()).service(\n web::resource(\"/\").to(|| async {\n NamedFile::open_async(\"Cargo.toml\")\n .await\n .unwrap()\n .set_content_encoding(header::ContentEncoding::Identity)\n }),\n ))\n .await;\n\n let request = TestRequest::get()\n .uri(\"/\")\n .insert_header((header::ACCEPT_ENCODING, \"gzip\"))\n .to_request();\n let res = test::call_service(&srv, request).await;\n assert_eq!(res.status(), StatusCode::OK);\n assert!(res.headers().contains_key(header::CONTENT_ENCODING));\n assert!(!test::read_body(res).await.is_empty());\n }\n\n #[actix_rt::test]\n async fn test_named_file_content_encoding_gzip() {\n let srv = test::init_service(App::new().wrap(Compress::default()).service(\n web::resource(\"/\").to(|| async {\n NamedFile::open_async(\"Cargo.toml\")\n .await\n .unwrap()\n .set_content_encoding(header::ContentEncoding::Gzip)\n }),\n ))\n .await;\n\n let request = TestRequest::get()\n .uri(\"/\")\n .insert_header((header::ACCEPT_ENCODING, \"gzip\"))\n .to_request();\n let res = test::call_service(&srv, request).await;\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers()\n .get(header::CONTENT_ENCODING)\n .unwrap()\n .to_str()\n .unwrap(),\n \"gzip\"\n );\n }\n\n #[actix_rt::test]\n async fn test_named_file_allowed_method() {\n let req = TestRequest::default().method(Method::GET).to_http_request();\n let file = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let resp = file.respond_to(&req);\n assert_eq!(resp.status(), StatusCode::OK);\n }\n\n #[actix_rt::test]\n async fn test_static_files() {\n let srv =\n test::init_service(App::new().service(Files::new(\"/\", \".\").show_files_listing())).await;\n let req = TestRequest::with_uri(\"/missing\").to_request();\n\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n\n let srv = test::init_service(App::new().service(Files::new(\"/\", \".\"))).await;\n\n let req = TestRequest::default().to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n\n let srv =\n test::init_service(App::new().service(Files::new(\"/\", \".\").show_files_listing())).await;\n let req = TestRequest::with_uri(\"/tests\").to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/html; charset=utf-8\"\n );\n\n let bytes = test::read_body(resp).await;\n assert!(format!(\"{:?}\", bytes).contains(\"/tests/test.png\"));\n }\n\n #[actix_rt::test]\n async fn test_redirect_to_slash_directory() {\n // should not redirect if no index and files listing is disabled\n let srv = test::init_service(\n App::new().service(Files::new(\"/\", \".\").redirect_to_slash_directory()),\n )\n .await;\n let req = TestRequest::with_uri(\"/tests\").to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n\n // should redirect if index present\n let srv = test::init_service(\n App::new().service(\n Files::new(\"/\", \".\")\n .index_file(\"test.png\")\n .redirect_to_slash_directory(),\n ),\n )\n .await;\n let req = TestRequest::with_uri(\"/tests\").to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::TEMPORARY_REDIRECT);\n\n // should redirect if index present with permanent redirect\n let srv = test::init_service(\n App::new().service(\n Files::new(\"/\", \".\")\n .index_file(\"test.png\")\n .redirect_to_slash_directory()\n .with_permanent_redirect(),\n ),\n )\n .await;\n let req = TestRequest::with_uri(\"/tests\").to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::PERMANENT_REDIRECT);\n\n // should redirect if files listing is enabled\n let srv = test::init_service(\n App::new().service(\n Files::new(\"/\", \".\")\n .show_files_listing()\n .redirect_to_slash_directory(),\n ),\n )\n .await;\n let req = TestRequest::with_uri(\"/tests\").to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::TEMPORARY_REDIRECT);\n\n // should not redirect if the path is wrong\n let req = TestRequest::with_uri(\"/not_existing\").to_request();\n let resp = test::call_service(&srv, req).await;\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_static_files_bad_directory() {\n let service = Files::new(\"/\", \"./missing\").new_service(()).await.unwrap();\n\n let req = TestRequest::with_uri(\"/\").to_srv_request();\n let resp = test::call_service(&service, req).await;\n\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_static_files_bad_directory_does_not_serve_cwd_files() {\n let service = Files::new(\"/\", \"./missing\").new_service(()).await.unwrap();\n\n let req = TestRequest::with_uri(\"/Cargo.toml\").to_srv_request();\n let resp = test::call_service(&service, req).await;\n\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_default_handler_file_missing() {\n let st = Files::new(\"/\", \".\")\n .default_handler(|req: ServiceRequest| async {\n Ok(req.into_response(HttpResponse::Ok().body(\"default content\")))\n })\n .new_service(())\n .await\n .unwrap();\n let req = TestRequest::with_uri(\"/missing\").to_srv_request();\n let resp = test::call_service(&st, req).await;\n\n assert_eq!(resp.status(), StatusCode::OK);\n let bytes = test::read_body(resp).await;\n assert_eq!(bytes, web::Bytes::from_static(b\"default content\"));\n }\n\n #[actix_rt::test]\n async fn test_serve_index_nested() {\n let service = Files::new(\".\", \".\")\n .index_file(\"lib.rs\")\n .new_service(())\n .await\n .unwrap();\n\n let req = TestRequest::default().uri(\"/src\").to_srv_request();\n let resp = test::call_service(&service, req).await;\n\n assert_eq!(resp.status(), StatusCode::OK);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/x-rust\"\n );\n assert_eq!(\n resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"lib.rs\\\"\"\n );\n }\n\n #[actix_rt::test]\n async fn integration_serve_index() {\n let srv = test::init_service(\n App::new().service(Files::new(\"test\", \".\").index_file(\"Cargo.toml\")),\n )\n .await;\n\n let req = TestRequest::get().uri(\"/test\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n\n let bytes = test::read_body(res).await;\n\n let data = Bytes::from(fs::read(\"Cargo.toml\").unwrap());\n assert_eq!(bytes, data);\n\n let req = TestRequest::get().uri(\"/test/\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n\n let bytes = test::read_body(res).await;\n let data = Bytes::from(fs::read(\"Cargo.toml\").unwrap());\n assert_eq!(bytes, data);\n\n // nonexistent index file\n let req = TestRequest::get().uri(\"/test/unknown\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n\n let req = TestRequest::get().uri(\"/test/unknown/\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn integration_percent_encoded() {\n let srv = test::init_service(\n App::new().service(Files::new(\"test\", \".\").index_file(\"Cargo.toml\")),\n )\n .await;\n\n let req = TestRequest::get().uri(\"/test/%43argo.toml\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n\n // `%2F` == `/`\n let req = TestRequest::get().uri(\"/test%2Ftest.binary\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n\n let req = TestRequest::get().uri(\"/test/Cargo.toml%00\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_percent_encoding_2() {\n let temp_dir = tempfile::tempdir().unwrap();\n let filename = match cfg!(unix) {\n true => \"ض:?#[]{}<>()@!$&'`|*+,;= %20\\n.test\",\n false => \"ض#[]{}()@!$&'`+,;= %20.test\",\n };\n let filename_encoded = filename\n .as_bytes()\n .iter()\n .fold(String::new(), |mut buf, c| {\n write!(&mut buf, \"%{:02X}\", c).unwrap();\n buf\n });\n std::fs::File::create(temp_dir.path().join(filename)).unwrap();\n\n let srv = test::init_service(App::new().service(Files::new(\"/\", temp_dir.path()))).await;\n\n let req = TestRequest::get()\n .uri(&format!(\"/{}\", filename_encoded))\n .to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n }\n\n #[actix_rt::test]\n async fn test_serve_named_file() {\n let factory = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let srv = test::init_service(App::new().service(factory)).await;\n\n let req = TestRequest::get().uri(\"/Cargo.toml\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n\n let bytes = test::read_body(res).await;\n let data = Bytes::from(fs::read(\"Cargo.toml\").unwrap());\n assert_eq!(bytes, data);\n\n let req = TestRequest::get().uri(\"/test/unknown\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_serve_named_file_prefix() {\n let factory = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let srv =\n test::init_service(App::new().service(web::scope(\"/test\").service(factory))).await;\n\n let req = TestRequest::get().uri(\"/test/Cargo.toml\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n\n let bytes = test::read_body(res).await;\n let data = Bytes::from(fs::read(\"Cargo.toml\").unwrap());\n assert_eq!(bytes, data);\n\n let req = TestRequest::get().uri(\"/Cargo.toml\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_named_file_default_service() {\n let factory = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let srv = test::init_service(App::new().default_service(factory)).await;\n\n for route in [\"/foobar\", \"/baz\", \"/\"].iter() {\n let req = TestRequest::get().uri(route).to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n\n let bytes = test::read_body(res).await;\n let data = Bytes::from(fs::read(\"Cargo.toml\").unwrap());\n assert_eq!(bytes, data);\n }\n }\n\n #[actix_rt::test]\n async fn test_default_handler_named_file() {\n let factory = NamedFile::open_async(\"Cargo.toml\").await.unwrap();\n let st = Files::new(\"/\", \".\")\n .default_handler(factory)\n .new_service(())\n .await\n .unwrap();\n let req = TestRequest::with_uri(\"/missing\").to_srv_request();\n let resp = test::call_service(&st, req).await;\n\n assert_eq!(resp.status(), StatusCode::OK);\n let bytes = test::read_body(resp).await;\n let data = Bytes::from(fs::read(\"Cargo.toml\").unwrap());\n assert_eq!(bytes, data);\n }\n\n #[actix_rt::test]\n async fn test_symlinks() {\n let srv = test::init_service(App::new().service(Files::new(\"test\", \".\"))).await;\n\n let req = TestRequest::get()\n .uri(\"/test/tests/symlink-test.png\")\n .to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_DISPOSITION).unwrap(),\n \"inline; filename=\\\"symlink-test.png\\\"\"\n );\n }\n\n #[actix_rt::test]\n async fn test_index_with_show_files_listing() {\n let service = Files::new(\".\", \".\")\n .index_file(\"lib.rs\")\n .show_files_listing()\n .new_service(())\n .await\n .unwrap();\n\n // Serve the index if exists\n let req = TestRequest::default().uri(\"/src\").to_srv_request();\n let resp = test::call_service(&service, req).await;\n assert_eq!(resp.status(), StatusCode::OK);\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/x-rust\"\n );\n\n // Show files listing, otherwise.\n let req = TestRequest::default().uri(\"/tests\").to_srv_request();\n let resp = test::call_service(&service, req).await;\n assert_eq!(\n resp.headers().get(header::CONTENT_TYPE).unwrap(),\n \"text/html; charset=utf-8\"\n );\n let bytes = test::read_body(resp).await;\n assert!(format!(\"{:?}\", bytes).contains(\"/tests/test.png\"));\n }\n\n #[actix_rt::test]\n async fn test_path_filter() {\n // prevent searching subdirectories\n let st = Files::new(\"/\", \".\")\n .path_filter(|path, _| path.components().count() == 1)\n .new_service(())\n .await\n .unwrap();\n\n let req = TestRequest::with_uri(\"/Cargo.toml\").to_srv_request();\n let resp = test::call_service(&st, req).await;\n assert_eq!(resp.status(), StatusCode::OK);\n\n let req = TestRequest::with_uri(\"/src/lib.rs\").to_srv_request();\n let resp = test::call_service(&st, req).await;\n assert_eq!(resp.status(), StatusCode::NOT_FOUND);\n }\n\n #[actix_rt::test]\n async fn test_default_handler_filter() {\n let st = Files::new(\"/\", \".\")\n .default_handler(|req: ServiceRequest| async {\n Ok(req.into_response(HttpResponse::Ok().body(\"default content\")))\n })\n .path_filter(|path, _| path.extension() == Some(\"png\".as_ref()))\n .new_service(())\n .await\n .unwrap();\n let req = TestRequest::with_uri(\"/Cargo.toml\").to_srv_request();\n let resp = test::call_service(&st, req).await;\n\n assert_eq!(resp.status(), StatusCode::OK);\n let bytes = test::read_body(resp).await;\n assert_eq!(bytes, web::Bytes::from_static(b\"default content\"));\n }\n}\n" }, { "path": "actix-files/src/named.rs", "content": "use std::{\n fs::Metadata,\n io,\n path::{Path, PathBuf},\n time::{SystemTime, UNIX_EPOCH},\n};\n\nuse actix_web::{\n body::{self, BoxBody, SizedStream},\n dev::{\n self, AppService, HttpServiceFactory, ResourceDef, Service, ServiceFactory, ServiceRequest,\n ServiceResponse,\n },\n http::{\n header::{\n self, Charset, ContentDisposition, ContentEncoding, DispositionParam, DispositionType,\n ExtendedValue,\n },\n StatusCode,\n },\n Error, HttpMessage, HttpRequest, HttpResponse, Responder,\n};\nuse bitflags::bitflags;\nuse derive_more::{Deref, DerefMut};\nuse futures_core::future::LocalBoxFuture;\nuse mime::Mime;\n\nuse crate::{encoding::equiv_utf8_text, range::HttpRange};\n\nbitflags! {\n #[derive(Debug, Clone, Copy)]\n pub(crate) struct Flags: u8 {\n const ETAG = 0b0000_0001;\n const LAST_MD = 0b0000_0010;\n const CONTENT_DISPOSITION = 0b0000_0100;\n const PREFER_UTF8 = 0b0000_1000;\n }\n}\n\nimpl Default for Flags {\n fn default() -> Self {\n Flags::from_bits_truncate(0b0000_1111)\n }\n}\n\n/// A file with an associated name.\n///\n/// `NamedFile` can be registered as services:\n/// ```\n/// use actix_web::App;\n/// use actix_files::NamedFile;\n///\n/// # async fn run() -> Result<(), Box> {\n/// let file = NamedFile::open_async(\"./static/index.html\").await?;\n/// let app = App::new().service(file);\n/// # Ok(())\n/// # }\n/// ```\n///\n/// They can also be returned from handlers:\n/// ```\n/// use actix_web::{Responder, get};\n/// use actix_files::NamedFile;\n///\n/// #[get(\"/\")]\n/// async fn index() -> impl Responder {\n/// NamedFile::open_async(\"./static/index.html\").await\n/// }\n/// ```\n#[derive(Debug, Deref, DerefMut)]\npub struct NamedFile {\n #[deref]\n #[deref_mut]\n file: File,\n path: PathBuf,\n modified: Option,\n pub(crate) md: Metadata,\n pub(crate) flags: Flags,\n pub(crate) status_code: StatusCode,\n pub(crate) content_type: Mime,\n pub(crate) content_disposition: ContentDisposition,\n pub(crate) encoding: Option,\n pub(crate) read_mode_threshold: u64,\n}\n\n#[cfg(not(feature = \"experimental-io-uring\"))]\npub(crate) use std::fs::File;\n\n#[cfg(feature = \"experimental-io-uring\")]\npub(crate) use tokio_uring::fs::File;\n\nuse super::chunked;\n\npub(crate) fn get_content_type_and_disposition(\n path: &Path,\n) -> Result<(mime::Mime, ContentDisposition), io::Error> {\n let filename = match path.file_name() {\n Some(name) => name.to_string_lossy(),\n None => {\n return Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Provided path has no filename\",\n ));\n }\n };\n\n let ct = mime_guess::from_path(path).first_or_octet_stream();\n\n let disposition = match ct.type_() {\n mime::IMAGE | mime::TEXT | mime::AUDIO | mime::VIDEO => DispositionType::Inline,\n mime::APPLICATION => match ct.subtype() {\n mime::JAVASCRIPT | mime::JSON => DispositionType::Inline,\n name if name == \"wasm\" || name == \"xhtml\" => DispositionType::Inline,\n _ => DispositionType::Attachment,\n },\n _ => DispositionType::Attachment,\n };\n\n // replace special characters in filenames which could occur on some filesystems\n let filename_s = filename\n .replace('\\n', \"%0A\") // \\n line break\n .replace('\\x0B', \"%0B\") // \\v vertical tab\n .replace('\\x0C', \"%0C\") // \\f form feed\n .replace('\\r', \"%0D\"); // \\r carriage return\n let mut parameters = vec![DispositionParam::Filename(filename_s)];\n\n if !filename.is_ascii() {\n parameters.push(DispositionParam::FilenameExt(ExtendedValue {\n charset: Charset::Ext(String::from(\"UTF-8\")),\n language_tag: None,\n value: filename.into_owned().into_bytes(),\n }))\n }\n\n let cd = ContentDisposition {\n disposition,\n parameters,\n };\n\n Ok((ct, cd))\n}\n\nimpl NamedFile {\n /// Creates an instance from a previously opened file.\n ///\n /// The given `path` need not exist and is only used to determine the `ContentType` and\n /// `ContentDisposition` headers.\n ///\n /// # Examples\n /// ```ignore\n /// use std::{\n /// io::{self, Write as _},\n /// env,\n /// fs::File\n /// };\n /// use actix_files::NamedFile;\n ///\n /// let mut file = File::create(\"foo.txt\")?;\n /// file.write_all(b\"Hello, world!\")?;\n /// let named_file = NamedFile::from_file(file, \"bar.txt\")?;\n /// # std::fs::remove_file(\"foo.txt\");\n /// Ok(())\n /// ```\n pub fn from_file>(file: File, path: P) -> io::Result {\n let path = path.as_ref().to_path_buf();\n\n // Get the name of the file and use it to construct default Content-Type\n // and Content-Disposition values\n let (content_type, content_disposition) = get_content_type_and_disposition(&path)?;\n\n let md = {\n #[cfg(not(feature = \"experimental-io-uring\"))]\n {\n file.metadata()?\n }\n\n #[cfg(feature = \"experimental-io-uring\")]\n {\n use std::os::unix::prelude::{AsRawFd, FromRawFd};\n\n let fd = file.as_raw_fd();\n\n // SAFETY: fd is borrowed and lives longer than the unsafe block\n unsafe {\n let file = std::fs::File::from_raw_fd(fd);\n let md = file.metadata();\n // SAFETY: forget the fd before exiting block in success or error case but don't\n // run destructor (that would close file handle)\n std::mem::forget(file);\n md?\n }\n }\n };\n\n let modified = md.modified().ok();\n let encoding = None;\n\n Ok(NamedFile {\n path,\n file,\n content_type,\n content_disposition,\n md,\n modified,\n encoding,\n status_code: StatusCode::OK,\n flags: Flags::default(),\n read_mode_threshold: 0,\n })\n }\n\n /// Attempts to open a file in read-only mode.\n ///\n /// # Examples\n /// ```\n /// use actix_files::NamedFile;\n /// let file = NamedFile::open(\"foo.txt\");\n /// ```\n #[cfg(not(feature = \"experimental-io-uring\"))]\n pub fn open>(path: P) -> io::Result {\n let file = File::open(&path)?;\n Self::from_file(file, path)\n }\n\n /// Attempts to open a file asynchronously in read-only mode.\n ///\n /// When the `experimental-io-uring` crate feature is enabled, this will be async. Otherwise, it\n /// will behave just like `open`.\n ///\n /// # Examples\n /// ```\n /// use actix_files::NamedFile;\n /// # async fn open() {\n /// let file = NamedFile::open_async(\"foo.txt\").await.unwrap();\n /// # }\n /// ```\n pub async fn open_async>(path: P) -> io::Result {\n let file = {\n #[cfg(not(feature = \"experimental-io-uring\"))]\n {\n File::open(&path)?\n }\n\n #[cfg(feature = \"experimental-io-uring\")]\n {\n File::open(&path).await?\n }\n };\n\n Self::from_file(file, path)\n }\n\n /// Returns reference to the underlying file object.\n #[inline]\n pub fn file(&self) -> &File {\n &self.file\n }\n\n /// Returns the filesystem path to this file.\n ///\n /// # Examples\n /// ```\n /// # use std::io;\n /// use actix_files::NamedFile;\n ///\n /// # async fn path() -> io::Result<()> {\n /// let file = NamedFile::open_async(\"test.txt\").await?;\n /// assert_eq!(file.path().as_os_str(), \"foo.txt\");\n /// # Ok(())\n /// # }\n /// ```\n #[inline]\n pub fn path(&self) -> &Path {\n self.path.as_path()\n }\n\n /// Returns the time the file was last modified.\n ///\n /// Returns `None` only on unsupported platforms; see [`std::fs::Metadata::modified()`].\n /// Therefore, it is usually safe to unwrap this.\n #[inline]\n pub fn modified(&self) -> Option {\n self.modified\n }\n\n /// Returns the filesystem metadata associated with this file.\n #[inline]\n pub fn metadata(&self) -> &Metadata {\n &self.md\n }\n\n /// Returns the `Content-Type` header that will be used when serving this file.\n #[inline]\n pub fn content_type(&self) -> &Mime {\n &self.content_type\n }\n\n /// Returns the `Content-Disposition` that will be used when serving this file.\n #[inline]\n pub fn content_disposition(&self) -> &ContentDisposition {\n &self.content_disposition\n }\n\n /// Returns the `Content-Encoding` that will be used when serving this file.\n ///\n /// A return value of `None` indicates that the content is not already using a compressed\n /// representation and may be subject to compression downstream.\n #[inline]\n pub fn content_encoding(&self) -> Option {\n self.encoding\n }\n\n /// Set response status code.\n #[deprecated(since = \"0.7.0\", note = \"Prefer `Responder::customize()`.\")]\n pub fn set_status_code(mut self, status: StatusCode) -> Self {\n self.status_code = status;\n self\n }\n\n /// Sets the `Content-Type` header that will be used when serving this file. By default the\n /// `Content-Type` is inferred from the filename extension.\n #[inline]\n pub fn set_content_type(mut self, mime_type: Mime) -> Self {\n self.content_type = mime_type;\n self\n }\n\n /// Set the Content-Disposition for serving this file. This allows changing the\n /// `inline/attachment` disposition as well as the filename sent to the peer.\n ///\n /// By default the disposition is `inline` for `text/*`, `image/*`, `video/*` and\n /// `application/{javascript, json, wasm}` mime types, and `attachment` otherwise, and the\n /// filename is taken from the path provided in the `open` method after converting it to UTF-8\n /// (using `to_string_lossy`).\n #[inline]\n pub fn set_content_disposition(mut self, cd: ContentDisposition) -> Self {\n self.content_disposition = cd;\n self.flags.insert(Flags::CONTENT_DISPOSITION);\n self\n }\n\n /// Disables `Content-Disposition` header.\n ///\n /// By default, the `Content-Disposition` header is sent.\n #[inline]\n pub fn disable_content_disposition(mut self) -> Self {\n self.flags.remove(Flags::CONTENT_DISPOSITION);\n self\n }\n\n /// Sets content encoding for this file.\n ///\n /// This prevents the `Compress` middleware from modifying the file contents and signals to\n /// browsers/clients how to decode it. For example, if serving a compressed HTML file (e.g.,\n /// `index.html.gz`) then use `.set_content_encoding(ContentEncoding::Gzip)`.\n #[inline]\n pub fn set_content_encoding(mut self, enc: ContentEncoding) -> Self {\n self.encoding = Some(enc);\n self\n }\n\n /// Sets the size threshold that determines file read mode (sync/async).\n ///\n /// When a file is smaller than the threshold (bytes), the reader will use synchronous\n /// (blocking) file reads. For larger files, it switches to async reads to avoid blocking the\n /// main thread.\n ///\n /// Tweaking this value according to your expected usage may lead to significant performance\n /// gains (or losses in other handlers, if `size` is too high).\n ///\n /// When the `experimental-io-uring` crate feature is enabled, file reads are always async.\n ///\n /// Default is 0, meaning all files are read asynchronously.\n pub fn read_mode_threshold(mut self, size: u64) -> Self {\n self.read_mode_threshold = size;\n self\n }\n\n /// Specifies whether to return `ETag` header in response.\n ///\n /// Default is true.\n #[inline]\n pub fn use_etag(mut self, value: bool) -> Self {\n self.flags.set(Flags::ETAG, value);\n self\n }\n\n /// Specifies whether to return `Last-Modified` header in response.\n ///\n /// Default is true.\n #[inline]\n pub fn use_last_modified(mut self, value: bool) -> Self {\n self.flags.set(Flags::LAST_MD, value);\n self\n }\n\n /// Specifies whether text responses should signal a UTF-8 encoding.\n ///\n /// Default is false (but will default to true in a future version).\n #[inline]\n pub fn prefer_utf8(mut self, value: bool) -> Self {\n self.flags.set(Flags::PREFER_UTF8, value);\n self\n }\n\n /// Creates an `ETag` in a format is similar to Apache's.\n pub(crate) fn etag(&self) -> Option {\n let mtime = self.modified?;\n\n Some({\n let ino = {\n #[cfg(unix)]\n {\n #[cfg(unix)]\n use std::os::unix::fs::MetadataExt as _;\n\n self.md.ino()\n }\n\n #[cfg(not(unix))]\n {\n 0\n }\n };\n\n // Don't panic for pre-epoch modification times. Encode the timestamp as seconds and\n // sub-second nanoseconds relative to the UNIX epoch, allowing negative values.\n let (secs, nanos) = match mtime.duration_since(UNIX_EPOCH) {\n Ok(dur) => (dur.as_secs() as i64, dur.subsec_nanos()),\n Err(err) => {\n let dur = err.duration();\n\n // For timestamps before the epoch, represent the time as a negative seconds\n // offset with positive nanoseconds (like POSIX timespec).\n if dur.subsec_nanos() == 0 {\n (-(dur.as_secs() as i64), 0)\n } else {\n (\n -(dur.as_secs() as i64) - 1,\n 1_000_000_000 - dur.subsec_nanos(),\n )\n }\n }\n };\n\n header::EntityTag::new_strong(format!(\n \"{:x}:{:x}:{:x}:{:x}\",\n ino,\n self.md.len(),\n secs as u64,\n nanos\n ))\n })\n }\n\n pub(crate) fn last_modified(&self) -> Option {\n let mtime = self.modified?;\n\n // avoid panic in `httpdate` crate when formatting as an HTTP date\n // see: https://github.com/actix/actix-web/issues/2748\n //\n // httpdate supports dates in range [1970, 9999); see:\n // https://github.com/seanmonstar/httpdate/blob/v1.0.3/src/date.rs\n let dur = mtime.duration_since(UNIX_EPOCH).ok()?;\n if dur.as_secs() >= 253_402_300_800 {\n return None;\n }\n\n Some(mtime.into())\n }\n\n /// Creates an `HttpResponse` with file as a streaming body.\n pub fn into_response(self, req: &HttpRequest) -> HttpResponse {\n if self.status_code != StatusCode::OK {\n let mut res = HttpResponse::build(self.status_code);\n\n let ct = if self.flags.contains(Flags::PREFER_UTF8) {\n equiv_utf8_text(self.content_type.clone())\n } else {\n self.content_type\n };\n\n res.insert_header((header::CONTENT_TYPE, ct.to_string()));\n\n if self.flags.contains(Flags::CONTENT_DISPOSITION) {\n res.insert_header((\n header::CONTENT_DISPOSITION,\n self.content_disposition.to_string(),\n ));\n }\n\n if let Some(current_encoding) = self.encoding {\n res.insert_header((header::CONTENT_ENCODING, current_encoding.as_str()));\n }\n\n let reader =\n chunked::new_chunked_read(self.md.len(), 0, self.file, self.read_mode_threshold);\n\n return res.streaming(reader);\n }\n\n let etag = if self.flags.contains(Flags::ETAG) {\n self.etag()\n } else {\n None\n };\n\n let last_modified = if self.flags.contains(Flags::LAST_MD) {\n self.last_modified()\n } else {\n None\n };\n\n // check preconditions\n let precondition_failed = if !any_match(etag.as_ref(), req) {\n true\n } else if let (Some(ref m), Some(header::IfUnmodifiedSince(ref since))) =\n (last_modified, req.get_header())\n {\n let t1: SystemTime = (*m).into();\n let t2: SystemTime = (*since).into();\n\n match (t1.duration_since(UNIX_EPOCH), t2.duration_since(UNIX_EPOCH)) {\n (Ok(t1), Ok(t2)) => t1.as_secs() > t2.as_secs(),\n _ => false,\n }\n } else {\n false\n };\n\n // check last modified\n let not_modified = if !none_match(etag.as_ref(), req) {\n true\n } else if req.headers().contains_key(header::IF_NONE_MATCH) {\n false\n } else if let (Some(ref m), Some(header::IfModifiedSince(ref since))) =\n (last_modified, req.get_header())\n {\n let t1: SystemTime = (*m).into();\n let t2: SystemTime = (*since).into();\n\n match (t1.duration_since(UNIX_EPOCH), t2.duration_since(UNIX_EPOCH)) {\n (Ok(t1), Ok(t2)) => t1.as_secs() <= t2.as_secs(),\n _ => false,\n }\n } else {\n false\n };\n\n let mut res = HttpResponse::build(self.status_code);\n\n let ct = if self.flags.contains(Flags::PREFER_UTF8) {\n equiv_utf8_text(self.content_type.clone())\n } else {\n self.content_type\n };\n\n res.insert_header((header::CONTENT_TYPE, ct.to_string()));\n\n if self.flags.contains(Flags::CONTENT_DISPOSITION) {\n res.insert_header((\n header::CONTENT_DISPOSITION,\n self.content_disposition.to_string(),\n ));\n }\n\n if let Some(current_encoding) = self.encoding {\n res.insert_header((header::CONTENT_ENCODING, current_encoding.as_str()));\n }\n\n if let Some(lm) = last_modified {\n res.insert_header((header::LAST_MODIFIED, lm.to_string()));\n }\n\n if let Some(etag) = etag {\n res.insert_header((header::ETAG, etag.to_string()));\n }\n\n res.insert_header((header::ACCEPT_RANGES, \"bytes\"));\n\n let mut length = self.md.len();\n let mut offset = 0;\n let mut ranged_req = false;\n\n // check for range header\n if let Some(ranges) = req.headers().get(header::RANGE) {\n if let Ok(ranges_header) = ranges.to_str() {\n if let Some(range) = HttpRange::parse(ranges_header, length)\n .ok()\n .and_then(|ranges| ranges.first().copied())\n {\n ranged_req = true;\n length = range.length;\n offset = range.start;\n\n res.insert_header((\n header::CONTENT_RANGE,\n format!(\"bytes {}-{}/{}\", offset, offset + length - 1, self.md.len()),\n ));\n } else {\n res.insert_header((header::CONTENT_RANGE, format!(\"bytes */{}\", length)));\n return res.status(StatusCode::RANGE_NOT_SATISFIABLE).finish();\n };\n } else {\n return res.status(StatusCode::BAD_REQUEST).finish();\n };\n };\n\n if precondition_failed {\n return res.status(StatusCode::PRECONDITION_FAILED).finish();\n } else if not_modified {\n return res\n .status(StatusCode::NOT_MODIFIED)\n .body(body::None::new())\n .map_into_boxed_body();\n }\n\n let reader = chunked::new_chunked_read(length, offset, self.file, self.read_mode_threshold);\n\n if ranged_req {\n res.status(StatusCode::PARTIAL_CONTENT);\n }\n\n res.body(SizedStream::new(length, reader))\n }\n}\n\n/// Returns true if `req` has no `If-Match` header or one which matches `etag`.\nfn any_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {\n match req.get_header::() {\n None | Some(header::IfMatch::Any) => true,\n\n Some(header::IfMatch::Items(ref items)) => {\n if let Some(some_etag) = etag {\n for item in items {\n if item.strong_eq(some_etag) {\n return true;\n }\n }\n }\n\n false\n }\n }\n}\n\n/// Returns true if `req` doesn't have an `If-None-Match` header matching `req`.\nfn none_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {\n match req.get_header::() {\n Some(header::IfNoneMatch::Any) => false,\n\n Some(header::IfNoneMatch::Items(ref items)) => {\n if let Some(some_etag) = etag {\n for item in items {\n if item.weak_eq(some_etag) {\n return false;\n }\n }\n }\n\n true\n }\n\n None => true,\n }\n}\n\nimpl Responder for NamedFile {\n type Body = BoxBody;\n\n fn respond_to(self, req: &HttpRequest) -> HttpResponse {\n self.into_response(req)\n }\n}\n\nimpl ServiceFactory for NamedFile {\n type Response = ServiceResponse;\n type Error = Error;\n type Config = ();\n type Service = NamedFileService;\n type InitError = ();\n type Future = LocalBoxFuture<'static, Result>;\n\n fn new_service(&self, _: ()) -> Self::Future {\n let service = NamedFileService {\n path: self.path.clone(),\n };\n\n Box::pin(async move { Ok(service) })\n }\n}\n\n#[doc(hidden)]\n#[derive(Debug)]\npub struct NamedFileService {\n path: PathBuf,\n}\n\nimpl Service for NamedFileService {\n type Response = ServiceResponse;\n type Error = Error;\n type Future = LocalBoxFuture<'static, Result>;\n\n dev::always_ready!();\n\n fn call(&self, req: ServiceRequest) -> Self::Future {\n let (req, _) = req.into_parts();\n\n let path = self.path.clone();\n Box::pin(async move {\n let file = NamedFile::open_async(path).await?;\n let res = file.into_response(&req);\n Ok(ServiceResponse::new(req, res))\n })\n }\n}\n\nimpl HttpServiceFactory for NamedFile {\n fn register(self, config: &mut AppService) {\n config.register_service(\n ResourceDef::root_prefix(self.path.to_string_lossy().as_ref()),\n None,\n self,\n None,\n )\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n\n #[test]\n fn audio_files_use_inline_content_disposition() {\n let (_ct, cd) = get_content_type_and_disposition(Path::new(\"sound.mp3\")).unwrap();\n assert_eq!(cd.disposition, DispositionType::Inline);\n }\n}\n" }, { "path": "actix-files/src/path_buf.rs", "content": "use std::{\n path::{Component, Path, PathBuf},\n str::FromStr,\n};\n\nuse actix_utils::future::{ready, Ready};\nuse actix_web::{dev::Payload, FromRequest, HttpRequest};\n\nuse crate::error::UriSegmentError;\n\n/// Secure Path Traversal Guard\n///\n/// This struct parses a request-uri [`PathBuf`](std::path::PathBuf)\n#[derive(Debug, PartialEq, Eq)]\npub struct PathBufWrap(PathBuf);\n\nimpl FromStr for PathBufWrap {\n type Err = UriSegmentError;\n\n fn from_str(path: &str) -> Result {\n Self::parse_path(path, false)\n }\n}\n\nimpl PathBufWrap {\n /// Parse a safe path from the unprocessed tail of a supplied\n /// [`HttpRequest`](actix_web::HttpRequest), given the choice of allowing hidden files to be\n /// considered valid segments.\n ///\n /// This uses [`HttpRequest::match_info`](actix_web::HttpRequest::match_info) and\n /// [`Path::unprocessed`](actix_web::dev::Path::unprocessed), which returns the part of the\n /// path not matched by route patterns. This is useful for mounted services (eg. `Files`),\n /// where only the tail should be parsed.\n ///\n /// Path traversal is guarded by this method.\n #[inline]\n pub fn parse_unprocessed_req(\n req: &HttpRequest,\n hidden_files: bool,\n ) -> Result {\n Self::parse_path(req.match_info().unprocessed(), hidden_files)\n }\n\n /// Parse a safe path from the full request path of a supplied\n /// [`HttpRequest`](actix_web::HttpRequest), given the choice of allowing hidden files to be\n /// considered valid segments.\n ///\n /// This uses [`HttpRequest::path`](actix_web::HttpRequest::path), and is more appropriate\n /// for non-mounted handlers that want the entire request path.\n ///\n /// Path traversal is guarded by this method.\n #[inline]\n pub fn parse_req_path(req: &HttpRequest, hidden_files: bool) -> Result {\n Self::parse_path(req.path(), hidden_files)\n }\n\n /// Parse a path, giving the choice of allowing hidden files to be considered valid segments.\n ///\n /// Path traversal is guarded by this method.\n pub fn parse_path(path: &str, hidden_files: bool) -> Result {\n let mut buf = PathBuf::new();\n\n // equivalent to `path.split('/').count()`\n let mut segment_count = path.matches('/').count() + 1;\n\n // we can decode the whole path here (instead of per-segment decoding)\n // because we will reject `%2F` in paths using `segment_count`.\n let path = percent_encoding::percent_decode_str(path)\n .decode_utf8()\n .map_err(|_| UriSegmentError::NotValidUtf8)?;\n\n // disallow decoding `%2F` into `/`\n if segment_count != path.matches('/').count() + 1 {\n return Err(UriSegmentError::BadChar('/'));\n }\n\n for segment in path.split('/') {\n if segment == \"..\" {\n segment_count -= 1;\n buf.pop();\n } else if !hidden_files && segment.starts_with('.') {\n return Err(UriSegmentError::BadStart('.'));\n } else if segment.starts_with('*') {\n return Err(UriSegmentError::BadStart('*'));\n } else if segment.ends_with(':') {\n return Err(UriSegmentError::BadEnd(':'));\n } else if segment.ends_with('>') {\n return Err(UriSegmentError::BadEnd('>'));\n } else if segment.ends_with('<') {\n return Err(UriSegmentError::BadEnd('<'));\n } else if segment.is_empty() {\n segment_count -= 1;\n continue;\n } else if cfg!(windows) && segment.contains('\\\\') {\n return Err(UriSegmentError::BadChar('\\\\'));\n } else if cfg!(windows) && segment.contains(':') {\n return Err(UriSegmentError::BadChar(':'));\n } else {\n buf.push(segment)\n }\n }\n\n // make sure we agree with stdlib parser\n for (i, component) in buf.components().enumerate() {\n assert!(\n matches!(component, Component::Normal(_)),\n \"component `{:?}` is not normal\",\n component\n );\n assert!(i < segment_count);\n }\n\n Ok(PathBufWrap(buf))\n }\n}\n\nimpl AsRef for PathBufWrap {\n fn as_ref(&self) -> &Path {\n self.0.as_ref()\n }\n}\n\nimpl FromRequest for PathBufWrap {\n type Error = UriSegmentError;\n type Future = Ready>;\n\n fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {\n // Uses the unprocessed tail of the request path and disallows hidden files.\n ready(req.match_info().unprocessed().parse())\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n\n #[test]\n fn test_path_buf() {\n assert_eq!(\n PathBufWrap::from_str(\"/test/.tt\").map(|t| t.0),\n Err(UriSegmentError::BadStart('.'))\n );\n assert_eq!(\n PathBufWrap::from_str(\"/test/*tt\").map(|t| t.0),\n Err(UriSegmentError::BadStart('*'))\n );\n assert_eq!(\n PathBufWrap::from_str(\"/test/tt:\").map(|t| t.0),\n Err(UriSegmentError::BadEnd(':'))\n );\n assert_eq!(\n PathBufWrap::from_str(\"/test/tt<\").map(|t| t.0),\n Err(UriSegmentError::BadEnd('<'))\n );\n assert_eq!(\n PathBufWrap::from_str(\"/test/tt>\").map(|t| t.0),\n Err(UriSegmentError::BadEnd('>'))\n );\n assert_eq!(\n PathBufWrap::from_str(\"/seg1/seg2/\").unwrap().0,\n PathBuf::from_iter(vec![\"seg1\", \"seg2\"])\n );\n assert_eq!(\n PathBufWrap::from_str(\"/seg1/../seg2/\").unwrap().0,\n PathBuf::from_iter(vec![\"seg2\"])\n );\n }\n\n #[test]\n fn test_parse_path() {\n assert_eq!(\n PathBufWrap::parse_path(\"/test/.tt\", false).map(|t| t.0),\n Err(UriSegmentError::BadStart('.'))\n );\n\n assert_eq!(\n PathBufWrap::parse_path(\"/test/.tt\", true).unwrap().0,\n PathBuf::from_iter(vec![\"test\", \".tt\"])\n );\n }\n\n #[test]\n fn path_traversal() {\n assert_eq!(\n PathBufWrap::parse_path(\"/../README.md\", false).unwrap().0,\n PathBuf::from_iter(vec![\"README.md\"])\n );\n\n assert_eq!(\n PathBufWrap::parse_path(\"/../README.md\", true).unwrap().0,\n PathBuf::from_iter(vec![\"README.md\"])\n );\n\n assert_eq!(\n PathBufWrap::parse_path(\"/../../../../../../../../../../etc/passwd\", false)\n .unwrap()\n .0,\n PathBuf::from_iter(vec![\"etc/passwd\"])\n );\n }\n\n #[test]\n #[cfg_attr(windows, should_panic)]\n fn windows_drive_traversal() {\n // detect issues in windows that could lead to path traversal\n // see for HttpRangeParseError {\n fn from(err: http_range::HttpRangeParseError) -> Self {\n match err {\n http_range::HttpRangeParseError::InvalidRange => Self::InvalidRange,\n http_range::HttpRangeParseError::NoOverlap => Self::NoOverlap,\n }\n }\n}\n\n#[derive(Debug, Clone, Error)]\n#[non_exhaustive]\npub struct ParseRangeErr(#[error(not(source))] HttpRangeParseError);\n\nimpl fmt::Display for ParseRangeErr {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"invalid Range header: \")?;\n f.write_str(match self.0 {\n HttpRangeParseError::InvalidRange => \"invalid syntax\",\n HttpRangeParseError::NoOverlap => \"range starts after end of content\",\n })\n }\n}\n\n/// HTTP Range header representation.\n#[derive(Debug, Clone, Copy)]\npub struct HttpRange {\n /// Start of range.\n pub start: u64,\n\n /// Length of range.\n pub length: u64,\n}\n\nimpl HttpRange {\n /// Parses Range HTTP header string as per RFC 2616.\n ///\n /// `header` is HTTP Range header (e.g. `bytes=0-9`).\n /// `size` is full size of response (file).\n pub fn parse(header: &str, size: u64) -> Result, ParseRangeErr> {\n let ranges =\n http_range::HttpRange::parse(header, size).map_err(|err| ParseRangeErr(err.into()))?;\n\n Ok(ranges\n .iter()\n .map(|range| HttpRange {\n start: range.start,\n length: range.length,\n })\n .collect())\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n\n struct T(&'static str, u64, Vec);\n\n #[test]\n fn test_parse() {\n let tests = vec![\n T(\"\", 0, vec![]),\n T(\"\", 1000, vec![]),\n T(\"foo\", 0, vec![]),\n T(\"bytes=\", 0, vec![]),\n T(\"bytes=7\", 10, vec![]),\n T(\"bytes= 7 \", 10, vec![]),\n T(\"bytes=1-\", 0, vec![]),\n T(\"bytes=5-4\", 10, vec![]),\n T(\"bytes=0-2,5-4\", 10, vec![]),\n T(\"bytes=2-5,4-3\", 10, vec![]),\n T(\"bytes=--5,4--3\", 10, vec![]),\n T(\"bytes=A-\", 10, vec![]),\n T(\"bytes=A- \", 10, vec![]),\n T(\"bytes=A-Z\", 10, vec![]),\n T(\"bytes= -Z\", 10, vec![]),\n T(\"bytes=5-Z\", 10, vec![]),\n T(\"bytes=Ran-dom, garbage\", 10, vec![]),\n T(\"bytes=0x01-0x02\", 10, vec![]),\n T(\"bytes= \", 10, vec![]),\n T(\"bytes= , , , \", 10, vec![]),\n T(\n \"bytes=0-9\",\n 10,\n vec![HttpRange {\n start: 0,\n length: 10,\n }],\n ),\n T(\n \"bytes=0-\",\n 10,\n vec![HttpRange {\n start: 0,\n length: 10,\n }],\n ),\n T(\n \"bytes=5-\",\n 10,\n vec![HttpRange {\n start: 5,\n length: 5,\n }],\n ),\n T(\n \"bytes=0-20\",\n 10,\n vec![HttpRange {\n start: 0,\n length: 10,\n }],\n ),\n T(\n \"bytes=15-,0-5\",\n 10,\n vec![HttpRange {\n start: 0,\n length: 6,\n }],\n ),\n T(\n \"bytes=1-2,5-\",\n 10,\n vec![\n HttpRange {\n start: 1,\n length: 2,\n },\n HttpRange {\n start: 5,\n length: 5,\n },\n ],\n ),\n T(\n \"bytes=-2 , 7-\",\n 11,\n vec![\n HttpRange {\n start: 9,\n length: 2,\n },\n HttpRange {\n start: 7,\n length: 4,\n },\n ],\n ),\n T(\n \"bytes=0-0 ,2-2, 7-\",\n 11,\n vec![\n HttpRange {\n start: 0,\n length: 1,\n },\n HttpRange {\n start: 2,\n length: 1,\n },\n HttpRange {\n start: 7,\n length: 4,\n },\n ],\n ),\n T(\n \"bytes=-5\",\n 10,\n vec![HttpRange {\n start: 5,\n length: 5,\n }],\n ),\n T(\n \"bytes=-15\",\n 10,\n vec![HttpRange {\n start: 0,\n length: 10,\n }],\n ),\n T(\n \"bytes=0-499\",\n 10000,\n vec![HttpRange {\n start: 0,\n length: 500,\n }],\n ),\n T(\n \"bytes=500-999\",\n 10000,\n vec![HttpRange {\n start: 500,\n length: 500,\n }],\n ),\n T(\n \"bytes=-500\",\n 10000,\n vec![HttpRange {\n start: 9500,\n length: 500,\n }],\n ),\n T(\n \"bytes=9500-\",\n 10000,\n vec![HttpRange {\n start: 9500,\n length: 500,\n }],\n ),\n T(\n \"bytes=0-0,-1\",\n 10000,\n vec![\n HttpRange {\n start: 0,\n length: 1,\n },\n HttpRange {\n start: 9999,\n length: 1,\n },\n ],\n ),\n T(\n \"bytes=500-600,601-999\",\n 10000,\n vec![\n HttpRange {\n start: 500,\n length: 101,\n },\n HttpRange {\n start: 601,\n length: 399,\n },\n ],\n ),\n T(\n \"bytes=500-700,601-999\",\n 10000,\n vec![\n HttpRange {\n start: 500,\n length: 201,\n },\n HttpRange {\n start: 601,\n length: 399,\n },\n ],\n ),\n // Match Apache laxity:\n T(\n \"bytes= 1 -2 , 4- 5, 7 - 8 , ,,\",\n 11,\n vec![\n HttpRange {\n start: 1,\n length: 2,\n },\n HttpRange {\n start: 4,\n length: 2,\n },\n HttpRange {\n start: 7,\n length: 2,\n },\n ],\n ),\n ];\n\n for t in tests {\n let header = t.0;\n let size = t.1;\n let expected = t.2;\n\n let res = HttpRange::parse(header, size);\n\n if let Err(err) = res {\n if expected.is_empty() {\n continue;\n } else {\n panic!(\"parse({header}, {size}) returned error {err:?}\");\n }\n }\n\n let got = res.unwrap();\n\n if got.len() != expected.len() {\n panic!(\n \"len(parseRange({}, {})) = {}, want {}\",\n header,\n size,\n got.len(),\n expected.len()\n );\n }\n\n for i in 0..expected.len() {\n if got[i].start != expected[i].start {\n panic!(\n \"parseRange({}, {})[{}].start = {}, want {}\",\n header, size, i, got[i].start, expected[i].start\n )\n }\n if got[i].length != expected[i].length {\n panic!(\n \"parseRange({}, {})[{}].length = {}, want {}\",\n header, size, i, got[i].length, expected[i].length\n )\n }\n }\n }\n }\n}\n" }, { "path": "actix-files/src/service.rs", "content": "use std::{\n fmt, io,\n ops::Deref,\n path::{Path, PathBuf},\n rc::Rc,\n};\n\nuse actix_web::{\n body::BoxBody,\n dev::{self, Service, ServiceRequest, ServiceResponse},\n error::Error,\n guard::Guard,\n http::{header, Method},\n HttpResponse,\n};\nuse futures_core::future::LocalBoxFuture;\n\nuse crate::{\n named, Directory, DirectoryRenderer, FilesError, HttpService, MimeOverride, NamedFile,\n PathBufWrap, PathFilter,\n};\n\n/// Assembled file serving service.\n#[derive(Clone)]\npub struct FilesService(pub(crate) Rc);\n\nimpl Deref for FilesService {\n type Target = FilesServiceInner;\n\n fn deref(&self) -> &Self::Target {\n &self.0\n }\n}\n\npub struct FilesServiceInner {\n pub(crate) directory: PathBuf,\n pub(crate) index: Option,\n pub(crate) show_index: bool,\n pub(crate) redirect_to_slash: bool,\n pub(crate) default: Option,\n pub(crate) renderer: Rc,\n pub(crate) mime_override: Option>,\n pub(crate) path_filter: Option>,\n pub(crate) file_flags: named::Flags,\n pub(crate) guards: Option>,\n pub(crate) hidden_files: bool,\n pub(crate) try_compressed: bool,\n pub(crate) size_threshold: u64,\n pub(crate) with_permanent_redirect: bool,\n}\n\nimpl fmt::Debug for FilesServiceInner {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"FilesServiceInner\")\n }\n}\n\nimpl FilesService {\n async fn handle_err(\n &self,\n err: io::Error,\n req: ServiceRequest,\n ) -> Result {\n log::debug!(\"error handling {}: {}\", req.path(), err);\n\n if let Some(ref default) = self.default {\n default.call(req).await\n } else {\n Ok(req.error_response(err))\n }\n }\n\n fn serve_named_file_with_encoding(\n &self,\n req: ServiceRequest,\n mut named_file: NamedFile,\n encoding: header::ContentEncoding,\n ) -> ServiceResponse {\n if let Some(ref mime_override) = self.mime_override {\n let new_disposition = mime_override(&named_file.content_type.type_());\n named_file.content_disposition.disposition = new_disposition;\n }\n named_file.flags = self.file_flags;\n\n let (req, _) = req.into_parts();\n let mut res = named_file\n .read_mode_threshold(self.size_threshold)\n .into_response(&req);\n\n let header_value = match encoding {\n header::ContentEncoding::Brotli => Some(\"br\"),\n header::ContentEncoding::Gzip => Some(\"gzip\"),\n header::ContentEncoding::Zstd => Some(\"zstd\"),\n header::ContentEncoding::Identity => None,\n // Only variants in SUPPORTED_PRECOMPRESSION_ENCODINGS can occur here\n _ => unreachable!(),\n };\n if let Some(header_value) = header_value {\n res.headers_mut().insert(\n header::CONTENT_ENCODING,\n header::HeaderValue::from_static(header_value),\n );\n // Response representation varies by Accept-Encoding when serving pre-compressed assets.\n res.headers_mut().append(\n header::VARY,\n header::HeaderValue::from_static(\"accept-encoding\"),\n );\n }\n ServiceResponse::new(req, res)\n }\n\n fn serve_named_file(&self, req: ServiceRequest, named_file: NamedFile) -> ServiceResponse {\n self.serve_named_file_with_encoding(req, named_file, header::ContentEncoding::Identity)\n }\n\n fn show_index(&self, req: ServiceRequest, path: PathBuf) -> ServiceResponse {\n let dir = Directory::new(self.directory.clone(), path);\n\n let (req, _) = req.into_parts();\n\n (self.renderer)(&dir, &req).unwrap_or_else(|err| ServiceResponse::from_err(err, req))\n }\n}\n\nimpl fmt::Debug for FilesService {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"FilesService\")\n }\n}\n\nimpl Service for FilesService {\n type Response = ServiceResponse;\n type Error = Error;\n type Future = LocalBoxFuture<'static, Result>;\n\n dev::always_ready!();\n\n fn call(&self, req: ServiceRequest) -> Self::Future {\n let is_method_valid = if let Some(guard) = &self.guards {\n // execute user defined guards\n (**guard).check(&req.guard_ctx())\n } else {\n // default behavior\n matches!(*req.method(), Method::HEAD | Method::GET)\n };\n\n let this = self.clone();\n\n Box::pin(async move {\n if !is_method_valid {\n return Ok(req.into_response(\n HttpResponse::MethodNotAllowed()\n .insert_header(header::ContentType(mime::TEXT_PLAIN_UTF_8))\n .body(\"Request did not meet this resource's requirements.\"),\n ));\n }\n\n let path_on_disk =\n match PathBufWrap::parse_path(req.match_info().unprocessed(), this.hidden_files) {\n Ok(item) => item,\n Err(err) => return Ok(req.error_response(err)),\n };\n\n if let Some(filter) = &this.path_filter {\n if !filter(path_on_disk.as_ref(), req.head()) {\n if let Some(ref default) = this.default {\n return default.call(req).await;\n } else {\n return Ok(req.into_response(HttpResponse::NotFound().finish()));\n }\n }\n }\n\n // full file path\n let path = this.directory.join(&path_on_disk);\n\n // Try serving pre-compressed file even if the uncompressed file doesn't exist yet.\n // Still handle directories (index/listing) through the normal branch below.\n if this.try_compressed && !path.is_dir() {\n if let Some((named_file, encoding)) = find_compressed(&req, &path).await {\n return Ok(this.serve_named_file_with_encoding(req, named_file, encoding));\n }\n }\n\n if let Err(err) = path.canonicalize() {\n return this.handle_err(err, req).await;\n }\n\n if path.is_dir() {\n if this.redirect_to_slash\n && !req.path().ends_with('/')\n && (this.index.is_some() || this.show_index)\n {\n let redirect_to = format!(\"{}/\", req.path());\n\n let response = if this.with_permanent_redirect {\n HttpResponse::PermanentRedirect()\n } else {\n HttpResponse::TemporaryRedirect()\n }\n .insert_header((header::LOCATION, redirect_to))\n .finish();\n\n return Ok(req.into_response(response));\n }\n\n match this.index {\n Some(ref index) => {\n let named_path = path.join(index);\n if this.try_compressed {\n if let Some((named_file, encoding)) =\n find_compressed(&req, &named_path).await\n {\n return Ok(\n this.serve_named_file_with_encoding(req, named_file, encoding)\n );\n }\n }\n // fallback to the uncompressed version\n match NamedFile::open_async(named_path).await {\n Ok(named_file) => Ok(this.serve_named_file(req, named_file)),\n Err(_) if this.show_index => Ok(this.show_index(req, path)),\n Err(err) => this.handle_err(err, req).await,\n }\n }\n None if this.show_index => Ok(this.show_index(req, path)),\n None => Ok(ServiceResponse::from_err(\n FilesError::IsDirectory,\n req.into_parts().0,\n )),\n }\n } else {\n match NamedFile::open_async(&path).await {\n Ok(named_file) => Ok(this.serve_named_file(req, named_file)),\n Err(err) => this.handle_err(err, req).await,\n }\n }\n })\n }\n}\n\n/// Flate doesn't have an accepted file extension, so it is not included here.\nconst SUPPORTED_PRECOMPRESSION_ENCODINGS: &[header::ContentEncoding] = &[\n header::ContentEncoding::Brotli,\n header::ContentEncoding::Gzip,\n header::ContentEncoding::Zstd,\n header::ContentEncoding::Identity,\n];\n\n/// Searches disk for an acceptable alternate encoding of the content at the given path, as\n/// preferred by the request's `Accept-Encoding` header. Returns the corresponding `NamedFile` with\n/// the most appropriate supported encoding, if any exist.\nasync fn find_compressed(\n req: &ServiceRequest,\n original_path: &Path,\n) -> Option<(NamedFile, header::ContentEncoding)> {\n use actix_web::HttpMessage;\n use header::{AcceptEncoding, ContentEncoding, Encoding};\n\n // Retrieve the content type and content disposition based on the original filename. If we\n // can't get these successfully, don't even try to find a compressed file.\n let (content_type, content_disposition) =\n match crate::named::get_content_type_and_disposition(original_path) {\n Ok(values) => values,\n Err(_) => return None,\n };\n\n let accept_encoding = req.get_header::()?;\n\n let mut supported = SUPPORTED_PRECOMPRESSION_ENCODINGS\n .iter()\n .copied()\n .map(Encoding::Known)\n .collect::>();\n\n // Only move the original content-type/disposition into the chosen compressed file once.\n let mut content_type = Some(content_type);\n let mut content_disposition = Some(content_disposition);\n\n loop {\n // Select next acceptable encoding (honouring q=0 rejections) from remaining supported set.\n let chosen = accept_encoding.negotiate(supported.iter())?;\n\n let encoding = match chosen {\n Encoding::Known(enc) => enc,\n // No supported encoding should ever be unknown here.\n Encoding::Unknown(_) => return None,\n };\n\n // Identity indicates there is no acceptable pre-compressed representation.\n if encoding == ContentEncoding::Identity {\n return None;\n }\n\n let extension = match encoding {\n ContentEncoding::Brotli => \".br\",\n ContentEncoding::Gzip => \".gz\",\n ContentEncoding::Zstd => \".zst\",\n ContentEncoding::Identity => unreachable!(),\n // Only variants in SUPPORTED_PRECOMPRESSION_ENCODINGS can occur here.\n _ => unreachable!(),\n };\n\n let mut compressed_path = original_path.to_owned();\n let mut filename = compressed_path.file_name()?.to_owned();\n filename.push(extension);\n compressed_path.set_file_name(filename);\n\n match NamedFile::open_async(&compressed_path).await {\n Ok(mut named_file) => {\n named_file.content_type = content_type.take().unwrap();\n named_file.content_disposition = content_disposition.take().unwrap();\n return Some((named_file, encoding));\n }\n // Ignore errors while searching disk for a suitable encoding.\n Err(_) => {\n supported.retain(|enc| enc != &chosen);\n }\n }\n }\n}\n" }, { "path": "actix-files/tests/encoding.rs", "content": "use actix_files::{Files, NamedFile};\nuse actix_web::{\n http::{\n header::{self, HeaderValue},\n StatusCode,\n },\n test::{self, TestRequest},\n web, App,\n};\n\n#[actix_web::test]\nasync fn test_utf8_file_contents() {\n // use default ISO-8859-1 encoding\n let srv = test::init_service(App::new().service(Files::new(\"/\", \"./tests\"))).await;\n\n let req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain; charset=utf-8\")),\n );\n\n // disable UTF-8 attribute\n let srv =\n test::init_service(App::new().service(Files::new(\"/\", \"./tests\").prefer_utf8(false))).await;\n\n let req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain\")),\n );\n}\n\n#[actix_web::test]\nasync fn test_compression_encodings() {\n use actix_web::body::MessageBody;\n\n let utf8_txt_len = std::fs::metadata(\"./tests/utf8.txt\").unwrap().len();\n let utf8_txt_br_len = std::fs::metadata(\"./tests/utf8.txt.br\").unwrap().len();\n let utf8_txt_gz_len = std::fs::metadata(\"./tests/utf8.txt.gz\").unwrap().len();\n\n let srv =\n test::init_service(App::new().service(Files::new(\"/\", \"./tests\").try_compressed())).await;\n\n // Select the requested encoding when present\n let mut req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n req.headers_mut().insert(\n header::ACCEPT_ENCODING,\n header::HeaderValue::from_static(\"gzip\"),\n );\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain; charset=utf-8\")),\n );\n assert_eq!(\n res.headers().get(header::CONTENT_ENCODING),\n Some(&HeaderValue::from_static(\"gzip\")),\n );\n assert_eq!(\n res.headers().get(header::VARY),\n Some(&HeaderValue::from_static(\"accept-encoding\")),\n );\n assert_eq!(\n res.into_body().size(),\n actix_web::body::BodySize::Sized(utf8_txt_gz_len),\n );\n\n // Select the highest priority encoding\n let mut req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n req.headers_mut().insert(\n header::ACCEPT_ENCODING,\n header::HeaderValue::from_static(\"gzip;q=0.6,br;q=0.8,*\"),\n );\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain; charset=utf-8\")),\n );\n assert_eq!(\n res.headers().get(header::CONTENT_ENCODING),\n Some(&HeaderValue::from_static(\"br\")),\n );\n assert_eq!(\n res.headers().get(header::VARY),\n Some(&HeaderValue::from_static(\"accept-encoding\")),\n );\n assert_eq!(\n res.into_body().size(),\n actix_web::body::BodySize::Sized(utf8_txt_br_len),\n );\n\n // Request encoding that doesn't exist on disk and fallback to no encoding\n let mut req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n req.headers_mut().insert(\n header::ACCEPT_ENCODING,\n header::HeaderValue::from_static(\"zstd\"),\n );\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain; charset=utf-8\")),\n );\n assert_eq!(res.headers().get(header::CONTENT_ENCODING), None,);\n assert_eq!(\n res.into_body().size(),\n actix_web::body::BodySize::Sized(utf8_txt_len),\n );\n\n // Do not select an encoding explicitly refused via q=0\n let mut req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n req.headers_mut().insert(\n header::ACCEPT_ENCODING,\n header::HeaderValue::from_static(\"zstd;q=1, gzip;q=0\"),\n );\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain; charset=utf-8\")),\n );\n assert_eq!(res.headers().get(header::CONTENT_ENCODING), None,);\n assert_eq!(\n res.into_body().size(),\n actix_web::body::BodySize::Sized(utf8_txt_len),\n );\n\n // Can still request a compressed file directly\n let req = TestRequest::with_uri(\"/utf8.txt.gz\").to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"application/gzip\")),\n );\n assert_eq!(res.headers().get(header::CONTENT_ENCODING), None,);\n\n // Don't try compressed files\n let srv = test::init_service(App::new().service(Files::new(\"/\", \"./tests\"))).await;\n\n let mut req = TestRequest::with_uri(\"/utf8.txt\").to_request();\n req.headers_mut().insert(\n header::ACCEPT_ENCODING,\n header::HeaderValue::from_static(\"gzip\"),\n );\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(\n res.headers().get(header::CONTENT_TYPE),\n Some(&HeaderValue::from_static(\"text/plain; charset=utf-8\")),\n );\n assert_eq!(res.headers().get(header::CONTENT_ENCODING), None);\n}\n\n#[actix_web::test]\nasync fn partial_range_response_encoding() {\n let srv = test::init_service(App::new().default_service(web::to(|| async {\n NamedFile::open_async(\"./tests/test.binary\").await.unwrap()\n })))\n .await;\n\n // range request without accept-encoding returns no content-encoding header\n let req = TestRequest::with_uri(\"/\")\n .append_header((header::RANGE, \"bytes=10-20\"))\n .to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::PARTIAL_CONTENT);\n assert!(!res.headers().contains_key(header::CONTENT_ENCODING));\n\n // range request with accept-encoding still returns no content-encoding header\n let req = TestRequest::with_uri(\"/\")\n .append_header((header::RANGE, \"bytes=10-20\"))\n .append_header((header::ACCEPT_ENCODING, \"gzip\"))\n .to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::PARTIAL_CONTENT);\n assert!(!res.headers().contains_key(header::CONTENT_ENCODING));\n}\n" }, { "path": "actix-files/tests/fixtures/guards/first/index.txt", "content": "first" }, { "path": "actix-files/tests/fixtures/guards/second/index.txt", "content": "second" }, { "path": "actix-files/tests/guard.rs", "content": "use actix_files::Files;\nuse actix_web::{\n guard::Host,\n http::StatusCode,\n test::{self, TestRequest},\n App,\n};\nuse bytes::Bytes;\n\n#[actix_web::test]\nasync fn test_guard_filter() {\n let srv = test::init_service(\n App::new()\n .service(Files::new(\"/\", \"./tests/fixtures/guards/first\").guard(Host(\"first.com\")))\n .service(Files::new(\"/\", \"./tests/fixtures/guards/second\").guard(Host(\"second.com\"))),\n )\n .await;\n\n let req = TestRequest::with_uri(\"/index.txt\")\n .append_header((\"Host\", \"first.com\"))\n .to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(test::read_body(res).await, Bytes::from(\"first\"));\n\n let req = TestRequest::with_uri(\"/index.txt\")\n .append_header((\"Host\", \"second.com\"))\n .to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n assert_eq!(test::read_body(res).await, Bytes::from(\"second\"));\n}\n" }, { "path": "actix-files/tests/pre_epoch_mtime.rs", "content": "use std::time::UNIX_EPOCH;\n\nuse actix_files::NamedFile;\nuse actix_web::{\n http::{header, StatusCode},\n test, web, App,\n};\nuse filetime::{set_file_mtime, FileTime};\nuse tempfile::tempdir;\n\n#[actix_web::test]\nasync fn serves_file_with_pre_epoch_mtime() {\n let dir = tempdir().unwrap();\n let path = dir.path().join(\"pre_epoch.txt\");\n\n std::fs::write(&path, b\"hello\").unwrap();\n\n // set mtime to before UNIX epoch; this used to panic during ETag/Last-Modified generation\n set_file_mtime(&path, FileTime::from_unix_time(-60, 0)).unwrap();\n\n let mtime = std::fs::metadata(&path).unwrap().modified().unwrap();\n assert!(\n mtime < UNIX_EPOCH,\n \"fixture mtime should be before UNIX_EPOCH\"\n );\n\n let srv = {\n let path = path.clone();\n test::init_service(App::new().default_service(web::to(move || {\n let path = path.clone();\n async move { NamedFile::open_async(path).await.unwrap() }\n })))\n .await\n };\n\n let req = test::TestRequest::with_uri(\"/\").to_request();\n let res = test::call_service(&srv, req).await;\n\n assert_eq!(res.status(), StatusCode::OK);\n\n // ETag is still generated even for pre-epoch times.\n assert!(res.headers().contains_key(header::ETAG));\n\n // HTTP-date formatting in the httpdate crate does not support pre-epoch times.\n assert!(!res.headers().contains_key(header::LAST_MODIFIED));\n\n let body = test::read_body(res).await;\n assert_eq!(&body[..], b\"hello\");\n}\n" }, { "path": "actix-files/tests/test space.binary", "content": "TǑɂV2vI\\R˙e\u0004vD:藽R\u0010V\u0003Yp\u001f;\u0007Gp!2C.\fpA\u000b\u0010!ߦx\tj+UcX\u0013c%\u0017;\"y\u0010AI" }, { "path": "actix-files/tests/test.binary", "content": "TǑɂV2vI\\R˙e\u0004vD:藽R\u0010V\u0003Yp\u001f;\u0007Gp!2C.\fpA\u000b\u0010!ߦx\tj+UcX\u0013c%\u0017;\"y\u0010AI" }, { "path": "actix-files/tests/test.js", "content": "// this file is empty.\n" }, { "path": "actix-files/tests/traversal.rs", "content": "use actix_files::Files;\nuse actix_web::{\n http::StatusCode,\n test::{self, TestRequest},\n App,\n};\n\n#[actix_rt::test]\nasync fn test_directory_traversal_prevention() {\n let srv = test::init_service(App::new().service(Files::new(\"/\", \"./tests\"))).await;\n\n let req = TestRequest::with_uri(\"/../../../../../../../../../../../etc/passwd\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n\n let req = TestRequest::with_uri(\n \"/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/etc/passwd\",\n )\n .to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n\n let req = TestRequest::with_uri(\"/%00/etc/passwd%00\").to_request();\n let res = test::call_service(&srv, req).await;\n assert_eq!(res.status(), StatusCode::NOT_FOUND);\n}\n" }, { "path": "actix-files/tests/utf8.txt", "content": "中文内容显示正确。\n\nEnglish is OK.\n" }, { "path": "actix-http/CHANGES.md", "content": "# Changes\n\n## Unreleased\n\n- Encode the HTTP/1 `Connection: Upgrade` header in Camel-Case when camel-case header formatting is enabled.[#3953]\n- Fix `HeaderMap` iterators' `len()` and `size_hint()` implementations for multi-value headers.\n\n[#3953]: https://github.com/actix/actix-web/pull/3953\n\n## 3.12.0\n\n- Minimum supported Rust version (MSRV) is now 1.88.\n- Increase default HTTP/2 flow control window sizes. [#3638]\n- Expose configuration methods to improve upload throughput. [#3638]\n- Fix truncated body ending without error when connection closed abnormally. [#3067]\n- Add config/method for `TCP_NODELAY`. [#3918]\n- Do not compress 206 Partial Content responses. [#3191]\n- Fix lingering sockets and client stalls when responding early to dropped chunked request payloads. [#2972]\n\n[#3638]: https://github.com/actix/actix-web/issues/3638\n[#3067]: https://github.com/actix/actix-web/pull/3067\n[#3918]: https://github.com/actix/actix-web/pull/3918\n[#3191]: https://github.com/actix/actix-web/issues/3191\n[#2972]: https://github.com/actix/actix-web/issues/2972\n\n## 3.11.2\n\n- Properly wake Payload receivers when feeding errors or EOF.\n- Add `ServiceConfigBuilder` type to facilitate future configuration extensions.\n- Add a configuration option to allow/disallow half closed connections in HTTP/1. This defaults to allow, reverting the change made in 3.11.1.\n- Shutdown connections when HTTP Responses are written without reading full Requests.\n\n## 3.11.1\n\n- Prevent more hangs after client disconnects.\n- More malformed WebSocket frames are now gracefully rejected.\n- Using `TestRequest::set_payload()` now sets a Content-Length header.\n\n## 3.11.0\n\n- Update `brotli` dependency to `8`.\n\n## 3.10.0\n\n### Added\n\n- Add `header::CLEAR_SITE_DATA` constant.\n- Add `Extensions::get_or_insert[_with]()` methods.\n- Implement `From` for `Payload`.\n- Implement `From>` for `Payload`.\n\n### Changed\n\n- Update `brotli` dependency to `7`.\n- Minimum supported Rust version (MSRV) is now 1.75.\n\n## 3.9.0\n\n### Added\n\n- Implement `FromIterator<(HeaderName, HeaderValue)>` for `HeaderMap`.\n\n## 3.8.0\n\n### Added\n\n- Add `error::InvalidStatusCode` re-export.\n\n## 3.7.0\n\n### Added\n\n- Add `rustls-0_23` crate feature\n- Add `{h1::H1Service, h2::H2Service, HttpService}::rustls_0_23()` and `HttpService::rustls_0_23_with_config()` service constructors.\n\n### Changed\n\n- Update `brotli` dependency to `6`.\n- Minimum supported Rust version (MSRV) is now 1.72.\n\n## 3.6.0\n\n### Added\n\n- Add `rustls-0_22` crate feature.\n- Add `{h1::H1Service, h2::H2Service, HttpService}::rustls_0_22()` and `HttpService::rustls_0_22_with_config()` service constructors.\n- Implement `From<&HeaderMap>` for `http::HeaderMap`.\n\n## 3.5.1\n\n### Fixed\n\n- Prevent hang when returning zero-sized response bodies through compression layer.\n\n## 3.5.0\n\n### Added\n\n- Implement `From` for `http::HeaderMap`.\n\n### Changed\n\n- Updated `zstd` dependency to `0.13`.\n\n### Fixed\n\n- Prevent compression of zero-sized response bodies.\n\n## 3.4.0\n\n### Added\n\n- Add `rustls-0_20` crate feature.\n- Add `{h1::H1Service, h2::H2Service, HttpService}::rustls_021()` and `HttpService::rustls_021_with_config()` service constructors.\n- Add `body::to_bytes_limited()` function.\n- Add `body::BodyLimitExceeded` error type.\n\n### Changed\n\n- Minimum supported Rust version (MSRV) is now 1.68 due to transitive `time` dependency.\n\n## 3.3.1\n\n### Fixed\n\n- Use correct `http` version requirement to ensure support for const `HeaderName` definitions.\n\n## 3.3.0\n\n### Added\n\n- Implement `MessageBody` for `Cow<'static, str>` and `Cow<'static, [u8]>`. [#2959]\n- Implement `MessageBody` for `&mut B` where `B: MessageBody + Unpin`. [#2868]\n- Implement `MessageBody` for `Pin` where `B::Target: MessageBody`. [#2868]\n- Automatic h2c detection via new service finalizer `HttpService::tcp_auto_h2c()`. [#2957]\n- `HeaderMap::retain()`. [#2955]\n- Header name constants in `header` module. [#2956] [#2968]\n - `CACHE_STATUS`\n - `CDN_CACHE_CONTROL`\n - `CROSS_ORIGIN_EMBEDDER_POLICY`\n - `CROSS_ORIGIN_OPENER_POLICY`\n - `PERMISSIONS_POLICY`\n - `X_FORWARDED_FOR`\n - `X_FORWARDED_HOST`\n - `X_FORWARDED_PROTO`\n\n### Fixed\n\n- Fix non-empty body of HTTP/2 HEAD responses. [#2920]\n\n### Performance\n\n- Improve overall performance of operations on `Extensions`. [#2890]\n\n[#2959]: https://github.com/actix/actix-web/pull/2959\n[#2868]: https://github.com/actix/actix-web/pull/2868\n[#2890]: https://github.com/actix/actix-web/pull/2890\n[#2920]: https://github.com/actix/actix-web/pull/2920\n[#2957]: https://github.com/actix/actix-web/pull/2957\n[#2955]: https://github.com/actix/actix-web/pull/2955\n[#2956]: https://github.com/actix/actix-web/pull/2956\n[#2968]: https://github.com/actix/actix-web/pull/2968\n\n## 3.2.2\n\n### Changed\n\n- Minimum supported Rust version (MSRV) is now 1.59 due to transitive `time` dependency.\n\n### Fixed\n\n- Avoid possibility of dispatcher getting stuck while back-pressuring I/O. [#2369]\n\n[#2369]: https://github.com/actix/actix-web/pull/2369\n\n## 3.2.1\n\n### Fixed\n\n- Fix parsing ambiguity in Transfer-Encoding and Content-Length headers for HTTP/1.0 requests. [#2794]\n\n[#2794]: https://github.com/actix/actix-web/pull/2794\n\n## 3.2.0\n\n### Changed\n\n- Minimum supported Rust version (MSRV) is now 1.57 due to transitive `time` dependency.\n\n### Fixed\n\n- Websocket parser no longer throws endless overflow errors after receiving an oversized frame. [#2790]\n- Retain previously set Vary headers when using compression encoder. [#2798]\n\n[#2790]: https://github.com/actix/actix-web/pull/2790\n[#2798]: https://github.com/actix/actix-web/pull/2798\n\n## 3.1.0\n\n### Changed\n\n- Minimum supported Rust version (MSRV) is now 1.56 due to transitive `hashbrown` dependency.\n\n### Fixed\n\n- Revert broken fix in [#2624] that caused erroneous 500 error responses. Temporarily re-introduces [#2357] bug. [#2779]\n\n[#2624]: https://github.com/actix/actix-web/pull/2624\n[#2357]: https://github.com/actix/actix-web/issues/2357\n[#2779]: https://github.com/actix/actix-web/pull/2779\n\n## 3.0.4\n\n### Fixed\n\n- Document on docs.rs with `ws` feature enabled.\n\n## 3.0.3\n\n### Fixed\n\n- Allow spaces between header name and colon when parsing responses. [#2684]\n\n[#2684]: https://github.com/actix/actix-web/pull/2684\n\n## 3.0.2\n\n### Fixed\n\n- Fix encoding camel-case header names with more than one hyphen. [#2683]\n\n[#2683]: https://github.com/actix/actix-web/pull/2683\n\n## 3.0.1\n\n- Fix panic in H1 dispatcher when pipelining is used with keep-alive. [#2678]\n\n[#2678]: https://github.com/actix/actix-web/issues/2678\n\n## 3.0.0\n\n### Dependencies\n\n- Updated `actix-*` to Tokio v1-based versions. [#1813]\n- Updated `bytes` to `1.0`. [#1813]\n- Updated `h2` to `0.3`. [#1813]\n- Updated `rustls` to `0.20.0`. [#2414]\n- Updated `language-tags` to `0.3`.\n- Updated `tokio` to `1`.\n\n### Added\n\n- Crate Features:\n - `ws`; disabled by default. [#2618]\n - `http2`; disabled by default. [#2618]\n - `compress-brotli`; disabled by default. [#2618]\n - `compress-gzip`; disabled by default. [#2618]\n - `compress-zstd`; disabled by default. [#2618]\n- Functions:\n - `body::to_bytes` for async collecting message body into Bytes. [#2158]\n- Traits:\n - `TryIntoHeaderPair`; allows using typed and untyped headers in the same methods. [#1869]\n- Types:\n - `body::BoxBody`; a boxed message body with boxed errors. [#2183]\n - `body::EitherBody` enum. [#2468]\n - `body::None` struct. [#2468]\n - Re-export `http` crate's `Error` type as `error::HttpError`. [#2171]\n- Variants:\n - `ContentEncoding::Zstd` along with . [#2244]\n - `Protocol::Http3` for future compatibility and also mark `#[non_exhaustive]`. [00ba8d55]\n- Methods:\n - `ContentEncoding::to_header_value()`. [#2501]\n - `header::QualityItem::{max, min}()`. [#2486]\n - `header::QualityItem::zero()` that uses `Quality::ZERO`. [#2501]\n - `HeaderMap::drain()` as an efficient draining iterator. [#1964]\n - `HeaderMap::len_keys()` has the behavior of the old `len` method. [#1964]\n - `MessageBody::boxed` trait method for wrapping boxing types efficiently. [#2520]\n - `MessageBody::try_into_bytes` trait method, with default implementation, for optimizations on body types that complete in exactly one poll. [#2522]\n - `Request::conn_data()`. [#2491]\n - `Request::take_conn_data()`. [#2491]\n - `Request::take_req_data()`. [#2487]\n - `Response::{ok, bad_request, not_found, internal_server_error}()`. [#2159]\n - `Response::into_body()` that consumes response and returns body type. [#2201]\n - `Response::map_into_boxed_body()`. [#2468]\n - `ResponseBuilder::append_header()` method which allows using typed and untyped headers. [#1869]\n - `ResponseBuilder::insert_header()` method which allows using typed and untyped headers. [#1869]\n - `ResponseHead::set_camel_case_headers()`. [#2587]\n - `TestRequest::insert_header()` method which allows using typed and untyped headers. [#1869]\n- Implementations:\n - Implement `Clone for ws::HandshakeError`. [#2468]\n - Implement `Clone` for `body::AnyBody where S: Clone`. [#2448]\n - Implement `Clone` for `RequestHead`. [#2487]\n - Implement `Clone` for `ResponseHead`. [#2585]\n - Implement `Copy` for `QualityItem where T: Copy`. [#2501]\n - Implement `Default` for `ContentEncoding`. [#1912]\n - Implement `Default` for `HttpServiceBuilder`. [#2611]\n - Implement `Default` for `KeepAlive`. [#2611]\n - Implement `Default` for `Response`. [#2201]\n - Implement `Default` for `ws::Codec`. [#1920]\n - Implement `Display` for `header::Quality`. [#2486]\n - Implement `Eq` for `header::ContentEncoding`. [#2501]\n - Implement `ExactSizeIterator` and `FusedIterator` for all `HeaderMap` iterators. [#2470]\n - Implement `From` for `KeepAlive`. [#2611]\n - Implement `From>` for `KeepAlive`. [#2611]\n - Implement `From>` for `Response>`. [#2625]\n - Implement `FromStr` for `ContentEncoding`. [#1912]\n - Implement `Header` for `ContentEncoding`. [#1912]\n - Implement `IntoHeaderValue` for `ContentEncoding`. [#1912]\n - Implement `IntoIterator` for `HeaderMap`. [#1964]\n - Implement `MessageBody` for `bytestring::ByteString`. [#2468]\n - Implement `MessageBody` for `Pin> where T: MessageBody`. [#2152]\n- Misc:\n - Re-export `StatusCode`, `Method`, `Version` and `Uri` at the crate root. [#2171]\n - Re-export `ContentEncoding` and `ConnectionType` at the crate root. [#2171]\n - `Quality::ZERO` associated constant equivalent to `q=0`. [#2501]\n - `header::Quality::{MAX, MIN}` associated constants equivalent to `q=1` and `q=0.001`, respectively. [#2486]\n - Timeout for canceling HTTP/2 server side connection handshake. Configurable with `ServiceConfig::client_timeout`; defaults to 5 seconds. [#2483]\n - `#[must_use]` for `ws::Codec` to prevent subtle bugs. [#1920]\n\n### Changed\n\n- Traits:\n - Rename `IntoHeaderValue => TryIntoHeaderValue`. [#2510]\n - `MessageBody` now has an associated `Error` type. [#2183]\n- Types:\n - `Protocol` enum is now marked `#[non_exhaustive]`.\n - `error::DispatcherError` enum is now marked `#[non_exhaustive]`. [#2624]\n - `ContentEncoding` is now marked `#[non_exhaustive]`. [#2377]\n - Error enums are marked `#[non_exhaustive]`. [#2161]\n - Rename `PayloadStream` to `BoxedPayloadStream`. [#2545]\n - The body type parameter of `Response` no longer has a default. [#2152]\n- Enum Variants:\n - Rename `ContentEncoding::{Br => Brotli}`. [#2501]\n - `Payload` inner fields are now named. [#2545]\n - `ws::Message::Text` now contains a `bytestring::ByteString`. [#1864]\n- Methods:\n - Rename `ServiceConfig::{client_timer_expire => client_request_deadline}`. [#2611]\n - Rename `ServiceConfig::{client_disconnect_timer => client_disconnect_deadline}`. [#2611]\n - Rename `h1::Codec::{keepalive => keep_alive}`. [#2611]\n - Rename `h1::Codec::{keepalive_enabled => keep_alive_enabled}`. [#2611]\n - Rename `h1::ClientCodec::{keepalive => keep_alive}`. [#2611]\n - Rename `h1::ClientPayloadCodec::{keepalive => keep_alive}`. [#2611]\n - Rename `header::EntityTag::{weak => new_weak, strong => new_strong}`. [#2565]\n - Rename `TryIntoHeaderValue::{try_into => try_into_value}` to avoid ambiguity with std `TryInto` trait. [#1894]\n - Deadline methods in `ServiceConfig` now return `std::time::Instant`s instead of Tokio's wrapper type. [#2611]\n - Places in `Response` where `ResponseBody` was received or returned now simply use `B`. [#2201]\n - `encoding::Encoder::response` now returns `AnyBody>`. [#2448]\n - `Extensions::insert` returns replaced item. [#1904]\n - `HeaderMap::get_all` now returns a `std::slice::Iter`. [#2527]\n - `HeaderMap::insert` now returns iterator of removed values. [#1964]\n - `HeaderMap::len` now returns number of values instead of number of keys. [#1964]\n - `HeaderMap::remove` now returns iterator of removed values. [#1964]\n - `ResponseBuilder::body(B)` now returns `Response>`. [#2468]\n - `ResponseBuilder::content_type` now takes an `impl TryIntoHeaderValue` to support using typed `mime` types. [#1894]\n - `ResponseBuilder::finish()` now returns `Response>`. [#2468]\n - `ResponseBuilder::json` now takes `impl Serialize`. [#2052]\n - `ResponseBuilder::message_body` now returns a `Result`. [#2201]∑\n - `ServiceConfig::keep_alive` now returns a `KeepAlive`. [#2611]\n - `ws::hash_key` now returns array. [#2035]\n- Trait Implementations:\n - Implementation of `Stream` for `Payload` no longer requires the `Stream` variant be `Unpin`. [#2545]\n - Implementation of `Future` for `h1::SendResponse` no longer requires the body type be `Unpin`. [#2545]\n - Implementation of `Stream` for `encoding::Decoder` no longer requires the stream type be `Unpin`. [#2545]\n - Implementation of `From` for error types now return a `Response`. [#2468]\n- Misc:\n - `header` module is now public. [#2171]\n - `uri` module is now public. [#2171]\n - Request-local data container is no longer part of a `RequestHead`. Instead it is a distinct part of a `Request`. [#2487]\n - All error trait bounds in server service builders have changed from `Into` to `Into>`. [#2253]\n - All error trait bounds in message body and stream impls changed from `Into` to `Into>`. [#2253]\n - Guarantee ordering of `header::GetAll` iterator to be same as insertion order. [#2467]\n - Connection data set through the `on_connect_ext` callbacks is now accessible only from the new `Request::conn_data()` method. [#2491]\n - Brotli (de)compression support is now provided by the `brotli` crate. [#2538]\n - Minimum supported Rust version (MSRV) is now 1.54.\n\n### Fixed\n\n- A `Vary` header is now correctly sent along with compressed content. [#2501]\n- HTTP/1.1 dispatcher correctly uses client request timeout. [#2611]\n- Fixed issue where handlers that took payload but then dropped without reading it to EOF it would cause keep-alive connections to become stuck. [#2624]\n- `ContentEncoding`'s `Identity` variant can now be parsed from a string. [#2501]\n- `HttpServer::{listen_rustls(), bind_rustls()}` now honor the ALPN protocols in the configuration parameter. [#2226]\n- Remove unnecessary `Into` bound on `Encoder` body types. [#2375]\n- Remove unnecessary `Unpin` bound on `ResponseBuilder::streaming`. [#2253]\n- `BodyStream` and `SizedStream` are no longer restricted to `Unpin` types. [#2152]\n- Fixed slice creation pointing to potential uninitialized data on h1 encoder. [#2364]\n- Fixed quality parse error in Accept-Encoding header. [#2344]\n\n### Removed\n\n- Crate Features:\n - `compress` feature. [#2065]\n - `cookies` feature. [#2065]\n - `trust-dns` feature. [#2425]\n - `actors` optional feature and trait implementation for `actix` types. [#1969]\n- Functions:\n - `header::qitem` helper. Replaced with `header::QualityItem::max`. [#2486]\n- Types:\n - `body::Body`; replaced with `EitherBody` and `BoxBody`. [#2468]\n - `body::ResponseBody`. [#2446]\n - `ConnectError::SslHandshakeError` and re-export of `HandshakeError`. Due to the removal of this type from `tokio-openssl` crate. OpenSSL handshake error now returns `ConnectError::SslError`. [#1813]\n - `error::Canceled` re-export. [#1994]\n - `error::Result` type alias. [#2201]\n - `error::BlockingError` [#2660]\n - `InternalError` and all the error types it constructed were moved up to `actix-web`. [#2215]\n - Typed HTTP headers; they have moved up to `actix-web`. [2094]\n - Re-export of `http` crate's `HeaderMap` types in addition to ours. [#2171]\n- Enum Variants:\n - `body::BodySize::Empty`; an empty body can now only be represented as a `Sized(0)` variant. [#2446]\n - `ContentEncoding::Auto`. [#2501]\n - `EncoderError::Boxed`. [#2446]\n- Methods:\n - `ContentEncoding::is_compression()`. [#2501]\n - `h1::Payload::readany()`. [#2545]\n - `HttpMessage::cookie[s]()` trait methods. [#2065]\n - `HttpServiceBuilder::new()`; use `default` instead. [#2611]\n - `on_connect` (previously deprecated) methods have been removed; use `on_connect_ext`. [#1857]\n - `Response::build_from()`. [#2159]\n - `Response::error()` [#2205]\n - `Response::take_body()` and old `Response::into_body()` method that casted body type. [#2201]\n - `Response`'s status code builders. [#2159]\n - `ResponseBuilder::{if_true, if_some}()` (previously deprecated). [#2148]\n - `ResponseBuilder::{set, set_header}()`; use `ResponseBuilder::insert_header()`. [#1869]\n - `ResponseBuilder::extensions[_mut]()`. [#2585]\n - `ResponseBuilder::header()`; use `ResponseBuilder::append_header()`. [#1869]\n - `ResponseBuilder::json()`. [#2148]\n - `ResponseBuilder::json2()`. [#1903]\n - `ResponseBuilder::streaming()`. [#2468]\n - `ResponseHead::extensions[_mut]()`. [#2585]\n - `ServiceConfig::{client_timer, keep_alive_timer}()`. [#2611]\n - `TestRequest::with_hdr()`; use `TestRequest::default().insert_header()`. [#1869]\n - `TestRequest::with_header()`; use `TestRequest::default().insert_header()`. [#1869]\n- Trait implementations:\n - Implementation of `Copy` for `ws::Codec`. [#1920]\n - Implementation of `From> for KeepAlive`; use `Duration`s instead. [#2611]\n - Implementation of `From` for `Body`. [#2148]\n - Implementation of `From for KeepAlive`; use `Duration`s instead. [#2611]\n - Implementation of `Future` for `Response`. [#2201]\n - Implementation of `Future` for `ResponseBuilder`. [#2468]\n - Implementation of `Into` for `Response`. [#2215]\n - Implementation of `Into` for `ResponseBuilder`. [#2215]\n - Implementation of `ResponseError` for `actix_utils::timeout::TimeoutError`. [#2127]\n - Implementation of `ResponseError` for `CookieParseError`. [#2065]\n - Implementation of `TryFrom` for `header::Quality`. [#2486]\n- Misc:\n - `http` module; most everything it contained is exported at the crate root. [#2488]\n - `cookies` module (re-export). [#2065]\n - `client` module. Connector types now live in `awc`. [#2425]\n - `error` field from `Response`. [#2205]\n - `downcast` and `downcast_get_type_id` macros. [#2291]\n - Down-casting for `MessageBody` types; use standard `Any` trait. [#2183]\n\n[#1813]: https://github.com/actix/actix-web/pull/1813\n[#1845]: https://github.com/actix/actix-web/pull/1845\n[#1857]: https://github.com/actix/actix-web/pull/1857\n[#1864]: https://github.com/actix/actix-web/pull/1864\n[#1869]: https://github.com/actix/actix-web/pull/1869\n[#1878]: https://github.com/actix/actix-web/pull/1878\n[#1894]: https://github.com/actix/actix-web/pull/1894\n[#1903]: https://github.com/actix/actix-web/pull/1903\n[#1904]: https://github.com/actix/actix-web/pull/1904\n[#1912]: https://github.com/actix/actix-web/pull/1912\n[#1920]: https://github.com/actix/actix-web/pull/1920\n[#1964]: https://github.com/actix/actix-web/pull/1964\n[#1969]: https://github.com/actix/actix-web/pull/1969\n[#1981]: https://github.com/actix/actix-web/pull/1981\n[#1994]: https://github.com/actix/actix-web/pull/1994\n[#2035]: https://github.com/actix/actix-web/pull/2035\n[#2052]: https://github.com/actix/actix-web/pull/2052\n[#2065]: https://github.com/actix/actix-web/pull/2065\n[#2094]: https://github.com/actix/actix-web/pull/2094\n[#2127]: https://github.com/actix/actix-web/pull/2127\n[#2148]: https://github.com/actix/actix-web/pull/2148\n[#2152]: https://github.com/actix/actix-web/pull/2152\n[#2158]: https://github.com/actix/actix-web/pull/2158\n[#2159]: https://github.com/actix/actix-web/pull/2159\n[#2161]: https://github.com/actix/actix-web/pull/2161\n[#2171]: https://github.com/actix/actix-web/pull/2171\n[#2183]: https://github.com/actix/actix-web/pull/2183\n[#2196]: https://github.com/actix/actix-web/pull/2196\n[#2201]: https://github.com/actix/actix-web/pull/2201\n[#2205]: https://github.com/actix/actix-web/pull/2205\n[#2215]: https://github.com/actix/actix-web/pull/2215\n[#2244]: https://github.com/actix/actix-web/pull/2244\n[#2250]: https://github.com/actix/actix-web/pull/2250\n[#2253]: https://github.com/actix/actix-web/pull/2253\n[#2291]: https://github.com/actix/actix-web/pull/2291\n[#2344]: https://github.com/actix/actix-web/pull/2344\n[#2364]: https://github.com/actix/actix-web/pull/2364\n[#2375]: https://github.com/actix/actix-web/pull/2375\n[#2377]: https://github.com/actix/actix-web/pull/2377\n[#2414]: https://github.com/actix/actix-web/pull/2414\n[#2425]: https://github.com/actix/actix-web/pull/2425\n[#2442]: https://github.com/actix/actix-web/pull/2442\n[#2446]: https://github.com/actix/actix-web/pull/2446\n[#2448]: https://github.com/actix/actix-web/pull/2448\n[#2456]: https://github.com/actix/actix-web/pull/2456\n[#2467]: https://github.com/actix/actix-web/pull/2467\n[#2468]: https://github.com/actix/actix-web/pull/2468\n[#2470]: https://github.com/actix/actix-web/pull/2470\n[#2474]: https://github.com/actix/actix-web/pull/2474\n[#2483]: https://github.com/actix/actix-web/pull/2483\n[#2486]: https://github.com/actix/actix-web/pull/2486\n[#2487]: https://github.com/actix/actix-web/pull/2487\n[#2488]: https://github.com/actix/actix-web/pull/2488\n[#2491]: https://github.com/actix/actix-web/pull/2491\n[#2497]: https://github.com/actix/actix-web/pull/2497\n[#2501]: https://github.com/actix/actix-web/pull/2501\n[#2510]: https://github.com/actix/actix-web/pull/2510\n[#2520]: https://github.com/actix/actix-web/pull/2520\n[#2522]: https://github.com/actix/actix-web/pull/2522\n[#2527]: https://github.com/actix/actix-web/pull/2527\n[#2538]: https://github.com/actix/actix-web/pull/2538\n[#2545]: https://github.com/actix/actix-web/pull/2545\n[#2565]: https://github.com/actix/actix-web/pull/2565\n[#2585]: https://github.com/actix/actix-web/pull/2585\n[#2587]: https://github.com/actix/actix-web/pull/2587\n[#2611]: https://github.com/actix/actix-web/pull/2611\n[#2618]: https://github.com/actix/actix-web/pull/2618\n[#2624]: https://github.com/actix/actix-web/pull/2624\n[#2625]: https://github.com/actix/actix-web/pull/2625\n[#2660]: https://github.com/actix/actix-web/pull/2660\n[00ba8d55]: https://github.com/actix/actix-web/commit/00ba8d55492284581695d824648590715a8bd386\n\n
    \n3.0.0 Pre-Releases\n\n## 3.0.0-rc.4\n\n### Fixed\n\n- Fix h1 dispatcher panic. [1ce58ecb]\n\n[1ce58ecb]: https://github.com/actix/actix-web/commit/1ce58ecb305c60e51db06e6c913b7a1344e229ca\n\n## 3.0.0-rc.3\n\n- No significant changes since `3.0.0-rc.2`.\n\n## 3.0.0-rc.2\n\n### Added\n\n- Implement `From>` for `Response>`. [#2625]\n\n### Changed\n\n- `error::DispatcherError` enum is now marked `#[non_exhaustive]`. [#2624]\n\n### Fixed\n\n- Issue where handlers that took payload but then dropped without reading it to EOF it would cause keep-alive connections to become stuck. [#2624]\n\n[#2624]: https://github.com/actix/actix-web/pull/2624\n[#2625]: https://github.com/actix/actix-web/pull/2625\n\n## 3.0.0-rc.1\n\n### Added\n\n- Implement `Default` for `KeepAlive`. [#2611]\n- Implement `From` for `KeepAlive`. [#2611]\n- Implement `From>` for `KeepAlive`. [#2611]\n- Implement `Default` for `HttpServiceBuilder`. [#2611]\n- Crate `ws` feature flag, disabled by default. [#2618]\n- Crate `http2` feature flag, disabled by default. [#2618]\n\n### Changed\n\n- Rename `ServiceConfig::{client_timer_expire => client_request_deadline}`. [#2611]\n- Rename `ServiceConfig::{client_disconnect_timer => client_disconnect_deadline}`. [#2611]\n- Deadline methods in `ServiceConfig` now return `std::time::Instant`s instead of Tokio's wrapper type. [#2611]\n- Rename `h1::Codec::{keepalive => keep_alive}`. [#2611]\n- Rename `h1::Codec::{keepalive_enabled => keep_alive_enabled}`. [#2611]\n- Rename `h1::ClientCodec::{keepalive => keep_alive}`. [#2611]\n- Rename `h1::ClientPayloadCodec::{keepalive => keep_alive}`. [#2611]\n- `ServiceConfig::keep_alive` now returns a `KeepAlive`. [#2611]\n\n### Fixed\n\n- HTTP/1.1 dispatcher correctly uses client request timeout. [#2611]\n\n### Removed\n\n- `ServiceConfig::{client_timer, keep_alive_timer}`. [#2611]\n- `impl From for KeepAlive`; use `Duration`s instead. [#2611]\n- `impl From> for KeepAlive`; use `Duration`s instead. [#2611]\n- `HttpServiceBuilder::new`; use `default` instead. [#2611]\n\n[#2611]: https://github.com/actix/actix-web/pull/2611\n[#2618]: https://github.com/actix/actix-web/pull/2618\n\n## 3.0.0-beta.19\n\n### Added\n\n- Response headers can be sent as camel case using `res.head_mut().set_camel_case_headers(true)`. [#2587]\n- `ResponseHead` now implements `Clone`. [#2585]\n\n### Changed\n\n- Brotli (de)compression support is now provided by the `brotli` crate. [#2538]\n\n### Removed\n\n- `ResponseHead::extensions[_mut]()`. [#2585]\n- `ResponseBuilder::extensions[_mut]()`. [#2585]\n\n[#2538]: https://github.com/actix/actix-web/pull/2538\n[#2585]: https://github.com/actix/actix-web/pull/2585\n[#2587]: https://github.com/actix/actix-web/pull/2587\n\n## 3.0.0-beta.18\n\n### Added\n\n- `impl Eq` for `header::ContentEncoding`. [#2501]\n- `impl Copy` for `QualityItem` where `T: Copy`. [#2501]\n- `Quality::ZERO` equivalent to `q=0`. [#2501]\n- `QualityItem::zero` that uses `Quality::ZERO`. [#2501]\n- `ContentEncoding::to_header_value()`. [#2501]\n\n### Changed\n\n- `Quality::MIN` is now the smallest non-zero value. [#2501]\n- `QualityItem::min` semantics changed with `QualityItem::MIN`. [#2501]\n- Rename `ContentEncoding::{Br => Brotli}`. [#2501]\n- Rename `header::EntityTag::{weak => new_weak, strong => new_strong}`. [#2565]\n- Minimum supported Rust version (MSRV) is now 1.54.\n\n### Fixed\n\n- `ContentEncoding::Identity` can now be parsed from a string. [#2501]\n- A `Vary` header is now correctly sent along with compressed content. [#2501]\n\n### Removed\n\n- `ContentEncoding::Auto` variant. [#2501]\n- `ContentEncoding::is_compression()`. [#2501]\n\n[#2501]: https://github.com/actix/actix-web/pull/2501\n[#2565]: https://github.com/actix/actix-web/pull/2565\n\n## 3.0.0-beta.17\n\n### Changed\n\n- `HeaderMap::get_all` now returns a `std::slice::Iter`. [#2527]\n- `Payload` inner fields are now named. [#2545]\n- `impl Stream` for `Payload` no longer requires the `Stream` variant be `Unpin`. [#2545]\n- `impl Future` for `h1::SendResponse` no longer requires the body type be `Unpin`. [#2545]\n- `impl Stream` for `encoding::Decoder` no longer requires the stream type be `Unpin`. [#2545]\n- Rename `PayloadStream` to `BoxedPayloadStream`. [#2545]\n\n### Removed\n\n- `h1::Payload::readany`. [#2545]\n\n[#2527]: https://github.com/actix/actix-web/pull/2527\n[#2545]: https://github.com/actix/actix-web/pull/2545\n\n## 3.0.0-beta.16\n\n### Added\n\n- New method on `MessageBody` trait, `try_into_bytes`, with default implementation, for optimizations on body types that complete in exactly one poll. Replaces `is_complete_body` and `take_complete_body`. [#2522]\n\n### Changed\n\n- Rename trait `IntoHeaderPair => TryIntoHeaderPair`. [#2510]\n- Rename `TryIntoHeaderPair::{try_into_header_pair => try_into_pair}`. [#2510]\n- Rename trait `IntoHeaderValue => TryIntoHeaderValue`. [#2510]\n\n### Removed\n\n- `MessageBody::{is_complete_body,take_complete_body}`. [#2522]\n\n[#2510]: https://github.com/actix/actix-web/pull/2510\n[#2522]: https://github.com/actix/actix-web/pull/2522\n\n## 3.0.0-beta.15\n\n### Added\n\n- Add timeout for canceling HTTP/2 server side connection handshake. Default to 5 seconds. [#2483]\n- HTTP/2 handshake timeout can be configured with `ServiceConfig::client_timeout`. [#2483]\n- `Response::map_into_boxed_body`. [#2468]\n- `body::EitherBody` enum. [#2468]\n- `body::None` struct. [#2468]\n- Impl `MessageBody` for `bytestring::ByteString`. [#2468]\n- `impl Clone for ws::HandshakeError`. [#2468]\n- `#[must_use]` for `ws::Codec` to prevent subtle bugs. [#1920]\n- `impl Default ` for `ws::Codec`. [#1920]\n- `header::QualityItem::{max, min}`. [#2486]\n- `header::Quality::{MAX, MIN}`. [#2486]\n- `impl Display` for `header::Quality`. [#2486]\n- Connection data set through the `on_connect_ext` callbacks is now accessible only from the new `Request::conn_data()` method. [#2491]\n- `Request::take_conn_data()`. [#2491]\n- `Request::take_req_data()`. [#2487]\n- `impl Clone` for `RequestHead`. [#2487]\n- New methods on `MessageBody` trait, `is_complete_body` and `take_complete_body`, both with default implementations, for optimizations on body types that are done in exactly one poll/chunk. [#2497]\n- New `boxed` method on `MessageBody` trait for wrapping body type. [#2520]\n\n### Changed\n\n- Rename `body::BoxBody::{from_body => new}`. [#2468]\n- Body type for `Responses` returned from `Response::{new, ok, etc...}` is now `BoxBody`. [#2468]\n- The `Error` associated type on `MessageBody` type now requires `impl Error` (or similar). [#2468]\n- Error types using in service builders now require `Into>`. [#2468]\n- `From` implementations on error types now return a `Response`. [#2468]\n- `ResponseBuilder::body(B)` now returns `Response>`. [#2468]\n- `ResponseBuilder::finish()` now returns `Response>`. [#2468]\n\n### Removed\n\n- `ResponseBuilder::streaming`. [#2468]\n- `impl Future` for `ResponseBuilder`. [#2468]\n- Remove unnecessary `MessageBody` bound on types passed to `body::AnyBody::new`. [#2468]\n- Move `body::AnyBody` to `awc`. Replaced with `EitherBody` and `BoxBody`. [#2468]\n- `impl Copy` for `ws::Codec`. [#1920]\n- `header::qitem` helper. Replaced with `header::QualityItem::max`. [#2486]\n- `impl TryFrom` for `header::Quality`. [#2486]\n- `http` module. Most everything it contained is exported at the crate root. [#2488]\n\n[#2483]: https://github.com/actix/actix-web/pull/2483\n[#2468]: https://github.com/actix/actix-web/pull/2468\n[#1920]: https://github.com/actix/actix-web/pull/1920\n[#2486]: https://github.com/actix/actix-web/pull/2486\n[#2487]: https://github.com/actix/actix-web/pull/2487\n[#2488]: https://github.com/actix/actix-web/pull/2488\n[#2491]: https://github.com/actix/actix-web/pull/2491\n[#2497]: https://github.com/actix/actix-web/pull/2497\n[#2520]: https://github.com/actix/actix-web/pull/2520\n\n## 3.0.0-beta.14\n\n### Changed\n\n- Guarantee ordering of `header::GetAll` iterator to be same as insertion order. [#2467]\n- Expose `header::map` module. [#2467]\n- Implement `ExactSizeIterator` and `FusedIterator` for all `HeaderMap` iterators. [#2470]\n- Update `actix-tls` to `3.0.0-rc.1`. [#2474]\n\n[#2467]: https://github.com/actix/actix-web/pull/2467\n[#2470]: https://github.com/actix/actix-web/pull/2470\n[#2474]: https://github.com/actix/actix-web/pull/2474\n\n## 3.0.0-beta.13\n\n### Added\n\n- `body::AnyBody::empty` for quickly creating an empty body. [#2446]\n- `body::AnyBody::none` for quickly creating a \"none\" body. [#2456]\n- `impl Clone` for `body::AnyBody where S: Clone`. [#2448]\n- `body::AnyBody::into_boxed` for quickly converting to a type-erased, boxed body type. [#2448]\n\n### Changed\n\n- Rename `body::AnyBody::{Message => Body}`. [#2446]\n- Rename `body::AnyBody::{from_message => new_boxed}`. [#2448]\n- Rename `body::AnyBody::{from_slice => copy_from_slice}`. [#2448]\n- Rename `body::{BoxAnyBody => BoxBody}`. [#2448]\n- Change representation of `AnyBody` to include a type parameter in `Body` variant. Defaults to `BoxBody`. [#2448]\n- `Encoder::response` now returns `AnyBody>`. [#2448]\n\n### Removed\n\n- `body::AnyBody::Empty`; an empty body can now only be represented as a zero-length `Bytes` variant. [#2446]\n- `body::BodySize::Empty`; an empty body can now only be represented as a `Sized(0)` variant. [#2446]\n- `EncoderError::Boxed`; it is no longer required. [#2446]\n- `body::ResponseBody`; is function is replaced by the new `body::AnyBody` enum. [#2446]\n\n[#2446]: https://github.com/actix/actix-web/pull/2446\n[#2448]: https://github.com/actix/actix-web/pull/2448\n[#2456]: https://github.com/actix/actix-web/pull/2456\n\n## 3.0.0-beta.12\n\n### Changed\n\n- Update `actix-server` to `2.0.0-beta.9`. [#2442]\n\n### Removed\n\n- `client` module. [#2425]\n- `trust-dns` feature. [#2425]\n\n[#2425]: https://github.com/actix/actix-web/pull/2425\n[#2442]: https://github.com/actix/actix-web/pull/2442\n\n## 3.0.0-beta.11\n\n### Changed\n\n- Updated rustls to v0.20. [#2414]\n- Minimum supported Rust version (MSRV) is now 1.52.\n\n[#2414]: https://github.com/actix/actix-web/pull/2414\n\n## 3.0.0-beta.10\n\n### Changed\n\n- `ContentEncoding` is now marked `#[non_exhaustive]`. [#2377]\n- Minimum supported Rust version (MSRV) is now 1.51.\n\n### Fixed\n\n- Remove slice creation pointing to potential uninitialized data on h1 encoder. [#2364]\n- Remove `Into` bound on `Encoder` body types. [#2375]\n- Fix quality parse error in Accept-Encoding header. [#2344]\n\n[#2364]: https://github.com/actix/actix-web/pull/2364\n[#2375]: https://github.com/actix/actix-web/pull/2375\n[#2344]: https://github.com/actix/actix-web/pull/2344\n[#2377]: https://github.com/actix/actix-web/pull/2377\n\n## 3.0.0-beta.9\n\n### Fixed\n\n- Potential HTTP request smuggling vulnerabilities. [RUSTSEC-2021-0081](https://github.com/rustsec/advisory-db/pull/977)\n\n## 3.0.0-beta.8\n\n### Changed\n\n- Change compression algorithm features flags. [#2250]\n\n### Removed\n\n- `downcast` and `downcast_get_type_id` macros. [#2291]\n\n[#2291]: https://github.com/actix/actix-web/pull/2291\n[#2250]: https://github.com/actix/actix-web/pull/2250\n\n## 3.0.0-beta.7\n\n### Added\n\n- Alias `body::Body` as `body::AnyBody`. [#2215]\n- `BoxAnyBody`: a boxed message body with boxed errors. [#2183]\n- Re-export `http` crate's `Error` type as `error::HttpError`. [#2171]\n- Re-export `StatusCode`, `Method`, `Version` and `Uri` at the crate root. [#2171]\n- Re-export `ContentEncoding` and `ConnectionType` at the crate root. [#2171]\n- `Response::into_body` that consumes response and returns body type. [#2201]\n- `impl Default` for `Response`. [#2201]\n- Add zstd support for `ContentEncoding`. [#2244]\n\n### Changed\n\n- The `MessageBody` trait now has an associated `Error` type. [#2183]\n- All error trait bounds in server service builders have changed from `Into` to `Into>`. [#2253]\n- All error trait bounds in message body and stream impls changed from `Into` to `Into>`. [#2253]\n- Places in `Response` where `ResponseBody` was received or returned now simply use `B`. [#2201]\n- `header` mod is now public. [#2171]\n- `uri` mod is now public. [#2171]\n- Update `language-tags` to `0.3`.\n- Reduce the level from `error` to `debug` for the log line that is emitted when a `500 Internal Server Error` is built using `HttpResponse::from_error`. [#2201]\n- `ResponseBuilder::message_body` now returns a `Result`. [#2201]\n- Remove `Unpin` bound on `ResponseBuilder::streaming`. [#2253]\n- `HttpServer::{listen_rustls(), bind_rustls()}` now honor the ALPN protocols in the configuration parameter. [#2226]\n\n### Removed\n\n- Stop re-exporting `http` crate's `HeaderMap` types in addition to ours. [#2171]\n- Down-casting for `MessageBody` types. [#2183]\n- `error::Result` alias. [#2201]\n- Error field from `Response` and `Response::error`. [#2205]\n- `impl Future` for `Response`. [#2201]\n- `Response::take_body` and old `Response::into_body` method that casted body type. [#2201]\n- `InternalError` and all the error types it constructed. [#2215]\n- Conversion (`impl Into`) of `Response` and `ResponseBuilder` to `Error`. [#2215]\n\n[#2171]: https://github.com/actix/actix-web/pull/2171\n[#2183]: https://github.com/actix/actix-web/pull/2183\n[#2196]: https://github.com/actix/actix-web/pull/2196\n[#2201]: https://github.com/actix/actix-web/pull/2201\n[#2205]: https://github.com/actix/actix-web/pull/2205\n[#2215]: https://github.com/actix/actix-web/pull/2215\n[#2253]: https://github.com/actix/actix-web/pull/2253\n[#2244]: https://github.com/actix/actix-web/pull/2244\n\n## 3.0.0-beta.6\n\n### Added\n\n- `impl MessageBody for Pin>`. [#2152]\n- `Response::{ok, bad_request, not_found, internal_server_error}`. [#2159]\n- Helper `body::to_bytes` for async collecting message body into Bytes. [#2158]\n\n### Changed\n\n- The type parameter of `Response` no longer has a default. [#2152]\n- The `Message` variant of `body::Body` is now `Pin>`. [#2152]\n- `BodyStream` and `SizedStream` are no longer restricted to Unpin types. [#2152]\n- Error enum types are marked `#[non_exhaustive]`. [#2161]\n\n### Removed\n\n- `cookies` feature flag. [#2065]\n- Top-level `cookies` mod (re-export). [#2065]\n- `HttpMessage` trait loses the `cookies` and `cookie` methods. [#2065]\n- `impl ResponseError for CookieParseError`. [#2065]\n- Deprecated methods on `ResponseBuilder`: `if_true`, `if_some`. [#2148]\n- `ResponseBuilder::json`. [#2148]\n- `ResponseBuilder::{set_header, header}`. [#2148]\n- `impl From for Body`. [#2148]\n- `Response::build_from`. [#2159]\n- Most of the status code builders on `Response`. [#2159]\n\n[#2065]: https://github.com/actix/actix-web/pull/2065\n[#2148]: https://github.com/actix/actix-web/pull/2148\n[#2152]: https://github.com/actix/actix-web/pull/2152\n[#2159]: https://github.com/actix/actix-web/pull/2159\n[#2158]: https://github.com/actix/actix-web/pull/2158\n[#2161]: https://github.com/actix/actix-web/pull/2161\n\n## 3.0.0-beta.5\n\n### Added\n\n- `client::Connector::handshake_timeout` method for customizing TLS connection handshake timeout. [#2081]\n- `client::ConnectorService` as `client::Connector::finish` method's return type [#2081]\n- `client::ConnectionIo` trait alias [#2081]\n\n### Changed\n\n- `client::Connector` type now only have one generic type for `actix_service::Service`. [#2063]\n\n### Removed\n\n- Common typed HTTP headers were moved to actix-web. [2094]\n- `ResponseError` impl for `actix_utils::timeout::TimeoutError`. [#2127]\n\n[#2063]: https://github.com/actix/actix-web/pull/2063\n[#2081]: https://github.com/actix/actix-web/pull/2081\n[#2094]: https://github.com/actix/actix-web/pull/2094\n[#2127]: https://github.com/actix/actix-web/pull/2127\n\n## 3.0.0-beta.4\n\n### Changed\n\n- Feature `cookies` is now optional and disabled by default. [#1981]\n- `ws::hash_key` now returns array. [#2035]\n- `ResponseBuilder::json` now takes `impl Serialize`. [#2052]\n\n### Removed\n\n- Re-export of `futures_channel::oneshot::Canceled` is removed from `error` mod. [#1994]\n- `ResponseError` impl for `futures_channel::oneshot::Canceled` is removed. [#1994]\n\n[#1981]: https://github.com/actix/actix-web/pull/1981\n[#1994]: https://github.com/actix/actix-web/pull/1994\n[#2035]: https://github.com/actix/actix-web/pull/2035\n[#2052]: https://github.com/actix/actix-web/pull/2052\n\n## 3.0.0-beta.3\n\n- No notable changes.\n\n## 3.0.0-beta.2\n\n### Added\n\n- `TryIntoHeaderPair` trait that allows using typed and untyped headers in the same methods. [#1869]\n- `ResponseBuilder::insert_header` method which allows using typed headers. [#1869]\n- `ResponseBuilder::append_header` method which allows using typed headers. [#1869]\n- `TestRequest::insert_header` method which allows using typed headers. [#1869]\n- `ContentEncoding` implements all necessary header traits. [#1912]\n- `HeaderMap::len_keys` has the behavior of the old `len` method. [#1964]\n- `HeaderMap::drain` as an efficient draining iterator. [#1964]\n- Implement `IntoIterator` for owned `HeaderMap`. [#1964]\n- `trust-dns` optional feature to enable `trust-dns-resolver` as client dns resolver. [#1969]\n\n### Changed\n\n- `ResponseBuilder::content_type` now takes an `impl TryIntoHeaderValue` to support using typed `mime` types. [#1894]\n- Renamed `TryIntoHeaderValue::{try_into => try_into_value}` to avoid ambiguity with std `TryInto` trait. [#1894]\n- `Extensions::insert` returns Option of replaced item. [#1904]\n- Remove `HttpResponseBuilder::json2()`. [#1903]\n- Enable `HttpResponseBuilder::json()` to receive data by value and reference. [#1903]\n- `client::error::ConnectError` Resolver variant contains `Box` type. [#1905]\n- `client::ConnectorConfig` default timeout changed to 5 seconds. [#1905]\n- Simplify `BlockingError` type to a unit struct. It's now only triggered when blocking thread pool is dead. [#1957]\n- `HeaderMap::len` now returns number of values instead of number of keys. [#1964]\n- `HeaderMap::insert` now returns iterator of removed values. [#1964]\n- `HeaderMap::remove` now returns iterator of removed values. [#1964]\n\n### Removed\n\n- `ResponseBuilder::set`; use `ResponseBuilder::insert_header`. [#1869]\n- `ResponseBuilder::set_header`; use `ResponseBuilder::insert_header`. [#1869]\n- `ResponseBuilder::header`; use `ResponseBuilder::append_header`. [#1869]\n- `TestRequest::with_hdr`; use `TestRequest::default().insert_header()`. [#1869]\n- `TestRequest::with_header`; use `TestRequest::default().insert_header()`. [#1869]\n- `actors` optional feature. [#1969]\n- `ResponseError` impl for `actix::MailboxError`. [#1969]\n\n### Documentation\n\n- Vastly improve docs and add examples for `HeaderMap`. [#1964]\n\n[#1869]: https://github.com/actix/actix-web/pull/1869\n[#1894]: https://github.com/actix/actix-web/pull/1894\n[#1903]: https://github.com/actix/actix-web/pull/1903\n[#1904]: https://github.com/actix/actix-web/pull/1904\n[#1905]: https://github.com/actix/actix-web/pull/1905\n[#1912]: https://github.com/actix/actix-web/pull/1912\n[#1957]: https://github.com/actix/actix-web/pull/1957\n[#1964]: https://github.com/actix/actix-web/pull/1964\n[#1969]: https://github.com/actix/actix-web/pull/1969\n\n## 3.0.0-beta.1\n\n### Added\n\n- Add `Http3` to `Protocol` enum for future compatibility and also mark `#[non_exhaustive]`.\n\n### Changed\n\n- Update `actix-*` dependencies to tokio `1.0` based versions. [#1813]\n- Bumped `rand` to `0.8`.\n- Update `bytes` to `1.0`. [#1813]\n- Update `h2` to `0.3`. [#1813]\n- The `ws::Message::Text` enum variant now contains a `bytestring::ByteString`. [#1864]\n\n### Removed\n\n- Deprecated `on_connect` methods have been removed. Prefer the new `on_connect_ext` technique. [#1857]\n- Remove `ResponseError` impl for `actix::actors::resolver::ResolverError` due to deprecate of resolver actor. [#1813]\n- Remove `ConnectError::SslHandshakeError` and re-export of `HandshakeError`. due to the removal of this type from `tokio-openssl` crate. openssl handshake error would return as `ConnectError::SslError`. [#1813]\n- Remove `actix-threadpool` dependency. Use `actix_rt::task::spawn_blocking`. Due to this change `actix_threadpool::BlockingError` type is moved into `actix_http::error` module. [#1878]\n\n[#1813]: https://github.com/actix/actix-web/pull/1813\n[#1857]: https://github.com/actix/actix-web/pull/1857\n[#1864]: https://github.com/actix/actix-web/pull/1864\n[#1878]: https://github.com/actix/actix-web/pull/1878\n\n
    \n\n## 2.2.2\n\n### Changed\n\n- Migrate to `brotli` crate. [ad7e3c06]\n\n[ad7e3c06]: https://github.com/actix/actix-web/commit/ad7e3c06\n\n## 2.2.1\n\n### Fixed\n\n- Potential HTTP request smuggling vulnerabilities. [RUSTSEC-2021-0081](https://github.com/rustsec/advisory-db/pull/977)\n\n## 2.2.0\n\n### Added\n\n- HttpResponse builders for 1xx status codes. [#1768]\n- `Accept::mime_precedence` and `Accept::mime_preference`. [#1793]\n- `TryFrom` and `TryFrom` for `http::header::Quality`. [#1797]\n\n### Fixed\n\n- Started dropping `transfer-encoding: chunked` and `Content-Length` for 1XX and 204 responses. [#1767]\n\n### Changed\n\n- Upgrade `serde_urlencoded` to `0.7`. [#1773]\n\n[#1773]: https://github.com/actix/actix-web/pull/1773\n[#1767]: https://github.com/actix/actix-web/pull/1767\n[#1768]: https://github.com/actix/actix-web/pull/1768\n[#1793]: https://github.com/actix/actix-web/pull/1793\n[#1797]: https://github.com/actix/actix-web/pull/1797\n\n## 2.1.0\n\n### Added\n\n- Added more flexible `on_connect_ext` methods for on-connect handling. [#1754]\n\n### Changed\n\n- Upgrade `base64` to `0.13`. [#1744]\n- Upgrade `pin-project` to `1.0`. [#1733]\n- Deprecate `ResponseBuilder::{if_some, if_true}`. [#1760]\n\n[#1760]: https://github.com/actix/actix-web/pull/1760\n[#1754]: https://github.com/actix/actix-web/pull/1754\n[#1733]: https://github.com/actix/actix-web/pull/1733\n[#1744]: https://github.com/actix/actix-web/pull/1744\n\n## 2.0.0\n\n- No significant changes from `2.0.0-beta.4`.\n\n## 2.0.0-beta.4\n\n### Changed\n\n- Update actix-codec and actix-utils dependencies.\n- Update actix-connect and actix-tls dependencies.\n\n## 2.0.0-beta.3\n\n### Fixed\n\n- Memory leak of `client::pool::ConnectorPoolSupport`. [#1626]\n\n[#1626]: https://github.com/actix/actix-web/pull/1626\n\n## 2.0.0-beta.2\n\n### Fixed\n\n- Potential UB in h1 decoder using uninitialized memory. [#1614]\n\n### Changed\n\n- Fix illegal chunked encoding. [#1615]\n\n[#1614]: https://github.com/actix/actix-web/pull/1614\n[#1615]: https://github.com/actix/actix-web/pull/1615\n\n## 2.0.0-beta.1\n\n### Changed\n\n- Migrate cookie handling to `cookie` crate. [#1558]\n- Update `sha-1` to 0.9. [#1586]\n- Fix leak in client pool. [#1580]\n- MSRV is now 1.41.1.\n\n[#1558]: https://github.com/actix/actix-web/pull/1558\n[#1586]: https://github.com/actix/actix-web/pull/1586\n[#1580]: https://github.com/actix/actix-web/pull/1580\n\n## 2.0.0-alpha.4\n\n### Changed\n\n- Bump minimum supported Rust version to 1.40\n- content_length function is removed, and you can set Content-Length by calling no_chunking function [#1439]\n- `BodySize::Sized64` variant has been removed. `BodySize::Sized` now receives a `u64` instead of a `usize`.\n- Update `base64` dependency to 0.12\n\n### Fixed\n\n- Support parsing of `SameSite=None` [#1503]\n\n[#1439]: https://github.com/actix/actix-web/pull/1439\n[#1503]: https://github.com/actix/actix-web/pull/1503\n\n## 2.0.0-alpha.3\n\n### Fixed\n\n- Correct spelling of ConnectError::Unresolved [#1487]\n- Fix a mistake in the encoding of websocket continuation messages wherein Item::FirstText and Item::FirstBinary are each encoded as the other.\n\n### Changed\n\n- Implement `std::error::Error` for our custom errors [#1422]\n- Remove `failure` support for `ResponseError` since that crate will be deprecated in the near future.\n\n[#1422]: https://github.com/actix/actix-web/pull/1422\n[#1487]: https://github.com/actix/actix-web/pull/1487\n\n## 2.0.0-alpha.2\n\n### Changed\n\n- Update `actix-connect` and `actix-tls` dependency to 2.0.0-alpha.1. [#1395]\n- Change default initial window size and connection window size for HTTP2 to 2MB and 1MB respectively to improve download speed for awc when downloading large objects. [#1394]\n- client::Connector accepts initial_window_size and initial_connection_window_size HTTP2 configuration. [#1394]\n- client::Connector allowing to set max_http_version to limit HTTP version to be used. [#1394]\n\n[#1394]: https://github.com/actix/actix-web/pull/1394\n[#1395]: https://github.com/actix/actix-web/pull/1395\n\n## 2.0.0-alpha.1\n\n### Changed\n\n- Update the `time` dependency to 0.2.7.\n- Moved actors messages support from actix crate, enabled with feature `actors`.\n- Breaking change: trait MessageBody requires Unpin and accepting `Pin<&mut Self>` instead of `&mut self` in the poll_next().\n- MessageBody is not implemented for &'static [u8] anymore.\n\n### Fixed\n\n- Allow `SameSite=None` cookies to be sent in a response.\n\n## 1.0.1\n\n### Fixed\n\n- Poll upgrade service's readiness from HTTP service handlers\n- Replace brotli with brotli2 #1224\n\n## 1.0.0\n\n### Added\n\n- Add websockets continuation frame support\n\n### Changed\n\n- Replace `flate2-xxx` features with `compress`\n\n## 1.0.0-alpha.5\n\n### Fixed\n\n- Check `Upgrade` service readiness before calling it\n- Fix buffer remaining capacity calculation\n\n### Changed\n\n- Websockets: Ping and Pong should have binary data #1049\n\n## 1.0.0-alpha.4\n\n### Added\n\n- Add impl ResponseBuilder for Error\n\n### Changed\n\n- Use rust based brotli compression library\n\n## 1.0.0-alpha.3\n\n### Changed\n\n- Migrate to tokio 0.2\n- Migrate to `std::future`\n\n## 0.2.11\n\n### Added\n\n- Add support for serde_json::Value to be passed as argument to ResponseBuilder.body()\n- Add an additional `filename*` param in the `Content-Disposition` header of `actix_files::NamedFile` to be more compatible. (#1151)\n- Allow to use `std::convert::Infallible` as `actix_http::error::Error`\n\n### Fixed\n\n- To be compatible with non-English error responses, `ResponseError` rendered with `text/plain; charset=utf-8` header [#1118]\n\n[#1878]: https://github.com/actix/actix-web/pull/1878\n\n## 0.2.10\n\n### Added\n\n- Add support for sending HTTP requests with `Rc` in addition to sending HTTP requests with `RequestHead`\n\n### Fixed\n\n- h2 will use error response #1080\n- on_connect result isn't added to request extensions for http2 requests #1009\n\n## 0.2.9\n\n### Changed\n\n- Dropped the `byteorder`-dependency in favor of `stdlib`-implementation\n- Update percent-encoding to 2.1\n- Update serde_urlencoded to 0.6.1\n\n### Fixed\n\n- Fixed a panic in the HTTP2 handshake in client HTTP requests (#1031)\n\n## 0.2.8\n\n### Added\n\n- Add `rustls` support\n- Add `Clone` impl for `HeaderMap`\n\n### Fixed\n\n- awc client panic #1016\n- Invalid response with compression middleware enabled, but compression-related features disabled #997\n\n## 0.2.7\n\n### Added\n\n- Add support for downcasting response errors #986\n\n## 0.2.6\n\n### Changed\n\n- Replace `ClonableService` with local copy\n- Upgrade `rand` dependency version to 0.7\n\n## 0.2.5\n\n### Added\n\n- Add `on-connect` callback, `HttpServiceBuilder::on_connect()` #946\n\n### Changed\n\n- Use `encoding_rs` crate instead of unmaintained `encoding` crate\n- Add `Copy` and `Clone` impls for `ws::Codec`\n\n## 0.2.4\n\n### Fixed\n\n- Do not compress NoContent (204) responses #918\n\n## 0.2.3\n\n### Added\n\n- Debug impl for ResponseBuilder\n- From SizedStream and BodyStream for Body\n\n### Changed\n\n- SizedStream uses u64\n\n## 0.2.2\n\n### Fixed\n\n- Parse incoming stream before closing stream on disconnect #868\n\n## 0.2.1\n\n### Fixed\n\n- Handle socket read disconnect\n\n## 0.2.0\n\n### Changed\n\n- Update actix-service to 0.4\n- Expect and upgrade services accept `ServerConfig` config.\n\n### Deleted\n\n- `OneRequest` service\n\n## 0.1.5\n\n### Fixed\n\n- Clean up response extensions in response pool #817\n\n## 0.1.4\n\n### Added\n\n- Allow to render h1 request headers in `Camel-Case`\n\n### Fixed\n\n- Read until eof for http/1.0 responses #771\n\n## 0.1.3\n\n### Fixed\n\n- Fix http client pool management\n- Fix http client wait queue management #794\n\n## 0.1.2\n\n### Fixed\n\n- Fix BorrowMutError panic in client connector #793\n\n## 0.1.1\n\n### Changed\n\n- Cookie::max_age() accepts value in seconds\n- Cookie::max_age_time() accepts value in time::Duration\n- Allow to specify server address for client connector\n\n## 0.1.0\n\n### Added\n\n- Expose peer addr via `Request::peer_addr()` and `RequestHead::peer_addr`\n\n### Changed\n\n- `actix_http::encoding` always available\n- use trust-dns-resolver 0.11.0\n\n## 0.1.0-alpha.5\n\n### Added\n\n- Allow to use custom service for upgrade requests\n- Added `h1::SendResponse` future.\n\n### Changed\n\n- MessageBody::length() renamed to MessageBody::size() for consistency\n- ws handshake verification functions take RequestHead instead of Request\n\n## 0.1.0-alpha.4\n\n### Added\n\n- Allow to use custom `Expect` handler\n- Add minimal `std::error::Error` impl for `Error`\n\n### Changed\n\n- Export IntoHeaderValue\n- Render error and return as response body\n- Use thread pool for response body compression\n\n### Deleted\n\n- Removed PayloadBuffer\n\n## 0.1.0-alpha.3\n\n### Added\n\n- Warn when an unsealed private cookie isn't valid UTF-8\n\n### Fixed\n\n- Rust 1.31.0 compatibility\n- Preallocate read buffer for h1 codec\n- Detect socket disconnection during protocol selection\n\n## 0.1.0-alpha.2\n\n### Added\n\n- Added ws::Message::Nop, no-op websockets message\n\n### Changed\n\n- Do not use thread pool for decompression if chunk size is smaller than 2048.\n\n## 0.1.0-alpha.1\n\n- Initial impl\n" }, { "path": "actix-http/Cargo.toml", "content": "[package]\nname = \"actix-http\"\nversion = \"3.12.0\"\nauthors = [\"Nikolay Kim \", \"Rob Ede \"]\ndescription = \"HTTP types and services for the Actix ecosystem\"\nkeywords = [\"actix\", \"http\", \"framework\", \"async\", \"futures\"]\nhomepage = \"https://actix.rs\"\nrepository = \"https://github.com/actix/actix-web\"\ncategories = [\n \"network-programming\",\n \"asynchronous\",\n \"web-programming::http-server\",\n \"web-programming::websocket\",\n]\nlicense.workspace = true\nedition.workspace = true\nrust-version.workspace = true\n\n[package.metadata.docs.rs]\nfeatures = [\n \"http2\",\n \"ws\",\n \"openssl\",\n \"rustls-0_20\",\n \"rustls-0_21\",\n \"rustls-0_22\",\n \"rustls-0_23\",\n \"compress-brotli\",\n \"compress-gzip\",\n \"compress-zstd\",\n]\n\n[package.metadata.cargo_check_external_types]\nallowed_external_types = [\n \"actix_codec::*\",\n \"actix_service::*\",\n \"actix_tls::*\",\n \"actix_utils::*\",\n \"bytes::*\",\n \"bytestring::*\",\n \"encoding_rs::*\",\n \"futures_core::*\",\n \"h2::*\",\n \"http::*\",\n \"httparse::*\",\n \"language_tags::*\",\n \"mime::*\",\n \"openssl::*\",\n \"rustls::*\",\n \"tokio_util::*\",\n \"tokio::*\",\n]\n\n[features]\ndefault = []\n\n# HTTP/2 protocol support\nhttp2 = [\"dep:h2\"]\n\n# WebSocket protocol implementation\nws = [\"dep:local-channel\", \"dep:base64\", \"dep:rand\", \"dep:sha1\"]\n\n# TLS via OpenSSL\nopenssl = [\"__tls\", \"actix-tls/accept\", \"actix-tls/openssl\"]\n\n# TLS via Rustls v0.20\nrustls = [\"__tls\", \"rustls-0_20\"]\n\n# TLS via Rustls v0.20\nrustls-0_20 = [\"__tls\", \"actix-tls/accept\", \"actix-tls/rustls-0_20\"]\n\n# TLS via Rustls v0.21\nrustls-0_21 = [\"__tls\", \"actix-tls/accept\", \"actix-tls/rustls-0_21\"]\n\n# TLS via Rustls v0.22\nrustls-0_22 = [\"__tls\", \"actix-tls/accept\", \"actix-tls/rustls-0_22\"]\n\n# TLS via Rustls v0.23\nrustls-0_23 = [\"__tls\", \"actix-tls/accept\", \"actix-tls/rustls-0_23\"]\n\n# Compression codecs\ncompress-brotli = [\"__compress\", \"dep:brotli\"]\ncompress-gzip = [\"__compress\", \"dep:flate2\"]\ncompress-zstd = [\"__compress\", \"dep:zstd\"]\n\n# Internal (PRIVATE!) features used to aid testing and checking feature status.\n# Don't rely on these whatsoever. They are semver-exempt and may disappear at anytime.\n__compress = []\n\n# Internal (PRIVATE!) features used to aid checking feature status.\n# Don't rely on these whatsoever. They may disappear at anytime.\n__tls = []\n\n[dependencies]\nactix-codec = \"0.5\"\nactix-rt = { version = \"2.2\", default-features = false }\nactix-service = \"2\"\nactix-utils = \"3\"\n\nbitflags = \"2\"\nbytes = \"1\"\nbytestring = \"1\"\nderive_more = { version = \"2\", features = [\"as_ref\", \"deref\", \"deref_mut\", \"display\", \"error\", \"from\"] }\nencoding_rs = \"0.8\"\nfoldhash = \"0.1\"\nfutures-core = { version = \"0.3.17\", default-features = false, features = [\"alloc\"] }\nhttp = \"0.2.7\"\nhttparse = \"1.5.1\"\nhttpdate = \"1.0.1\"\nitoa = \"1\"\nlanguage-tags = \"0.3\"\nmime = \"0.3.4\"\npercent-encoding = \"2.1\"\npin-project-lite = \"0.2\"\nsmallvec = \"1.6.1\"\ntokio = { version = \"1.38.2\", features = [] }\ntokio-util = { version = \"0.7\", features = [\"io\", \"codec\"] }\ntracing = { version = \"0.1.30\", default-features = false, features = [\"log\"] }\n\n# http2\nh2 = { version = \"0.3.27\", optional = true }\n\n# websockets\nbase64 = { version = \"0.22\", optional = true }\nlocal-channel = { version = \"0.1\", optional = true }\nrand = { version = \"0.9\", optional = true }\nsha1 = { version = \"0.10\", optional = true }\n\n# openssl/rustls\nactix-tls = { version = \"3.4\", default-features = false, optional = true }\n\n# compress-*\nbrotli = { version = \"8\", optional = true }\nflate2 = { version = \"1.0.13\", optional = true }\nzstd = { version = \"0.13\", optional = true }\n\n[dev-dependencies]\nactix-http-test = { version = \"3\", features = [\"openssl\"] }\nactix-server = \"2\"\nactix-tls = { version = \"3.4\", features = [\"openssl\", \"rustls-0_23-webpki-roots\"] }\nactix-web = \"4\"\nawc = { version = \"3\", default-features = false, features = [\"openssl\"] }\n\nasync-stream = \"0.3\"\ncriterion = { version = \"0.5\", features = [\"html_reports\"] }\ndivan = \"0.1.8\"\nenv_logger = \"0.11\"\nfutures-util = { version = \"0.3.17\", default-features = false, features = [\"alloc\"] }\nmemchr = \"2.4\"\nonce_cell = \"1.21\"\nrcgen = \"0.13\"\nregex = \"1.3\"\nrustls-pki-types = \"1.13.1\"\nrustversion = \"1\"\nserde = { version = \"1\", features = [\"derive\"] }\nserde_json = \"1.0\"\nstatic_assertions = \"1\"\ntls-openssl = { package = \"openssl\", version = \"0.10.55\" }\ntls-rustls_023 = { package = \"rustls\", version = \"0.23\" }\ntokio = { version = \"1.38.2\", features = [\"net\", \"rt\", \"macros\", \"sync\"] }\n\n[lints]\nworkspace = true\n\n[[example]]\nname = \"ws\"\nrequired-features = [\"ws\", \"rustls-0_23\"]\n\n[[example]]\nname = \"tls_rustls\"\nrequired-features = [\"http2\", \"rustls-0_23\"]\n\n[[bench]]\nname = \"response-body-compression\"\nharness = false\nrequired-features = [\"compress-brotli\", \"compress-gzip\", \"compress-zstd\"]\n\n[[bench]]\nname = \"date-formatting\"\nharness = false\n" }, { "path": "actix-http/README.md", "content": "# `actix-http`\n\n> HTTP types and services for the Actix ecosystem.\n\n\n\n[![crates.io](https://img.shields.io/crates/v/actix-http?label=latest)](https://crates.io/crates/actix-http)\n[![Documentation](https://docs.rs/actix-http/badge.svg?version=3.12.0)](https://docs.rs/actix-http/3.12.0)\n![Version](https://img.shields.io/badge/rustc-1.88+-ab6000.svg)\n![MIT or Apache 2.0 licensed](https://img.shields.io/crates/l/actix-http.svg)\n
    \n[![dependency status](https://deps.rs/crate/actix-http/3.12.0/status.svg)](https://deps.rs/crate/actix-http/3.12.0)\n[![Download](https://img.shields.io/crates/d/actix-http.svg)](https://crates.io/crates/actix-http)\n[![Chat on Discord](https://img.shields.io/discord/771444961383153695?label=chat&logo=discord)](https://discord.gg/NWpN5mmg3x)\n\n\n\n## Examples\n\n```rust\nuse std::{env, io};\n\nuse actix_http::{HttpService, Response};\nuse actix_server::Server;\nuse futures_util::future;\nuse http::header::HeaderValue;\nuse tracing::info;\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env::set_var(\"RUST_LOG\", \"hello_world=info\");\n env_logger::init();\n\n Server::build()\n .bind(\"hello-world\", \"127.0.0.1:8080\", || {\n HttpService::build()\n .client_timeout(1000)\n .client_disconnect(1000)\n .finish(|_req| {\n info!(\"{:?}\", _req);\n let mut res = Response::Ok();\n res.header(\"x-head\", HeaderValue::from_static(\"dummy value!\"));\n future::ok::<_, ()>(res.body(\"Hello world!\"))\n })\n .tcp()\n })?\n .run()\n .await\n}\n```\n" }, { "path": "actix-http/benches/date-formatting.rs", "content": "use std::time::SystemTime;\n\nuse actix_http::header::HttpDate;\nuse divan::{black_box, AllocProfiler, Bencher};\n\n#[global_allocator]\nstatic ALLOC: AllocProfiler = AllocProfiler::system();\n\n#[divan::bench]\nfn date_formatting(b: Bencher<'_, '_>) {\n let now = SystemTime::now();\n\n b.bench(|| {\n black_box(HttpDate::from(black_box(now)).to_string());\n })\n}\n\nfn main() {\n divan::main();\n}\n" }, { "path": "actix-http/benches/response-body-compression.rs", "content": "use std::convert::Infallible;\n\nuse actix_http::{encoding::Encoder, ContentEncoding, Request, Response, StatusCode};\nuse actix_service::{fn_service, Service as _};\nuse criterion::{black_box, criterion_group, criterion_main, Criterion};\n\nstatic BODY: &[u8] = include_bytes!(\"../Cargo.toml\");\n\nfn compression_responses(c: &mut Criterion) {\n let mut group = c.benchmark_group(\"compression responses\");\n\n group.bench_function(\"identity\", |b| {\n let rt = actix_rt::Runtime::new().unwrap();\n\n let identity_svc = fn_service(|_: Request| async move {\n let mut res = Response::with_body(StatusCode::OK, ());\n let body = black_box(Encoder::response(\n ContentEncoding::Identity,\n res.head_mut(),\n BODY,\n ));\n Ok::<_, Infallible>(black_box(res.set_body(black_box(body))))\n });\n\n b.iter(|| {\n rt.block_on(identity_svc.call(Request::new())).unwrap();\n });\n });\n\n group.bench_function(\"gzip\", |b| {\n let rt = actix_rt::Runtime::new().unwrap();\n\n let identity_svc = fn_service(|_: Request| async move {\n let mut res = Response::with_body(StatusCode::OK, ());\n let body = black_box(Encoder::response(\n ContentEncoding::Gzip,\n res.head_mut(),\n BODY,\n ));\n Ok::<_, Infallible>(black_box(res.set_body(black_box(body))))\n });\n\n b.iter(|| {\n rt.block_on(identity_svc.call(Request::new())).unwrap();\n });\n });\n\n group.bench_function(\"br\", |b| {\n let rt = actix_rt::Runtime::new().unwrap();\n\n let identity_svc = fn_service(|_: Request| async move {\n let mut res = Response::with_body(StatusCode::OK, ());\n let body = black_box(Encoder::response(\n ContentEncoding::Brotli,\n res.head_mut(),\n BODY,\n ));\n Ok::<_, Infallible>(black_box(res.set_body(black_box(body))))\n });\n\n b.iter(|| {\n rt.block_on(identity_svc.call(Request::new())).unwrap();\n });\n });\n\n group.bench_function(\"zstd\", |b| {\n let rt = actix_rt::Runtime::new().unwrap();\n\n let identity_svc = fn_service(|_: Request| async move {\n let mut res = Response::with_body(StatusCode::OK, ());\n let body = black_box(Encoder::response(\n ContentEncoding::Zstd,\n res.head_mut(),\n BODY,\n ));\n Ok::<_, Infallible>(black_box(res.set_body(black_box(body))))\n });\n\n b.iter(|| {\n rt.block_on(identity_svc.call(Request::new())).unwrap();\n });\n });\n\n group.finish();\n}\n\ncriterion_group!(benches, compression_responses);\ncriterion_main!(benches);\n" }, { "path": "actix-http/examples/actix-web.rs", "content": "use actix_http::HttpService;\nuse actix_server::Server;\nuse actix_service::map_config;\nuse actix_web::{dev::AppConfig, get, App, Responder};\n\n#[get(\"/\")]\nasync fn index() -> impl Responder {\n \"Hello, world. From Actix Web!\"\n}\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> std::io::Result<()> {\n Server::build()\n .bind(\"hello-world\", \"127.0.0.1:8080\", || {\n // construct actix-web app\n let app = App::new().service(index);\n\n HttpService::build()\n // pass the app to service builder\n // map_config is used to map App's configuration to ServiceBuilder\n // h1 will configure server to only use HTTP/1.1\n .h1(map_config(app, |_| AppConfig::default()))\n .tcp()\n })?\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/bench.rs", "content": "use std::{convert::Infallible, io, time::Duration};\n\nuse actix_http::{HttpService, Request, Response, StatusCode};\nuse actix_server::Server;\nuse once_cell::sync::Lazy;\n\nstatic STR: Lazy = Lazy::new(|| \"HELLO WORLD \".repeat(20));\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"dispatcher-benchmark\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n .client_request_timeout(Duration::from_secs(1))\n .finish(|_: Request| async move {\n let mut res = Response::build(StatusCode::OK);\n Ok::<_, Infallible>(res.body(&**STR))\n })\n .tcp()\n })?\n // limiting number of workers so that bench client is not sharing as many resources\n .workers(4)\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/echo.rs", "content": "use std::{io, time::Duration};\n\nuse actix_http::{Error, HttpService, Request, Response, StatusCode};\nuse actix_server::Server;\nuse bytes::BytesMut;\nuse futures_util::StreamExt as _;\nuse http::header::HeaderValue;\nuse tracing::info;\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"echo\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n .client_request_timeout(Duration::from_secs(1))\n .client_disconnect_timeout(Duration::from_secs(1))\n // handles HTTP/1.1 and HTTP/2\n .finish(|mut req: Request| async move {\n let mut body = BytesMut::new();\n while let Some(item) = req.payload().next().await {\n body.extend_from_slice(&item?);\n }\n\n info!(\"request body: {body:?}\");\n\n let res = Response::build(StatusCode::OK)\n .insert_header((\"x-head\", HeaderValue::from_static(\"dummy value!\")))\n .body(body);\n\n Ok::<_, Error>(res)\n })\n .tcp() // No TLS\n })?\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/echo2.rs", "content": "use std::io;\n\nuse actix_http::{\n body::{BodyStream, MessageBody},\n header, Error, HttpMessage, HttpService, Request, Response, StatusCode,\n};\n\nasync fn handle_request(mut req: Request) -> Result, Error> {\n let mut res = Response::build(StatusCode::OK);\n\n if let Some(ct) = req.headers().get(header::CONTENT_TYPE) {\n res.insert_header((header::CONTENT_TYPE, ct));\n }\n\n // echo request payload stream as (chunked) response body\n let res = res.message_body(BodyStream::new(req.payload().take()))?;\n\n Ok(res)\n}\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n actix_server::Server::build()\n .bind(\"echo\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n // handles HTTP/1.1 only\n .h1(handle_request)\n // No TLS\n .tcp()\n })?\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/h2c-detect.rs", "content": "//! An example that supports automatic selection of plaintext h1/h2c connections.\n//!\n//! Notably, both the following commands will work.\n//! ```console\n//! $ curl --http1.1 'http://localhost:8080/'\n//! $ curl --http2-prior-knowledge 'http://localhost:8080/'\n//! ```\n\nuse std::{convert::Infallible, io};\n\nuse actix_http::{body::BodyStream, HttpService, Request, Response, StatusCode};\nuse actix_server::Server;\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"h2c-detect\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n .finish(|_req: Request| async move {\n Ok::<_, Infallible>(Response::build(StatusCode::OK).body(BodyStream::new(\n futures_util::stream::iter([\n Ok::<_, String>(\"123\".into()),\n Err(\"wertyuikmnbvcxdfty6t\".to_owned()),\n ]),\n )))\n })\n .tcp_auto_h2c()\n })?\n .workers(2)\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/h2spec.rs", "content": "use std::{convert::Infallible, io};\n\nuse actix_http::{HttpService, Request, Response, StatusCode};\nuse actix_server::Server;\nuse once_cell::sync::Lazy;\n\nstatic STR: Lazy = Lazy::new(|| \"HELLO WORLD \".repeat(100));\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"h2spec\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n .h2(|_: Request| async move {\n let mut res = Response::build(StatusCode::OK);\n Ok::<_, Infallible>(res.body(&**STR))\n })\n .tcp()\n })?\n .workers(4)\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/hello-world.rs", "content": "use std::{convert::Infallible, io, time::Duration};\n\nuse actix_http::{header::HeaderValue, HttpService, Request, Response, StatusCode};\nuse actix_server::Server;\nuse tracing::info;\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"hello-world\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n .client_request_timeout(Duration::from_secs(1))\n .client_disconnect_timeout(Duration::from_secs(1))\n .on_connect_ext(|_, ext| {\n ext.insert(42u32);\n })\n .finish(|req: Request| async move {\n info!(\"{req:?}\");\n\n let mut res = Response::build(StatusCode::OK);\n res.insert_header((\"x-head\", HeaderValue::from_static(\"dummy value!\")));\n\n let forty_two = req.conn_data::().unwrap().to_string();\n res.insert_header((\"x-forty-two\", HeaderValue::from_str(&forty_two).unwrap()));\n\n Ok::<_, Infallible>(res.body(\"Hello world!\"))\n })\n .tcp()\n })?\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/streaming-error.rs", "content": "//! Example showing response body (chunked) stream erroring.\n//!\n//! Test using `nc` or `curl`.\n//! ```sh\n//! $ curl -vN 127.0.0.1:8080\n//! $ echo 'GET / HTTP/1.1\\n\\n' | nc 127.0.0.1 8080\n//! ```\n\nuse std::{convert::Infallible, io, time::Duration};\n\nuse actix_http::{body::BodyStream, HttpService, Response};\nuse actix_server::Server;\nuse async_stream::stream;\nuse bytes::Bytes;\nuse tracing::info;\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"streaming-error\", (\"127.0.0.1\", 8080), || {\n HttpService::build()\n .finish(|req| async move {\n info!(\"{req:?}\");\n let res = Response::ok();\n\n Ok::<_, Infallible>(res.set_body(BodyStream::new(stream! {\n yield Ok(Bytes::from(\"123\"));\n yield Ok(Bytes::from(\"456\"));\n\n actix_rt::time::sleep(Duration::from_secs(1)).await;\n\n yield Err(io::Error::other(\"abc\"));\n })))\n })\n .tcp()\n })?\n .run()\n .await\n}\n" }, { "path": "actix-http/examples/tls_rustls.rs", "content": "//! Demonstrates TLS configuration (via Rustls) for HTTP/1.1 and HTTP/2 connections.\n//!\n//! Test using cURL:\n//!\n//! ```console\n//! $ curl --insecure https://127.0.0.1:8443\n//! Hello World!\n//! Protocol: HTTP/2.0\n//!\n//! $ curl --insecure --http1.1 https://127.0.0.1:8443\n//! Hello World!\n//! Protocol: HTTP/1.1\n//! ```\n\nextern crate tls_rustls_023 as rustls;\n\nuse std::io;\n\nuse actix_http::{Error, HttpService, Request, Response};\nuse actix_utils::future::ok;\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n tracing::info!(\"starting HTTP server at https://127.0.0.1:8443\");\n\n actix_server::Server::build()\n .bind(\"echo\", (\"127.0.0.1\", 8443), || {\n HttpService::build()\n .finish(|req: Request| {\n let body = format!(\n \"Hello World!\\n\\\n Protocol: {:?}\",\n req.head().version\n );\n ok::<_, Error>(Response::ok().set_body(body))\n })\n .rustls_0_23(rustls_config())\n })?\n .run()\n .await\n}\n\nfn rustls_config() -> rustls::ServerConfig {\n let rcgen::CertifiedKey { cert, key_pair } =\n rcgen::generate_simple_self_signed([\"localhost\".to_owned()]).unwrap();\n let cert_chain = vec![cert.der().clone()];\n let key_der = rustls_pki_types::PrivateKeyDer::Pkcs8(\n rustls_pki_types::PrivatePkcs8KeyDer::from(key_pair.serialize_der()),\n );\n\n let mut config = rustls::ServerConfig::builder()\n .with_no_client_auth()\n .with_single_cert(cert_chain, key_der)\n .unwrap();\n\n const H1_ALPN: &[u8] = b\"http/1.1\";\n const H2_ALPN: &[u8] = b\"h2\";\n\n config.alpn_protocols.push(H2_ALPN.to_vec());\n config.alpn_protocols.push(H1_ALPN.to_vec());\n\n config\n}\n" }, { "path": "actix-http/examples/ws.rs", "content": "//! Sets up a WebSocket server over TCP and TLS.\n//! Sends a heartbeat message every 4 seconds but does not respond to any incoming frames.\n\nextern crate tls_rustls_023 as rustls;\n\nuse std::{\n io,\n pin::Pin,\n task::{Context, Poll},\n time::Duration,\n};\n\nuse actix_http::{body::BodyStream, error::Error, ws, HttpService, Request, Response};\nuse actix_rt::time::{interval, Interval};\nuse actix_server::Server;\nuse bytes::{Bytes, BytesMut};\nuse bytestring::ByteString;\nuse futures_core::{ready, Stream};\nuse tokio_util::codec::Encoder;\n\n#[actix_rt::main]\nasync fn main() -> io::Result<()> {\n env_logger::init_from_env(env_logger::Env::new().default_filter_or(\"info\"));\n\n Server::build()\n .bind(\"tcp\", (\"127.0.0.1\", 8080), || {\n HttpService::build().h1(handler).tcp()\n })?\n .bind(\"tls\", (\"127.0.0.1\", 8443), || {\n HttpService::build()\n .finish(handler)\n .rustls_0_23(tls_config())\n })?\n .run()\n .await\n}\n\nasync fn handler(req: Request) -> Result>, Error> {\n tracing::info!(\"handshaking\");\n let mut res = ws::handshake(req.head())?;\n\n // handshake will always fail under HTTP/2\n\n tracing::info!(\"responding\");\n res.message_body(BodyStream::new(Heartbeat::new(ws::Codec::new())))\n}\n\nstruct Heartbeat {\n codec: ws::Codec,\n interval: Interval,\n}\n\nimpl Heartbeat {\n fn new(codec: ws::Codec) -> Self {\n Self {\n codec,\n interval: interval(Duration::from_secs(4)),\n }\n }\n}\n\nimpl Stream for Heartbeat {\n type Item = Result;\n\n fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n tracing::trace!(\"poll\");\n\n ready!(self.as_mut().interval.poll_tick(cx));\n\n let mut buffer = BytesMut::new();\n\n self.as_mut()\n .codec\n .encode(\n ws::Message::Text(ByteString::from_static(\"hello world\")),\n &mut buffer,\n )\n .unwrap();\n\n Poll::Ready(Some(Ok(buffer.freeze())))\n }\n}\n\nfn tls_config() -> rustls::ServerConfig {\n let rcgen::CertifiedKey { cert, key_pair } =\n rcgen::generate_simple_self_signed([\"localhost\".to_owned()]).unwrap();\n let cert_chain = vec![cert.der().clone()];\n let key_der = rustls_pki_types::PrivateKeyDer::Pkcs8(\n rustls_pki_types::PrivatePkcs8KeyDer::from(key_pair.serialize_der()),\n );\n\n let mut config = rustls::ServerConfig::builder()\n .with_no_client_auth()\n .with_single_cert(cert_chain, key_der)\n .unwrap();\n\n config.alpn_protocols.push(b\"http/1.1\".to_vec());\n config.alpn_protocols.push(b\"h2\".to_vec());\n\n config\n}\n" }, { "path": "actix-http/src/body/body_stream.rs", "content": "use std::{\n error::Error as StdError,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse bytes::Bytes;\nuse futures_core::{ready, Stream};\nuse pin_project_lite::pin_project;\n\nuse super::{BodySize, MessageBody};\n\npin_project! {\n /// Streaming response wrapper.\n ///\n /// Response does not contain `Content-Length` header and appropriate transfer encoding is used.\n pub struct BodyStream {\n #[pin]\n stream: S,\n }\n}\n\n// TODO: from_infallible method\n\nimpl BodyStream\nwhere\n S: Stream>,\n E: Into> + 'static,\n{\n #[inline]\n pub fn new(stream: S) -> Self {\n BodyStream { stream }\n }\n}\n\nimpl MessageBody for BodyStream\nwhere\n S: Stream>,\n E: Into> + 'static,\n{\n type Error = E;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Stream\n }\n\n /// Attempts to pull out the next value of the underlying [`Stream`].\n ///\n /// Empty values are skipped to prevent [`BodyStream`]'s transmission being ended on a\n /// zero-length chunk, but rather proceed until the underlying [`Stream`] ends.\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n loop {\n let stream = self.as_mut().project().stream;\n\n let chunk = match ready!(stream.poll_next(cx)) {\n Some(Ok(ref bytes)) if bytes.is_empty() => continue,\n opt => opt,\n };\n\n return Poll::Ready(chunk);\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use std::{convert::Infallible, time::Duration};\n\n use actix_rt::{\n pin,\n time::{sleep, Sleep},\n };\n use actix_utils::future::poll_fn;\n use derive_more::{Display, Error};\n use futures_core::ready;\n use futures_util::{stream, FutureExt as _};\n use pin_project_lite::pin_project;\n use static_assertions::{assert_impl_all, assert_not_impl_any};\n\n use super::*;\n use crate::body::to_bytes;\n\n assert_impl_all!(BodyStream>>: MessageBody);\n assert_impl_all!(BodyStream>>: MessageBody);\n assert_impl_all!(BodyStream>>: MessageBody);\n assert_impl_all!(BodyStream>>: MessageBody);\n assert_impl_all!(BodyStream>>: MessageBody);\n\n assert_not_impl_any!(BodyStream>: MessageBody);\n assert_not_impl_any!(BodyStream>: MessageBody);\n // crate::Error is not Clone\n assert_not_impl_any!(BodyStream>>: MessageBody);\n\n #[actix_rt::test]\n async fn skips_empty_chunks() {\n let body = BodyStream::new(stream::iter(\n [\"1\", \"\", \"2\"]\n .iter()\n .map(|&v| Ok::<_, Infallible>(Bytes::from(v))),\n ));\n pin!(body);\n\n assert_eq!(\n poll_fn(|cx| body.as_mut().poll_next(cx))\n .await\n .unwrap()\n .ok(),\n Some(Bytes::from(\"1\")),\n );\n assert_eq!(\n poll_fn(|cx| body.as_mut().poll_next(cx))\n .await\n .unwrap()\n .ok(),\n Some(Bytes::from(\"2\")),\n );\n }\n\n #[actix_rt::test]\n async fn read_to_bytes() {\n let body = BodyStream::new(stream::iter(\n [\"1\", \"\", \"2\"]\n .iter()\n .map(|&v| Ok::<_, Infallible>(Bytes::from(v))),\n ));\n\n assert_eq!(to_bytes(body).await.ok(), Some(Bytes::from(\"12\")));\n }\n #[derive(Debug, Display, Error)]\n #[display(\"stream error\")]\n struct StreamErr;\n\n #[actix_rt::test]\n async fn stream_immediate_error() {\n let body = BodyStream::new(stream::once(async { Err(StreamErr) }));\n assert!(matches!(to_bytes(body).await, Err(StreamErr)));\n }\n\n #[actix_rt::test]\n async fn stream_string_error() {\n // `&'static str` does not impl `Error`\n // but it does impl `Into>`\n\n let body = BodyStream::new(stream::once(async { Err(\"stringy error\") }));\n assert!(matches!(to_bytes(body).await, Err(\"stringy error\")));\n }\n\n #[actix_rt::test]\n async fn stream_boxed_error() {\n // `Box` does not impl `Error`\n // but it does impl `Into>`\n\n let body = BodyStream::new(stream::once(async {\n Err(Box::::from(\"stringy error\"))\n }));\n\n assert_eq!(\n to_bytes(body).await.unwrap_err().to_string(),\n \"stringy error\"\n );\n }\n\n #[actix_rt::test]\n async fn stream_delayed_error() {\n let body = BodyStream::new(stream::iter(vec![Ok(Bytes::from(\"1\")), Err(StreamErr)]));\n assert!(matches!(to_bytes(body).await, Err(StreamErr)));\n\n pin_project! {\n #[derive(Debug)]\n #[project = TimeDelayStreamProj]\n enum TimeDelayStream {\n Start,\n Sleep { delay: Pin> },\n Done,\n }\n }\n\n impl Stream for TimeDelayStream {\n type Item = Result;\n\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll> {\n match self.as_mut().get_mut() {\n TimeDelayStream::Start => {\n let sleep = sleep(Duration::from_millis(1));\n self.as_mut().set(TimeDelayStream::Sleep {\n delay: Box::pin(sleep),\n });\n cx.waker().wake_by_ref();\n Poll::Pending\n }\n\n TimeDelayStream::Sleep { ref mut delay } => {\n ready!(delay.poll_unpin(cx));\n self.set(TimeDelayStream::Done);\n cx.waker().wake_by_ref();\n Poll::Pending\n }\n\n TimeDelayStream::Done => Poll::Ready(Some(Err(StreamErr))),\n }\n }\n }\n\n let body = BodyStream::new(TimeDelayStream::Start);\n assert!(matches!(to_bytes(body).await, Err(StreamErr)));\n }\n}\n" }, { "path": "actix-http/src/body/boxed.rs", "content": "use std::{\n error::Error as StdError,\n fmt,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse bytes::Bytes;\n\nuse super::{BodySize, MessageBody, MessageBodyMapErr};\nuse crate::body;\n\n/// A boxed message body with boxed errors.\n#[derive(Debug)]\npub struct BoxBody(BoxBodyInner);\n\nenum BoxBodyInner {\n None(body::None),\n Bytes(Bytes),\n Stream(Pin>>>),\n}\n\nimpl fmt::Debug for BoxBodyInner {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n match self {\n Self::None(arg0) => f.debug_tuple(\"None\").field(arg0).finish(),\n Self::Bytes(arg0) => f.debug_tuple(\"Bytes\").field(arg0).finish(),\n Self::Stream(_) => f.debug_tuple(\"Stream\").field(&\"dyn MessageBody\").finish(),\n }\n }\n}\n\nimpl BoxBody {\n /// Boxes body type, erasing type information.\n ///\n /// If the body type to wrap is unknown or generic it is better to use [`MessageBody::boxed`] to\n /// avoid double boxing.\n #[inline]\n pub fn new(body: B) -> Self\n where\n B: MessageBody + 'static,\n {\n match body.size() {\n BodySize::None => Self(BoxBodyInner::None(body::None)),\n _ => match body.try_into_bytes() {\n Ok(bytes) => Self(BoxBodyInner::Bytes(bytes)),\n Err(body) => {\n let body = MessageBodyMapErr::new(body, Into::into);\n Self(BoxBodyInner::Stream(Box::pin(body)))\n }\n },\n }\n }\n\n /// Returns a mutable pinned reference to the inner message body type.\n #[inline]\n pub fn as_pin_mut(&mut self) -> Pin<&mut Self> {\n Pin::new(self)\n }\n}\n\nimpl MessageBody for BoxBody {\n type Error = Box;\n\n #[inline]\n fn size(&self) -> BodySize {\n match &self.0 {\n BoxBodyInner::None(none) => none.size(),\n BoxBodyInner::Bytes(bytes) => bytes.size(),\n BoxBodyInner::Stream(stream) => stream.size(),\n }\n }\n\n #[inline]\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n match &mut self.0 {\n BoxBodyInner::None(body) => Pin::new(body).poll_next(cx).map_err(|err| match err {}),\n BoxBodyInner::Bytes(body) => Pin::new(body).poll_next(cx).map_err(|err| match err {}),\n BoxBodyInner::Stream(body) => Pin::new(body).poll_next(cx),\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n match self.0 {\n BoxBodyInner::None(body) => Ok(body.try_into_bytes().unwrap()),\n BoxBodyInner::Bytes(body) => Ok(body.try_into_bytes().unwrap()),\n _ => Err(self),\n }\n }\n\n #[inline]\n fn boxed(self) -> BoxBody {\n self\n }\n}\n\n#[cfg(test)]\nmod tests {\n use static_assertions::{assert_impl_all, assert_not_impl_any};\n\n use super::*;\n use crate::body::to_bytes;\n\n assert_impl_all!(BoxBody: fmt::Debug, MessageBody, Unpin);\n assert_not_impl_any!(BoxBody: Send, Sync);\n\n #[actix_rt::test]\n async fn nested_boxed_body() {\n let body = Bytes::from_static(&[1, 2, 3]);\n let boxed_body = BoxBody::new(BoxBody::new(body));\n\n assert_eq!(\n to_bytes(boxed_body).await.unwrap(),\n Bytes::from(vec![1, 2, 3]),\n );\n }\n}\n" }, { "path": "actix-http/src/body/either.rs", "content": "use std::{\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse bytes::Bytes;\nuse pin_project_lite::pin_project;\n\nuse super::{BodySize, BoxBody, MessageBody};\nuse crate::Error;\n\npin_project! {\n /// An \"either\" type specialized for body types.\n ///\n /// It is common, in middleware especially, to conditionally return an inner service's unknown/\n /// generic body `B` type or return early with a new response. This type's \"right\" variant\n /// defaults to `BoxBody` since error responses are the common case.\n ///\n /// For example, middleware will often have `type Response = ServiceResponse>`.\n /// This means that the inner service's response body type maps to the `Left` variant and the\n /// middleware's own error responses use the default `Right` variant of `BoxBody`. Of course,\n /// there's no reason it couldn't use `EitherBody` instead if its alternative\n /// responses have a known type.\n #[project = EitherBodyProj]\n #[derive(Debug, Clone)]\n pub enum EitherBody {\n /// A body of type `L`.\n Left { #[pin] body: L },\n\n /// A body of type `R`.\n Right { #[pin] body: R },\n }\n}\n\nimpl EitherBody {\n /// Creates new `EitherBody` left variant with a boxed right variant.\n ///\n /// If the expected `R` type will be inferred and is not `BoxBody` then use the\n /// [`left`](Self::left) constructor instead.\n #[inline]\n pub fn new(body: L) -> Self {\n Self::Left { body }\n }\n}\n\nimpl EitherBody {\n /// Creates new `EitherBody` using left variant.\n #[inline]\n pub fn left(body: L) -> Self {\n Self::Left { body }\n }\n\n /// Creates new `EitherBody` using right variant.\n #[inline]\n pub fn right(body: R) -> Self {\n Self::Right { body }\n }\n}\n\nimpl MessageBody for EitherBody\nwhere\n L: MessageBody + 'static,\n R: MessageBody + 'static,\n{\n type Error = Error;\n\n #[inline]\n fn size(&self) -> BodySize {\n match self {\n EitherBody::Left { body } => body.size(),\n EitherBody::Right { body } => body.size(),\n }\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n match self.project() {\n EitherBodyProj::Left { body } => body\n .poll_next(cx)\n .map_err(|err| Error::new_body().with_cause(err)),\n EitherBodyProj::Right { body } => body\n .poll_next(cx)\n .map_err(|err| Error::new_body().with_cause(err)),\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n match self {\n EitherBody::Left { body } => body\n .try_into_bytes()\n .map_err(|body| EitherBody::Left { body }),\n EitherBody::Right { body } => body\n .try_into_bytes()\n .map_err(|body| EitherBody::Right { body }),\n }\n }\n\n #[inline]\n fn boxed(self) -> BoxBody {\n match self {\n EitherBody::Left { body } => body.boxed(),\n EitherBody::Right { body } => body.boxed(),\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n\n #[test]\n fn type_parameter_inference() {\n let _body: EitherBody<(), _> = EitherBody::new(());\n\n let _body: EitherBody<_, ()> = EitherBody::left(());\n let _body: EitherBody<(), _> = EitherBody::right(());\n }\n}\n" }, { "path": "actix-http/src/body/message_body.rs", "content": "//! [`MessageBody`] trait and foreign implementations.\n\nuse std::{\n convert::Infallible,\n error::Error as StdError,\n mem,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse bytes::{Bytes, BytesMut};\nuse futures_core::ready;\nuse pin_project_lite::pin_project;\n\nuse super::{BodySize, BoxBody};\n\n/// An interface for types that can be used as a response body.\n///\n/// It is not usually necessary to create custom body types, this trait is already [implemented for\n/// a large number of sensible body types](#foreign-impls) including:\n/// - Empty body: `()`\n/// - Text-based: `String`, `&'static str`, [`ByteString`](https://docs.rs/bytestring/1).\n/// - Byte-based: `Bytes`, `BytesMut`, `Vec`, `&'static [u8]`;\n/// - Streams: [`BodyStream`](super::BodyStream), [`SizedStream`](super::SizedStream)\n///\n/// # Examples\n/// ```\n/// # use std::convert::Infallible;\n/// # use std::task::{Poll, Context};\n/// # use std::pin::Pin;\n/// # use bytes::Bytes;\n/// # use actix_http::body::{BodySize, MessageBody};\n/// struct Repeat {\n/// chunk: String,\n/// n_times: usize,\n/// }\n///\n/// impl MessageBody for Repeat {\n/// type Error = Infallible;\n///\n/// fn size(&self) -> BodySize {\n/// BodySize::Sized((self.chunk.len() * self.n_times) as u64)\n/// }\n///\n/// fn poll_next(\n/// self: Pin<&mut Self>,\n/// _cx: &mut Context<'_>,\n/// ) -> Poll>> {\n/// let payload_string = self.chunk.repeat(self.n_times);\n/// let payload_bytes = Bytes::from(payload_string);\n/// Poll::Ready(Some(Ok(payload_bytes)))\n/// }\n/// }\n/// ```\npub trait MessageBody {\n /// The type of error that will be returned if streaming body fails.\n ///\n /// Since it is not appropriate to generate a response mid-stream, it only requires `Error` for\n /// internal use and logging.\n type Error: Into>;\n\n /// Body size hint.\n ///\n /// If [`BodySize::None`] is returned, optimizations that skip reading the body are allowed.\n fn size(&self) -> BodySize;\n\n /// Attempt to pull out the next chunk of body bytes.\n ///\n /// # Return Value\n /// Similar to the `Stream` interface, there are several possible return values, each indicating\n /// a distinct state:\n /// - `Poll::Pending` means that this body's next chunk is not ready yet. Implementations must\n /// ensure that the current task will be notified when the next chunk may be ready.\n /// - `Poll::Ready(Some(val))` means that the body has successfully produced a chunk, `val`,\n /// and may produce further values on subsequent `poll_next` calls.\n /// - `Poll::Ready(None)` means that the body is complete, and `poll_next` should not be\n /// invoked again.\n ///\n /// # Panics\n /// Once a body is complete (i.e., `poll_next` returned `Ready(None)`), calling its `poll_next`\n /// method again may panic, block forever, or cause other kinds of problems; this trait places\n /// no requirements on the effects of such a call. However, as the `poll_next` method is not\n /// marked unsafe, Rust’s usual rules apply: calls must never cause UB, regardless of its state.\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>>;\n\n /// Try to convert into the complete chunk of body bytes.\n ///\n /// Override this method if the complete body can be trivially extracted. This is useful for\n /// optimizations where `poll_next` calls can be avoided.\n ///\n /// Body types with [`BodySize::None`] are allowed to return empty `Bytes`. Although, if calling\n /// this method, it is recommended to check `size` first and return early.\n ///\n /// # Errors\n /// The default implementation will error and return the original type back to the caller for\n /// further use.\n #[inline]\n fn try_into_bytes(self) -> Result\n where\n Self: Sized,\n {\n Err(self)\n }\n\n /// Wraps this body into a `BoxBody`.\n ///\n /// No-op when called on a `BoxBody`, meaning there is no risk of double boxing when calling\n /// this on a generic `MessageBody`. Prefer this over [`BoxBody::new`] when a boxed body\n /// is required.\n #[inline]\n fn boxed(self) -> BoxBody\n where\n Self: Sized + 'static,\n {\n BoxBody::new(self)\n }\n}\n\nmod foreign_impls {\n use std::{borrow::Cow, ops::DerefMut};\n\n use super::*;\n\n impl MessageBody for &mut B\n where\n B: MessageBody + Unpin + ?Sized,\n {\n type Error = B::Error;\n\n fn size(&self) -> BodySize {\n (**self).size()\n }\n\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n Pin::new(&mut **self).poll_next(cx)\n }\n }\n\n impl MessageBody for Infallible {\n type Error = Infallible;\n\n fn size(&self) -> BodySize {\n match *self {}\n }\n\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n match *self {}\n }\n }\n\n impl MessageBody for () {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(0)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n Poll::Ready(None)\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(Bytes::new())\n }\n }\n\n impl MessageBody for Box\n where\n B: MessageBody + Unpin + ?Sized,\n {\n type Error = B::Error;\n\n #[inline]\n fn size(&self) -> BodySize {\n self.as_ref().size()\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n Pin::new(self.get_mut().as_mut()).poll_next(cx)\n }\n }\n\n impl MessageBody for Pin\n where\n T: DerefMut + Unpin,\n B: MessageBody + ?Sized,\n {\n type Error = B::Error;\n\n #[inline]\n fn size(&self) -> BodySize {\n self.as_ref().size()\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n self.get_mut().as_mut().poll_next(cx)\n }\n }\n\n impl MessageBody for &'static [u8] {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n Poll::Ready(Some(Ok(Bytes::from_static(mem::take(self.get_mut())))))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(Bytes::from_static(self))\n }\n }\n\n impl MessageBody for Bytes {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n Poll::Ready(Some(Ok(mem::take(self.get_mut()))))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(self)\n }\n }\n\n impl MessageBody for BytesMut {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n Poll::Ready(Some(Ok(mem::take(self.get_mut()).freeze())))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(self.freeze())\n }\n }\n\n impl MessageBody for Vec {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n Poll::Ready(Some(Ok(mem::take(self.get_mut()).into())))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(Bytes::from(self))\n }\n }\n\n impl MessageBody for Cow<'static, [u8]> {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n let bytes = match mem::take(self.get_mut()) {\n Cow::Borrowed(b) => Bytes::from_static(b),\n Cow::Owned(b) => Bytes::from(b),\n };\n Poll::Ready(Some(Ok(bytes)))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n match self {\n Cow::Borrowed(b) => Ok(Bytes::from_static(b)),\n Cow::Owned(b) => Ok(Bytes::from(b)),\n }\n }\n }\n\n impl MessageBody for &'static str {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n let string = mem::take(self.get_mut());\n let bytes = Bytes::from_static(string.as_bytes());\n Poll::Ready(Some(Ok(bytes)))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(Bytes::from_static(self.as_bytes()))\n }\n }\n\n impl MessageBody for String {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n let string = mem::take(self.get_mut());\n Poll::Ready(Some(Ok(Bytes::from(string))))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(Bytes::from(self))\n }\n }\n\n impl MessageBody for Cow<'static, str> {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n if self.is_empty() {\n Poll::Ready(None)\n } else {\n let bytes = match mem::take(self.get_mut()) {\n Cow::Borrowed(s) => Bytes::from_static(s.as_bytes()),\n Cow::Owned(s) => Bytes::from(s.into_bytes()),\n };\n Poll::Ready(Some(Ok(bytes)))\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n match self {\n Cow::Borrowed(s) => Ok(Bytes::from_static(s.as_bytes())),\n Cow::Owned(s) => Ok(Bytes::from(s.into_bytes())),\n }\n }\n }\n\n impl MessageBody for bytestring::ByteString {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.len() as u64)\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n let string = mem::take(self.get_mut());\n Poll::Ready(Some(Ok(string.into_bytes())))\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(self.into_bytes())\n }\n }\n}\n\npin_project! {\n pub(crate) struct MessageBodyMapErr {\n #[pin]\n body: B,\n mapper: Option,\n }\n}\n\nimpl MessageBodyMapErr\nwhere\n B: MessageBody,\n F: FnOnce(B::Error) -> E,\n{\n pub(crate) fn new(body: B, mapper: F) -> Self {\n Self {\n body,\n mapper: Some(mapper),\n }\n }\n}\n\nimpl MessageBody for MessageBodyMapErr\nwhere\n B: MessageBody,\n F: FnOnce(B::Error) -> E,\n E: Into>,\n{\n type Error = E;\n\n #[inline]\n fn size(&self) -> BodySize {\n self.body.size()\n }\n\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n let this = self.as_mut().project();\n\n match ready!(this.body.poll_next(cx)) {\n Some(Err(err)) => {\n let f = self.as_mut().project().mapper.take().unwrap();\n let mapped_err = (f)(err);\n Poll::Ready(Some(Err(mapped_err)))\n }\n Some(Ok(val)) => Poll::Ready(Some(Ok(val))),\n None => Poll::Ready(None),\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n let Self { body, mapper } = self;\n body.try_into_bytes().map_err(|body| Self { body, mapper })\n }\n}\n\n#[cfg(test)]\nmod tests {\n use actix_rt::pin;\n use actix_utils::future::poll_fn;\n use futures_util::stream;\n\n use super::*;\n use crate::body::{self, EitherBody};\n\n macro_rules! assert_poll_next {\n ($pin:expr, $exp:expr) => {\n assert_eq!(\n poll_fn(|cx| $pin.as_mut().poll_next(cx))\n .await\n .unwrap() // unwrap option\n .unwrap(), // unwrap result\n $exp\n );\n };\n }\n\n macro_rules! assert_poll_next_none {\n ($pin:expr) => {\n assert!(poll_fn(|cx| $pin.as_mut().poll_next(cx)).await.is_none());\n };\n }\n\n #[allow(unused_allocation)] // triggered by `Box::new(()).size()`\n #[actix_rt::test]\n async fn boxing_equivalence() {\n assert_eq!(().size(), BodySize::Sized(0));\n assert_eq!(().size(), Box::new(()).size());\n assert_eq!(().size(), Box::pin(()).size());\n\n let pl = Box::new(());\n pin!(pl);\n assert_poll_next_none!(pl);\n\n let mut pl = Box::pin(());\n assert_poll_next_none!(pl);\n }\n\n #[actix_rt::test]\n async fn mut_equivalence() {\n assert_eq!(().size(), BodySize::Sized(0));\n assert_eq!(().size(), (&(&mut ())).size());\n\n let pl = &mut ();\n pin!(pl);\n assert_poll_next_none!(pl);\n\n let pl = &mut Box::new(());\n pin!(pl);\n assert_poll_next_none!(pl);\n\n let mut body = body::SizedStream::new(\n 8,\n stream::iter([\n Ok::<_, std::io::Error>(Bytes::from(\"1234\")),\n Ok(Bytes::from(\"5678\")),\n ]),\n );\n let body = &mut body;\n assert_eq!(body.size(), BodySize::Sized(8));\n pin!(body);\n assert_poll_next!(body, Bytes::from_static(b\"1234\"));\n assert_poll_next!(body, Bytes::from_static(b\"5678\"));\n assert_poll_next_none!(body);\n }\n\n #[allow(clippy::let_unit_value)]\n #[actix_rt::test]\n async fn test_unit() {\n let pl = ();\n assert_eq!(pl.size(), BodySize::Sized(0));\n pin!(pl);\n assert_poll_next_none!(pl);\n }\n\n #[actix_rt::test]\n async fn test_static_str() {\n assert_eq!(\"\".size(), BodySize::Sized(0));\n assert_eq!(\"test\".size(), BodySize::Sized(4));\n\n let pl = \"test\";\n pin!(pl);\n assert_poll_next!(pl, Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn test_static_bytes() {\n assert_eq!(b\"\".as_ref().size(), BodySize::Sized(0));\n assert_eq!(b\"test\".as_ref().size(), BodySize::Sized(4));\n\n let pl = b\"test\".as_ref();\n pin!(pl);\n assert_poll_next!(pl, Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn test_vec() {\n assert_eq!(vec![0; 0].size(), BodySize::Sized(0));\n assert_eq!(Vec::from(\"test\").size(), BodySize::Sized(4));\n\n let pl = Vec::from(\"test\");\n pin!(pl);\n assert_poll_next!(pl, Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn test_bytes() {\n assert_eq!(Bytes::new().size(), BodySize::Sized(0));\n assert_eq!(Bytes::from_static(b\"test\").size(), BodySize::Sized(4));\n\n let pl = Bytes::from_static(b\"test\");\n pin!(pl);\n assert_poll_next!(pl, Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn test_bytes_mut() {\n assert_eq!(BytesMut::new().size(), BodySize::Sized(0));\n assert_eq!(BytesMut::from(b\"test\".as_ref()).size(), BodySize::Sized(4));\n\n let pl = BytesMut::from(\"test\");\n pin!(pl);\n assert_poll_next!(pl, Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn test_string() {\n assert_eq!(String::new().size(), BodySize::Sized(0));\n assert_eq!(\"test\".to_owned().size(), BodySize::Sized(4));\n\n let pl = \"test\".to_owned();\n pin!(pl);\n assert_poll_next!(pl, Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn complete_body_combinators() {\n let body = Bytes::from_static(b\"test\");\n let body = BoxBody::new(body);\n let body = EitherBody::<_, ()>::left(body);\n let body = EitherBody::<(), _>::right(body);\n // Do not support try_into_bytes:\n // let body = Box::new(body);\n // let body = Box::pin(body);\n\n assert_eq!(body.try_into_bytes().unwrap(), Bytes::from(\"test\"));\n }\n\n #[actix_rt::test]\n async fn complete_body_combinators_poll() {\n let body = Bytes::from_static(b\"test\");\n let body = BoxBody::new(body);\n let body = EitherBody::<_, ()>::left(body);\n let body = EitherBody::<(), _>::right(body);\n let mut body = body;\n\n assert_eq!(body.size(), BodySize::Sized(4));\n assert_poll_next!(Pin::new(&mut body), Bytes::from(\"test\"));\n assert_poll_next_none!(Pin::new(&mut body));\n }\n\n #[actix_rt::test]\n async fn none_body_combinators() {\n fn none_body() -> BoxBody {\n let body = body::None;\n let body = BoxBody::new(body);\n let body = EitherBody::<_, ()>::left(body);\n let body = EitherBody::<(), _>::right(body);\n body.boxed()\n }\n\n assert_eq!(none_body().size(), BodySize::None);\n assert_eq!(none_body().try_into_bytes().unwrap(), Bytes::new());\n assert_poll_next_none!(Pin::new(&mut none_body()));\n }\n\n // down-casting used to be done with a method on MessageBody trait\n // test is kept to demonstrate equivalence of Any trait\n #[actix_rt::test]\n async fn test_body_casting() {\n let mut body = String::from(\"hello cast\");\n // let mut resp_body: &mut dyn MessageBody = &mut body;\n let resp_body: &mut dyn std::any::Any = &mut body;\n let body = resp_body.downcast_ref::().unwrap();\n assert_eq!(body, \"hello cast\");\n let body = &mut resp_body.downcast_mut::().unwrap();\n body.push('!');\n let body = resp_body.downcast_ref::().unwrap();\n assert_eq!(body, \"hello cast!\");\n let not_body = resp_body.downcast_ref::<()>();\n assert!(not_body.is_none());\n }\n\n #[actix_rt::test]\n async fn non_owning_to_bytes() {\n let mut body = BoxBody::new(());\n let bytes = body::to_bytes(&mut body).await.unwrap();\n assert_eq!(bytes, Bytes::new());\n\n let mut body = body::BodyStream::new(stream::iter([\n Ok::<_, std::io::Error>(Bytes::from(\"1234\")),\n Ok(Bytes::from(\"5678\")),\n ]));\n let bytes = body::to_bytes(&mut body).await.unwrap();\n assert_eq!(bytes, Bytes::from_static(b\"12345678\"));\n }\n}\n" }, { "path": "actix-http/src/body/mod.rs", "content": "//! Traits and structures to aid consuming and writing HTTP payloads.\n//!\n//! \"Body\" and \"payload\" are used somewhat interchangeably in this documentation.\n\n// Though the spec kinda reads like \"payload\" is the possibly-transfer-encoded part of the message\n// and the \"body\" is the intended possibly-decoded version of that.\n\nmod body_stream;\nmod boxed;\nmod either;\nmod message_body;\nmod none;\nmod size;\nmod sized_stream;\nmod utils;\n\npub(crate) use self::message_body::MessageBodyMapErr;\npub use self::{\n body_stream::BodyStream,\n boxed::BoxBody,\n either::EitherBody,\n message_body::MessageBody,\n none::None,\n size::BodySize,\n sized_stream::SizedStream,\n utils::{to_bytes, to_bytes_limited, BodyLimitExceeded},\n};\n" }, { "path": "actix-http/src/body/none.rs", "content": "use std::{\n convert::Infallible,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse bytes::Bytes;\n\nuse super::{BodySize, MessageBody};\n\n/// Body type for responses that forbid payloads.\n///\n/// This is distinct from an \"empty\" response which _would_ contain a `Content-Length` header.\n/// For an \"empty\" body, use `()` or `Bytes::new()`.\n///\n/// For example, the HTTP spec forbids a payload to be sent with a `204 No Content` response.\n/// In this case, the payload (or lack thereof) is implicit from the status code, so a\n/// `Content-Length` header is not required.\n#[derive(Debug, Clone, Copy, Default)]\n#[non_exhaustive]\npub struct None;\n\nimpl None {\n /// Constructs new \"none\" body.\n #[inline]\n pub fn new() -> Self {\n None\n }\n}\n\nimpl MessageBody for None {\n type Error = Infallible;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::None\n }\n\n #[inline]\n fn poll_next(\n self: Pin<&mut Self>,\n _cx: &mut Context<'_>,\n ) -> Poll>> {\n Poll::Ready(Option::None)\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result {\n Ok(Bytes::new())\n }\n}\n" }, { "path": "actix-http/src/body/size.rs", "content": "/// Body size hint.\n#[derive(Debug, Clone, Copy, PartialEq, Eq)]\npub enum BodySize {\n /// Implicitly empty body.\n ///\n /// Will omit the Content-Length header. Used for responses to certain methods (e.g., `HEAD`) or\n /// with particular status codes (e.g., 204 No Content). Consumers that read this as a body size\n /// hint are allowed to make optimizations that skip reading or writing the payload.\n None,\n\n /// Known size body.\n ///\n /// Will write `Content-Length: N` header.\n Sized(u64),\n\n /// Unknown size body.\n ///\n /// Will not write Content-Length header. Can be used with chunked Transfer-Encoding.\n Stream,\n}\n\nimpl BodySize {\n /// Equivalent to `BodySize::Sized(0)`;\n pub const ZERO: Self = Self::Sized(0);\n\n /// Returns true if size hint indicates omitted or empty body.\n ///\n /// Streams will return false because it cannot be known without reading the stream.\n ///\n /// ```\n /// # use actix_http::body::BodySize;\n /// assert!(BodySize::None.is_eof());\n /// assert!(BodySize::Sized(0).is_eof());\n ///\n /// assert!(!BodySize::Sized(64).is_eof());\n /// assert!(!BodySize::Stream.is_eof());\n /// ```\n pub fn is_eof(&self) -> bool {\n matches!(self, BodySize::None | BodySize::Sized(0))\n }\n}\n" }, { "path": "actix-http/src/body/sized_stream.rs", "content": "use std::{\n error::Error as StdError,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse bytes::Bytes;\nuse futures_core::{ready, Stream};\nuse pin_project_lite::pin_project;\n\nuse super::{BodySize, MessageBody};\n\npin_project! {\n /// Known sized streaming response wrapper.\n ///\n /// This body implementation should be used if total size of stream is known. Data is sent as-is\n /// without using chunked transfer encoding.\n pub struct SizedStream {\n size: u64,\n #[pin]\n stream: S,\n }\n}\n\nimpl SizedStream\nwhere\n S: Stream>,\n E: Into> + 'static,\n{\n #[inline]\n pub fn new(size: u64, stream: S) -> Self {\n SizedStream { size, stream }\n }\n}\n\n// TODO: from_infallible method\n\nimpl MessageBody for SizedStream\nwhere\n S: Stream>,\n E: Into> + 'static,\n{\n type Error = E;\n\n #[inline]\n fn size(&self) -> BodySize {\n BodySize::Sized(self.size)\n }\n\n /// Attempts to pull out the next value of the underlying [`Stream`].\n ///\n /// Empty values are skipped to prevent [`SizedStream`]'s transmission being\n /// ended on a zero-length chunk, but rather proceed until the underlying\n /// [`Stream`] ends.\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n loop {\n let stream = self.as_mut().project().stream;\n\n let chunk = match ready!(stream.poll_next(cx)) {\n Some(Ok(ref bytes)) if bytes.is_empty() => continue,\n val => val,\n };\n\n return Poll::Ready(chunk);\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use std::convert::Infallible;\n\n use actix_rt::pin;\n use actix_utils::future::poll_fn;\n use futures_util::stream;\n use static_assertions::{assert_impl_all, assert_not_impl_any};\n\n use super::*;\n use crate::body::to_bytes;\n\n assert_impl_all!(SizedStream>>: MessageBody);\n assert_impl_all!(SizedStream>>: MessageBody);\n assert_impl_all!(SizedStream>>: MessageBody);\n assert_impl_all!(SizedStream>>: MessageBody);\n assert_impl_all!(SizedStream>>: MessageBody);\n\n assert_not_impl_any!(SizedStream>: MessageBody);\n assert_not_impl_any!(SizedStream>: MessageBody);\n // crate::Error is not Clone\n assert_not_impl_any!(SizedStream>>: MessageBody);\n\n #[actix_rt::test]\n async fn skips_empty_chunks() {\n let body = SizedStream::new(\n 2,\n stream::iter(\n [\"1\", \"\", \"2\"]\n .iter()\n .map(|&v| Ok::<_, Infallible>(Bytes::from(v))),\n ),\n );\n\n pin!(body);\n\n assert_eq!(\n poll_fn(|cx| body.as_mut().poll_next(cx))\n .await\n .unwrap()\n .ok(),\n Some(Bytes::from(\"1\")),\n );\n\n assert_eq!(\n poll_fn(|cx| body.as_mut().poll_next(cx))\n .await\n .unwrap()\n .ok(),\n Some(Bytes::from(\"2\")),\n );\n }\n\n #[actix_rt::test]\n async fn read_to_bytes() {\n let body = SizedStream::new(\n 2,\n stream::iter(\n [\"1\", \"\", \"2\"]\n .iter()\n .map(|&v| Ok::<_, Infallible>(Bytes::from(v))),\n ),\n );\n\n assert_eq!(to_bytes(body).await.ok(), Some(Bytes::from(\"12\")));\n }\n\n #[actix_rt::test]\n async fn stream_string_error() {\n // `&'static str` does not impl `Error`\n // but it does impl `Into>`\n\n let body = SizedStream::new(0, stream::once(async { Err(\"stringy error\") }));\n assert_eq!(to_bytes(body).await, Ok(Bytes::new()));\n\n let body = SizedStream::new(1, stream::once(async { Err(\"stringy error\") }));\n assert!(matches!(to_bytes(body).await, Err(\"stringy error\")));\n }\n\n #[actix_rt::test]\n async fn stream_boxed_error() {\n // `Box` does not impl `Error`\n // but it does impl `Into>`\n\n let body = SizedStream::new(\n 0,\n stream::once(async { Err(Box::::from(\"stringy error\")) }),\n );\n assert_eq!(to_bytes(body).await.unwrap(), Bytes::new());\n\n let body = SizedStream::new(\n 1,\n stream::once(async { Err(Box::::from(\"stringy error\")) }),\n );\n assert_eq!(\n to_bytes(body).await.unwrap_err().to_string(),\n \"stringy error\"\n );\n }\n}\n" }, { "path": "actix-http/src/body/utils.rs", "content": "use std::task::Poll;\n\nuse actix_rt::pin;\nuse actix_utils::future::poll_fn;\nuse bytes::{Bytes, BytesMut};\nuse derive_more::{Display, Error};\nuse futures_core::ready;\n\nuse super::{BodySize, MessageBody};\n\n/// Collects all the bytes produced by `body`.\n///\n/// Any errors produced by the body stream are returned immediately.\n///\n/// Consider using [`to_bytes_limited`] instead to protect against memory exhaustion.\n///\n/// # Examples\n///\n/// ```\n/// use actix_http::body::{self, to_bytes};\n/// use bytes::Bytes;\n///\n/// # actix_rt::System::new().block_on(async {\n/// let body = body::None::new();\n/// let bytes = to_bytes(body).await.unwrap();\n/// assert!(bytes.is_empty());\n///\n/// let body = Bytes::from_static(b\"123\");\n/// let bytes = to_bytes(body).await.unwrap();\n/// assert_eq!(bytes, \"123\");\n/// # });\n/// ```\npub async fn to_bytes(body: B) -> Result {\n to_bytes_limited(body, usize::MAX)\n .await\n .expect(\"body should never yield more than usize::MAX bytes\")\n}\n\n/// Error type returned from [`to_bytes_limited`] when body produced exceeds limit.\n#[derive(Debug, Display, Error)]\n#[display(\"limit exceeded while collecting body bytes\")]\n#[non_exhaustive]\npub struct BodyLimitExceeded;\n\n/// Collects the bytes produced by `body`, up to `limit` bytes.\n///\n/// If a chunk read from `poll_next` causes the total number of bytes read to exceed `limit`, an\n/// `Err(BodyLimitExceeded)` is returned.\n///\n/// Any errors produced by the body stream are returned immediately as `Ok(Err(B::Error))`.\n///\n/// # Examples\n///\n/// ```\n/// use actix_http::body::{self, to_bytes_limited};\n/// use bytes::Bytes;\n///\n/// # actix_rt::System::new().block_on(async {\n/// let body = body::None::new();\n/// let bytes = to_bytes_limited(body, 10).await.unwrap().unwrap();\n/// assert!(bytes.is_empty());\n///\n/// let body = Bytes::from_static(b\"123\");\n/// let bytes = to_bytes_limited(body, 10).await.unwrap().unwrap();\n/// assert_eq!(bytes, \"123\");\n///\n/// let body = Bytes::from_static(b\"123\");\n/// assert!(to_bytes_limited(body, 2).await.is_err());\n/// # });\n/// ```\npub async fn to_bytes_limited(\n body: B,\n limit: usize,\n) -> Result, BodyLimitExceeded> {\n /// Sensible default (32kB) for initial, bounded allocation when collecting body bytes.\n const INITIAL_ALLOC_BYTES: usize = 32 * 1024;\n\n let cap = match body.size() {\n BodySize::None | BodySize::Sized(0) => return Ok(Ok(Bytes::new())),\n BodySize::Sized(size) if size as usize > limit => return Err(BodyLimitExceeded),\n BodySize::Sized(size) => (size as usize).min(INITIAL_ALLOC_BYTES),\n BodySize::Stream => INITIAL_ALLOC_BYTES,\n };\n\n let mut exceeded_limit = false;\n let mut buf = BytesMut::with_capacity(cap);\n\n pin!(body);\n\n match poll_fn(|cx| loop {\n let body = body.as_mut();\n\n match ready!(body.poll_next(cx)) {\n Some(Ok(bytes)) => {\n // if limit is exceeded...\n if buf.len() + bytes.len() > limit {\n // ...set flag to true and break out of poll_fn\n exceeded_limit = true;\n return Poll::Ready(Ok(()));\n }\n\n buf.extend_from_slice(&bytes)\n }\n None => return Poll::Ready(Ok(())),\n Some(Err(err)) => return Poll::Ready(Err(err)),\n }\n })\n .await\n {\n // propagate error returned from body poll\n Err(err) => Ok(Err(err)),\n\n // limit was exceeded while reading body\n Ok(()) if exceeded_limit => Err(BodyLimitExceeded),\n\n // otherwise return body buffer\n Ok(()) => Ok(Ok(buf.freeze())),\n }\n}\n\n#[cfg(test)]\nmod tests {\n use std::io;\n\n use futures_util::{stream, StreamExt as _};\n\n use super::*;\n use crate::{\n body::{BodyStream, SizedStream},\n Error,\n };\n\n #[actix_rt::test]\n async fn to_bytes_complete() {\n let bytes = to_bytes(()).await.unwrap();\n assert!(bytes.is_empty());\n\n let body = Bytes::from_static(b\"123\");\n let bytes = to_bytes(body).await.unwrap();\n assert_eq!(bytes, b\"123\"[..]);\n }\n\n #[actix_rt::test]\n async fn to_bytes_streams() {\n let stream = stream::iter(vec![Bytes::from_static(b\"123\"), Bytes::from_static(b\"abc\")])\n .map(Ok::<_, Error>);\n let body = BodyStream::new(stream);\n let bytes = to_bytes(body).await.unwrap();\n assert_eq!(bytes, b\"123abc\"[..]);\n }\n\n #[actix_rt::test]\n async fn to_bytes_limited_complete() {\n let bytes = to_bytes_limited((), 0).await.unwrap().unwrap();\n assert!(bytes.is_empty());\n\n let bytes = to_bytes_limited((), 1).await.unwrap().unwrap();\n assert!(bytes.is_empty());\n\n assert!(to_bytes_limited(Bytes::from_static(b\"12\"), 0)\n .await\n .is_err());\n assert!(to_bytes_limited(Bytes::from_static(b\"12\"), 1)\n .await\n .is_err());\n assert!(to_bytes_limited(Bytes::from_static(b\"12\"), 2).await.is_ok());\n assert!(to_bytes_limited(Bytes::from_static(b\"12\"), 3).await.is_ok());\n }\n\n #[actix_rt::test]\n async fn to_bytes_limited_streams() {\n // hinting a larger body fails\n let body = SizedStream::new(8, stream::empty().map(Ok::<_, Error>));\n assert!(to_bytes_limited(body, 3).await.is_err());\n\n // hinting a smaller body is okay\n let body = SizedStream::new(3, stream::empty().map(Ok::<_, Error>));\n assert!(to_bytes_limited(body, 3).await.unwrap().unwrap().is_empty());\n\n // hinting a smaller body then returning a larger one fails\n let stream = stream::iter(vec![Bytes::from_static(b\"1234\")]).map(Ok::<_, Error>);\n let body = SizedStream::new(3, stream);\n assert!(to_bytes_limited(body, 3).await.is_err());\n\n let stream = stream::iter(vec![Bytes::from_static(b\"123\"), Bytes::from_static(b\"abc\")])\n .map(Ok::<_, Error>);\n let body = BodyStream::new(stream);\n assert!(to_bytes_limited(body, 3).await.is_err());\n }\n\n #[actix_rt::test]\n async fn to_body_limit_error() {\n let err_stream = stream::once(async { Err(io::Error::other(\"\")) });\n let body = SizedStream::new(8, err_stream);\n // not too big, but propagates error from body stream\n assert!(to_bytes_limited(body, 10).await.unwrap().is_err());\n }\n}\n" }, { "path": "actix-http/src/builder.rs", "content": "use std::{fmt, marker::PhantomData, net, rc::Rc, time::Duration};\n\nuse actix_codec::Framed;\nuse actix_service::{IntoServiceFactory, Service, ServiceFactory};\n\nuse crate::{\n body::{BoxBody, MessageBody},\n config::{DEFAULT_H2_CONN_WINDOW_SIZE, DEFAULT_H2_STREAM_WINDOW_SIZE},\n h1::{self, ExpectHandler, H1Service, UpgradeHandler},\n service::HttpService,\n ConnectCallback, Extensions, KeepAlive, Request, Response, ServiceConfigBuilder,\n};\n\n/// An HTTP service builder.\n///\n/// This type can construct an instance of [`HttpService`] through a builder-like pattern.\npub struct HttpServiceBuilder {\n keep_alive: KeepAlive,\n client_request_timeout: Duration,\n client_disconnect_timeout: Duration,\n tcp_nodelay: Option,\n secure: bool,\n local_addr: Option,\n h1_allow_half_closed: bool,\n h2_conn_window_size: u32,\n h2_stream_window_size: u32,\n expect: X,\n upgrade: Option,\n on_connect_ext: Option>>,\n _phantom: PhantomData,\n}\n\nimpl Default for HttpServiceBuilder\nwhere\n S: ServiceFactory,\n S::Error: Into> + 'static,\n S::InitError: fmt::Debug,\n >::Future: 'static,\n{\n fn default() -> Self {\n HttpServiceBuilder {\n // ServiceConfig parts (make sure defaults match)\n keep_alive: KeepAlive::default(),\n client_request_timeout: Duration::from_secs(5),\n client_disconnect_timeout: Duration::ZERO,\n tcp_nodelay: None,\n secure: false,\n local_addr: None,\n h1_allow_half_closed: true,\n h2_conn_window_size: DEFAULT_H2_CONN_WINDOW_SIZE,\n h2_stream_window_size: DEFAULT_H2_STREAM_WINDOW_SIZE,\n\n // dispatcher parts\n expect: ExpectHandler,\n upgrade: None,\n on_connect_ext: None,\n _phantom: PhantomData,\n }\n }\n}\n\nimpl HttpServiceBuilder\nwhere\n S: ServiceFactory,\n S::Error: Into> + 'static,\n S::InitError: fmt::Debug,\n >::Future: 'static,\n X: ServiceFactory,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n U: ServiceFactory<(Request, Framed), Config = (), Response = ()>,\n U::Error: fmt::Display,\n U::InitError: fmt::Debug,\n{\n /// Set connection keep-alive setting.\n ///\n /// Applies to HTTP/1.1 keep-alive and HTTP/2 ping-pong.\n ///\n /// By default keep-alive is 5 seconds.\n pub fn keep_alive>(mut self, val: W) -> Self {\n self.keep_alive = val.into();\n self\n }\n\n /// Set connection secure state\n pub fn secure(mut self) -> Self {\n self.secure = true;\n self\n }\n\n /// Set the local address that this service is bound to.\n pub fn local_addr(mut self, addr: net::SocketAddr) -> Self {\n self.local_addr = Some(addr);\n self\n }\n\n /// Set client request timeout (for first request).\n ///\n /// Defines a timeout for reading client request header. If the client does not transmit the\n /// request head within this duration, the connection is terminated with a `408 Request Timeout`\n /// response error.\n ///\n /// A duration of zero disables the timeout.\n ///\n /// By default, the client timeout is 5 seconds.\n pub fn client_request_timeout(mut self, dur: Duration) -> Self {\n self.client_request_timeout = dur;\n self\n }\n\n #[doc(hidden)]\n #[deprecated(since = \"3.0.0\", note = \"Renamed to `client_request_timeout`.\")]\n pub fn client_timeout(self, dur: Duration) -> Self {\n self.client_request_timeout(dur)\n }\n\n /// Set client connection disconnect timeout.\n ///\n /// Defines a timeout for disconnect connection. If a disconnect procedure does not complete\n /// within this time, the request get dropped. This timeout affects secure connections.\n ///\n /// A duration of zero disables the timeout.\n ///\n /// By default, the disconnect timeout is disabled.\n pub fn client_disconnect_timeout(mut self, dur: Duration) -> Self {\n self.client_disconnect_timeout = dur;\n self\n }\n\n /// Sets `TCP_NODELAY` value on accepted TCP connections.\n pub fn tcp_nodelay(mut self, nodelay: bool) -> Self {\n self.tcp_nodelay = Some(nodelay);\n self\n }\n\n #[doc(hidden)]\n #[deprecated(since = \"3.0.0\", note = \"Renamed to `client_disconnect_timeout`.\")]\n pub fn client_disconnect(self, dur: Duration) -> Self {\n self.client_disconnect_timeout(dur)\n }\n\n /// Sets whether HTTP/1 connections should support half-closures.\n ///\n /// Clients can choose to shutdown their writer-side of the connection after completing their\n /// request and while waiting for the server response. Setting this to `false` will cause the\n /// server to abort the connection handling as soon as it detects an EOF from the client.\n ///\n /// The default behavior is to allow, i.e. `true`\n pub fn h1_allow_half_closed(mut self, allow: bool) -> Self {\n self.h1_allow_half_closed = allow;\n self\n }\n\n /// Sets initial stream-level flow control window size for HTTP/2 connections.\n ///\n /// See [`ServiceConfigBuilder::h2_initial_window_size`] for more details.\n pub fn h2_initial_window_size(mut self, size: u32) -> Self {\n self.h2_stream_window_size = size;\n self\n }\n\n /// Sets initial connection-level flow control window size for HTTP/2 connections.\n ///\n /// See [`ServiceConfigBuilder::h2_initial_connection_window_size`] for more details.\n pub fn h2_initial_connection_window_size(mut self, size: u32) -> Self {\n self.h2_conn_window_size = size;\n self\n }\n\n /// Provide service for `EXPECT: 100-Continue` support.\n ///\n /// Service get called with request that contains `EXPECT` header.\n /// Service must return request in case of success, in that case\n /// request will be forwarded to main service.\n pub fn expect(self, expect: F) -> HttpServiceBuilder\n where\n F: IntoServiceFactory,\n X1: ServiceFactory,\n X1::Error: Into>,\n X1::InitError: fmt::Debug,\n {\n HttpServiceBuilder {\n keep_alive: self.keep_alive,\n client_request_timeout: self.client_request_timeout,\n client_disconnect_timeout: self.client_disconnect_timeout,\n tcp_nodelay: self.tcp_nodelay,\n secure: self.secure,\n local_addr: self.local_addr,\n h1_allow_half_closed: self.h1_allow_half_closed,\n h2_conn_window_size: self.h2_conn_window_size,\n h2_stream_window_size: self.h2_stream_window_size,\n expect: expect.into_factory(),\n upgrade: self.upgrade,\n on_connect_ext: self.on_connect_ext,\n _phantom: PhantomData,\n }\n }\n\n /// Provide service for custom `Connection: UPGRADE` support.\n ///\n /// If service is provided then normal requests handling get halted\n /// and this service get called with original request and framed object.\n pub fn upgrade(self, upgrade: F) -> HttpServiceBuilder\n where\n F: IntoServiceFactory)>,\n U1: ServiceFactory<(Request, Framed), Config = (), Response = ()>,\n U1::Error: fmt::Display,\n U1::InitError: fmt::Debug,\n {\n HttpServiceBuilder {\n keep_alive: self.keep_alive,\n client_request_timeout: self.client_request_timeout,\n client_disconnect_timeout: self.client_disconnect_timeout,\n tcp_nodelay: self.tcp_nodelay,\n secure: self.secure,\n local_addr: self.local_addr,\n h1_allow_half_closed: self.h1_allow_half_closed,\n h2_conn_window_size: self.h2_conn_window_size,\n h2_stream_window_size: self.h2_stream_window_size,\n expect: self.expect,\n upgrade: Some(upgrade.into_factory()),\n on_connect_ext: self.on_connect_ext,\n _phantom: PhantomData,\n }\n }\n\n /// Sets the callback to be run on connection establishment.\n ///\n /// Has mutable access to a data container that will be merged into request extensions.\n /// This enables transport layer data (like client certificates) to be accessed in middleware\n /// and handlers.\n pub fn on_connect_ext(mut self, f: F) -> Self\n where\n F: Fn(&T, &mut Extensions) + 'static,\n {\n self.on_connect_ext = Some(Rc::new(f));\n self\n }\n\n /// Finish service configuration and create a service for the HTTP/1 protocol.\n pub fn h1(self, service: F) -> H1Service\n where\n B: MessageBody,\n F: IntoServiceFactory,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n {\n let cfg = ServiceConfigBuilder::new()\n .keep_alive(self.keep_alive)\n .client_request_timeout(self.client_request_timeout)\n .client_disconnect_timeout(self.client_disconnect_timeout)\n .tcp_nodelay(self.tcp_nodelay)\n .secure(self.secure)\n .local_addr(self.local_addr)\n .h1_allow_half_closed(self.h1_allow_half_closed)\n .h2_initial_window_size(self.h2_stream_window_size)\n .h2_initial_connection_window_size(self.h2_conn_window_size)\n .build();\n\n H1Service::with_config(cfg, service.into_factory())\n .expect(self.expect)\n .upgrade(self.upgrade)\n .on_connect_ext(self.on_connect_ext)\n }\n\n /// Finish service configuration and create a service for the HTTP/2 protocol.\n #[cfg(feature = \"http2\")]\n pub fn h2(self, service: F) -> crate::h2::H2Service\n where\n F: IntoServiceFactory,\n S::Error: Into> + 'static,\n S::InitError: fmt::Debug,\n S::Response: Into> + 'static,\n\n B: MessageBody + 'static,\n {\n let cfg = ServiceConfigBuilder::new()\n .keep_alive(self.keep_alive)\n .client_request_timeout(self.client_request_timeout)\n .client_disconnect_timeout(self.client_disconnect_timeout)\n .tcp_nodelay(self.tcp_nodelay)\n .secure(self.secure)\n .local_addr(self.local_addr)\n .h1_allow_half_closed(self.h1_allow_half_closed)\n .h2_initial_window_size(self.h2_stream_window_size)\n .h2_initial_connection_window_size(self.h2_conn_window_size)\n .build();\n\n crate::h2::H2Service::with_config(cfg, service.into_factory())\n .on_connect_ext(self.on_connect_ext)\n }\n\n /// Finish service configuration and create `HttpService` instance.\n pub fn finish(self, service: F) -> HttpService\n where\n F: IntoServiceFactory,\n S::Error: Into> + 'static,\n S::InitError: fmt::Debug,\n S::Response: Into> + 'static,\n\n B: MessageBody + 'static,\n {\n let cfg = ServiceConfigBuilder::new()\n .keep_alive(self.keep_alive)\n .client_request_timeout(self.client_request_timeout)\n .client_disconnect_timeout(self.client_disconnect_timeout)\n .tcp_nodelay(self.tcp_nodelay)\n .secure(self.secure)\n .local_addr(self.local_addr)\n .h1_allow_half_closed(self.h1_allow_half_closed)\n .h2_initial_window_size(self.h2_stream_window_size)\n .h2_initial_connection_window_size(self.h2_conn_window_size)\n .build();\n\n HttpService::with_config(cfg, service.into_factory())\n .expect(self.expect)\n .upgrade(self.upgrade)\n .on_connect_ext(self.on_connect_ext)\n }\n}\n" }, { "path": "actix-http/src/config.rs", "content": "use std::{\n net::SocketAddr,\n rc::Rc,\n time::{Duration, Instant},\n};\n\nuse bytes::BytesMut;\n\nuse crate::{date::DateService, KeepAlive};\n\n/// Default HTTP/2 initial connection-level flow control window size.\n///\n/// Matches awc's defaults to avoid poor throughput on high-BDP links.\npub(crate) const DEFAULT_H2_CONN_WINDOW_SIZE: u32 = 1024 * 1024 * 2; // 2MiB\n\n/// Default HTTP/2 initial stream-level flow control window size.\n///\n/// Matches awc's defaults to avoid poor throughput on high-BDP links.\npub(crate) const DEFAULT_H2_STREAM_WINDOW_SIZE: u32 = 1024 * 1024; // 1MiB\n\n/// A builder for creating a [`ServiceConfig`]\n#[derive(Default, Debug)]\npub struct ServiceConfigBuilder {\n inner: Inner,\n}\n\nimpl ServiceConfigBuilder {\n /// Creates a new, default, [`ServiceConfigBuilder`]\n ///\n /// It uses the following default values:\n ///\n /// - [`KeepAlive::default`] for the connection keep-alive setting\n /// - 5 seconds for the client request timeout\n /// - 0 seconds for the client shutdown timeout\n /// - secure value of `false`\n /// - [`None`] for the local address setting\n /// - Allow for half closed HTTP/1 connections\n pub fn new() -> Self {\n Self::default()\n }\n\n /// Sets the `secure` attribute for this configuration\n pub fn secure(mut self, secure: bool) -> Self {\n self.inner.secure = secure;\n self\n }\n\n /// Sets the local address for this configuration\n pub fn local_addr(mut self, local_addr: Option) -> Self {\n self.inner.local_addr = local_addr;\n self\n }\n\n /// Sets connection keep-alive setting\n pub fn keep_alive(mut self, keep_alive: KeepAlive) -> Self {\n self.inner.keep_alive = keep_alive;\n self\n }\n\n /// Sets the timeout for the client to finish sending the head of its first request\n pub fn client_request_timeout(mut self, timeout: Duration) -> Self {\n self.inner.client_request_timeout = timeout;\n self\n }\n\n /// Sets the timeout for cleanly disconnecting from the client after connection shutdown has\n /// started\n pub fn client_disconnect_timeout(mut self, timeout: Duration) -> Self {\n self.inner.client_disconnect_timeout = timeout;\n self\n }\n\n /// Sets `TCP_NODELAY` preference for accepted TCP connections.\n pub fn tcp_nodelay(mut self, nodelay: Option) -> Self {\n self.inner.tcp_nodelay = nodelay;\n self\n }\n\n /// Sets whether HTTP/1 connections should support half-closures.\n ///\n /// Clients can choose to shutdown their writer-side of the connection after completing their\n /// request and while waiting for the server response. Setting this to `false` will cause the\n /// server to abort the connection handling as soon as it detects an EOF from the client\n pub fn h1_allow_half_closed(mut self, allow: bool) -> Self {\n self.inner.h1_allow_half_closed = allow;\n self\n }\n\n /// Sets initial stream-level flow control window size for HTTP/2 connections.\n ///\n /// Higher values can improve upload performance on high-latency links at the cost of higher\n /// worst-case memory usage per connection.\n ///\n /// The default value is 1MiB.\n pub fn h2_initial_window_size(mut self, size: u32) -> Self {\n self.inner.h2_stream_window_size = size;\n self\n }\n\n /// Sets initial connection-level flow control window size for HTTP/2 connections.\n ///\n /// Higher values can improve upload performance on high-latency links at the cost of higher\n /// worst-case memory usage per connection.\n ///\n /// The default value is 2MiB.\n pub fn h2_initial_connection_window_size(mut self, size: u32) -> Self {\n self.inner.h2_conn_window_size = size;\n self\n }\n\n /// Builds a [`ServiceConfig`] from this [`ServiceConfigBuilder`] instance\n pub fn build(self) -> ServiceConfig {\n ServiceConfig(Rc::new(self.inner))\n }\n}\n\n/// HTTP service configuration.\n#[derive(Debug, Clone, Default)]\npub struct ServiceConfig(Rc);\n\n#[derive(Debug)]\nstruct Inner {\n keep_alive: KeepAlive,\n client_request_timeout: Duration,\n client_disconnect_timeout: Duration,\n secure: bool,\n local_addr: Option,\n tcp_nodelay: Option,\n date_service: DateService,\n h1_allow_half_closed: bool,\n h2_conn_window_size: u32,\n h2_stream_window_size: u32,\n}\n\nimpl Default for Inner {\n fn default() -> Self {\n Self {\n keep_alive: KeepAlive::default(),\n client_request_timeout: Duration::from_secs(5),\n client_disconnect_timeout: Duration::ZERO,\n secure: false,\n local_addr: None,\n tcp_nodelay: None,\n date_service: DateService::new(),\n h1_allow_half_closed: true,\n h2_conn_window_size: DEFAULT_H2_CONN_WINDOW_SIZE,\n h2_stream_window_size: DEFAULT_H2_STREAM_WINDOW_SIZE,\n }\n }\n}\n\nimpl ServiceConfig {\n /// Create instance of `ServiceConfig`.\n pub fn new(\n keep_alive: KeepAlive,\n client_request_timeout: Duration,\n client_disconnect_timeout: Duration,\n secure: bool,\n local_addr: Option,\n ) -> ServiceConfig {\n ServiceConfig(Rc::new(Inner {\n keep_alive: keep_alive.normalize(),\n client_request_timeout,\n client_disconnect_timeout,\n secure,\n local_addr,\n tcp_nodelay: None,\n date_service: DateService::new(),\n h1_allow_half_closed: true,\n h2_conn_window_size: DEFAULT_H2_CONN_WINDOW_SIZE,\n h2_stream_window_size: DEFAULT_H2_STREAM_WINDOW_SIZE,\n }))\n }\n\n /// Returns `true` if connection is secure (i.e., using TLS / HTTPS).\n #[inline]\n pub fn secure(&self) -> bool {\n self.0.secure\n }\n\n /// Returns the local address that this server is bound to.\n ///\n /// Returns `None` for connections via UDS (Unix Domain Socket).\n #[inline]\n pub fn local_addr(&self) -> Option {\n self.0.local_addr\n }\n\n /// Connection keep-alive setting.\n #[inline]\n pub fn keep_alive(&self) -> KeepAlive {\n self.0.keep_alive\n }\n\n /// Creates a time object representing the deadline for this connection's keep-alive period, if\n /// enabled.\n ///\n /// When [`KeepAlive::Os`] or [`KeepAlive::Disabled`] is set, this will return `None`.\n pub fn keep_alive_deadline(&self) -> Option {\n match self.keep_alive() {\n KeepAlive::Timeout(dur) => Some(self.now() + dur),\n KeepAlive::Os => None,\n KeepAlive::Disabled => None,\n }\n }\n\n /// Creates a time object representing the deadline for the client to finish sending the head of\n /// its first request.\n ///\n /// Returns `None` if this `ServiceConfig was` constructed with `client_request_timeout: 0`.\n pub fn client_request_deadline(&self) -> Option {\n let timeout = self.0.client_request_timeout;\n (timeout != Duration::ZERO).then(|| self.now() + timeout)\n }\n\n /// Creates a time object representing the deadline for the client to disconnect.\n pub fn client_disconnect_deadline(&self) -> Option {\n let timeout = self.0.client_disconnect_timeout;\n (timeout != Duration::ZERO).then(|| self.now() + timeout)\n }\n\n /// Whether HTTP/1 connections should support half-closures.\n ///\n /// Clients can choose to shutdown their writer-side of the connection after completing their\n /// request and while waiting for the server response. If this configuration is `false`, the\n /// server will abort the connection handling as soon as it detects an EOF from the client\n pub fn h1_allow_half_closed(&self) -> bool {\n self.0.h1_allow_half_closed\n }\n\n /// Returns configured `TCP_NODELAY` setting for accepted TCP connections.\n pub fn tcp_nodelay(&self) -> Option {\n self.0.tcp_nodelay\n }\n\n /// HTTP/2 initial stream-level flow control window size (in bytes).\n pub fn h2_initial_window_size(&self) -> u32 {\n self.0.h2_stream_window_size\n }\n\n /// HTTP/2 initial connection-level flow control window size (in bytes).\n pub fn h2_initial_connection_window_size(&self) -> u32 {\n self.0.h2_conn_window_size\n }\n\n pub(crate) fn now(&self) -> Instant {\n self.0.date_service.now()\n }\n\n /// Writes date header to `dst` buffer.\n ///\n /// Low-level method that utilizes the built-in efficient date service, requiring fewer syscalls\n /// than normal. Note that a CRLF (`\\r\\n`) is included in what is written.\n #[doc(hidden)]\n pub fn write_date_header(&self, dst: &mut BytesMut, camel_case: bool) {\n let mut buf: [u8; 37] = [0; 37];\n\n buf[..6].copy_from_slice(if camel_case { b\"Date: \" } else { b\"date: \" });\n\n self.0\n .date_service\n .with_date(|date| buf[6..35].copy_from_slice(&date.bytes));\n\n buf[35..].copy_from_slice(b\"\\r\\n\");\n dst.extend_from_slice(&buf);\n }\n\n #[allow(unused)] // used with `http2` feature flag\n pub(crate) fn write_date_header_value(&self, dst: &mut BytesMut) {\n self.0\n .date_service\n .with_date(|date| dst.extend_from_slice(&date.bytes));\n }\n}\n\n#[cfg(test)]\nmod tests {\n use actix_rt::{\n task::yield_now,\n time::{sleep, sleep_until},\n };\n use memchr::memmem;\n\n use super::*;\n use crate::{date::DATE_VALUE_LENGTH, notify_on_drop};\n\n #[actix_rt::test]\n async fn test_date_service_update() {\n let settings =\n ServiceConfig::new(KeepAlive::Os, Duration::ZERO, Duration::ZERO, false, None);\n\n yield_now().await;\n\n let mut buf1 = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);\n settings.write_date_header(&mut buf1, false);\n let now1 = settings.now();\n\n sleep_until((Instant::now() + Duration::from_secs(2)).into()).await;\n yield_now().await;\n\n let now2 = settings.now();\n let mut buf2 = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);\n settings.write_date_header(&mut buf2, false);\n\n assert_ne!(now1, now2);\n\n assert_ne!(buf1, buf2);\n\n drop(settings);\n\n // Ensure the task will drop eventually\n let mut times = 0;\n while !notify_on_drop::is_dropped() {\n sleep(Duration::from_millis(100)).await;\n times += 1;\n assert!(times < 10, \"Timeout waiting for task drop\");\n }\n }\n\n #[actix_rt::test]\n async fn test_date_service_drop() {\n let service = Rc::new(DateService::new());\n\n // yield so date service have a chance to register the spawned timer update task.\n yield_now().await;\n\n let clone1 = service.clone();\n let clone2 = service.clone();\n let clone3 = service.clone();\n\n drop(clone1);\n assert!(!notify_on_drop::is_dropped());\n drop(clone2);\n assert!(!notify_on_drop::is_dropped());\n drop(clone3);\n assert!(!notify_on_drop::is_dropped());\n\n drop(service);\n\n // Ensure the task will drop eventually\n let mut times = 0;\n while !notify_on_drop::is_dropped() {\n sleep(Duration::from_millis(100)).await;\n times += 1;\n assert!(times < 10, \"Timeout waiting for task drop\");\n }\n }\n\n #[test]\n fn test_date_len() {\n assert_eq!(DATE_VALUE_LENGTH, \"Sun, 06 Nov 1994 08:49:37 GMT\".len());\n }\n\n #[actix_rt::test]\n async fn test_date() {\n let settings = ServiceConfig::default();\n\n let mut buf1 = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);\n settings.write_date_header(&mut buf1, false);\n\n let mut buf2 = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);\n settings.write_date_header(&mut buf2, false);\n\n assert_eq!(buf1, buf2);\n }\n\n #[actix_rt::test]\n async fn test_date_camel_case() {\n let settings = ServiceConfig::default();\n\n let mut buf = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);\n settings.write_date_header(&mut buf, false);\n assert!(memmem::find(&buf, b\"date:\").is_some());\n\n let mut buf = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);\n settings.write_date_header(&mut buf, true);\n assert!(memmem::find(&buf, b\"Date:\").is_some());\n }\n}\n" }, { "path": "actix-http/src/date.rs", "content": "use std::{\n cell::Cell,\n fmt::{self, Write},\n rc::Rc,\n time::{Duration, Instant, SystemTime},\n};\n\nuse actix_rt::{task::JoinHandle, time::interval};\n\n/// \"Thu, 01 Jan 1970 00:00:00 GMT\".len()\npub(crate) const DATE_VALUE_LENGTH: usize = 29;\n\n#[derive(Clone, Copy)]\npub(crate) struct Date {\n pub(crate) bytes: [u8; DATE_VALUE_LENGTH],\n pos: usize,\n}\n\nimpl Date {\n fn new() -> Date {\n let mut date = Date {\n bytes: [0; DATE_VALUE_LENGTH],\n pos: 0,\n };\n date.update();\n date\n }\n\n fn update(&mut self) {\n self.pos = 0;\n write!(self, \"{}\", httpdate::HttpDate::from(SystemTime::now())).unwrap();\n }\n}\n\nimpl fmt::Write for Date {\n fn write_str(&mut self, s: &str) -> fmt::Result {\n let len = s.len();\n self.bytes[self.pos..self.pos + len].copy_from_slice(s.as_bytes());\n self.pos += len;\n Ok(())\n }\n}\n\n/// Service for update Date and Instant periodically at 500 millis interval.\npub(crate) struct DateService {\n current: Rc>,\n handle: JoinHandle<()>,\n}\n\nimpl DateService {\n pub(crate) fn new() -> Self {\n // shared date and timer for DateService and update async task.\n let current = Rc::new(Cell::new((Date::new(), Instant::now())));\n let current_clone = Rc::clone(¤t);\n // spawn an async task sleep for 500 millis and update current date/timer in a loop.\n // handle is used to stop the task on DateService drop.\n let handle = actix_rt::spawn(async move {\n #[cfg(test)]\n let _notify = crate::notify_on_drop::NotifyOnDrop::new();\n\n let mut interval = interval(Duration::from_millis(500));\n loop {\n let now = interval.tick().await;\n let date = Date::new();\n current_clone.set((date, now.into_std()));\n }\n });\n\n DateService { current, handle }\n }\n\n pub(crate) fn now(&self) -> Instant {\n self.current.get().1\n }\n\n pub(crate) fn with_date(&self, mut f: F) {\n f(&self.current.get().0);\n }\n}\n\nimpl fmt::Debug for DateService {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"DateService\").finish_non_exhaustive()\n }\n}\n\nimpl Drop for DateService {\n fn drop(&mut self) {\n // stop the timer update async task on drop.\n self.handle.abort();\n }\n}\n" }, { "path": "actix-http/src/encoding/decoder.rs", "content": "//! Stream decoders.\n\nuse std::{\n future::Future,\n io::{self, Write as _},\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse actix_rt::task::{spawn_blocking, JoinHandle};\nuse bytes::Bytes;\n#[cfg(feature = \"compress-gzip\")]\nuse flate2::write::{GzDecoder, ZlibDecoder};\nuse futures_core::{ready, Stream};\n#[cfg(feature = \"compress-zstd\")]\nuse zstd::stream::write::Decoder as ZstdDecoder;\n\nuse crate::{\n encoding::Writer,\n error::PayloadError,\n header::{ContentEncoding, HeaderMap, CONTENT_ENCODING},\n};\n\nconst MAX_CHUNK_SIZE_DECODE_IN_PLACE: usize = 2049;\n\npin_project_lite::pin_project! {\n pub struct Decoder {\n decoder: Option,\n #[pin]\n stream: S,\n eof: bool,\n fut: Option, ContentDecoder), io::Error>>>,\n }\n}\n\nimpl Decoder\nwhere\n S: Stream>,\n{\n /// Construct a decoder.\n #[inline]\n pub fn new(stream: S, encoding: ContentEncoding) -> Decoder {\n let decoder = match encoding {\n #[cfg(feature = \"compress-brotli\")]\n ContentEncoding::Brotli => Some(ContentDecoder::Brotli(Box::new(\n brotli::DecompressorWriter::new(Writer::new(), 8_096),\n ))),\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoding::Deflate => Some(ContentDecoder::Deflate(Box::new(ZlibDecoder::new(\n Writer::new(),\n )))),\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoding::Gzip => Some(ContentDecoder::Gzip(Box::new(GzDecoder::new(\n Writer::new(),\n )))),\n\n #[cfg(feature = \"compress-zstd\")]\n ContentEncoding::Zstd => Some(ContentDecoder::Zstd(Box::new(\n ZstdDecoder::new(Writer::new()).expect(\n \"Failed to create zstd decoder. This is a bug. \\\n Please report it to the actix-web repository.\",\n ),\n ))),\n _ => None,\n };\n\n Decoder {\n decoder,\n stream,\n fut: None,\n eof: false,\n }\n }\n\n /// Construct decoder based on headers.\n #[inline]\n pub fn from_headers(stream: S, headers: &HeaderMap) -> Decoder {\n // check content-encoding\n let encoding = headers\n .get(&CONTENT_ENCODING)\n .and_then(|val| val.to_str().ok())\n .and_then(|x| x.parse().ok())\n .unwrap_or(ContentEncoding::Identity);\n\n Self::new(stream, encoding)\n }\n}\n\nimpl Stream for Decoder\nwhere\n S: Stream>,\n{\n type Item = Result;\n\n fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n let mut this = self.project();\n\n loop {\n if let Some(ref mut fut) = this.fut {\n let (chunk, decoder) = ready!(Pin::new(fut).poll(cx)).map_err(|_| {\n PayloadError::Io(io::Error::other(\"Blocking task was cancelled unexpectedly\"))\n })??;\n\n *this.decoder = Some(decoder);\n this.fut.take();\n\n if let Some(chunk) = chunk {\n return Poll::Ready(Some(Ok(chunk)));\n }\n }\n\n if *this.eof {\n return Poll::Ready(None);\n }\n\n match ready!(this.stream.as_mut().poll_next(cx)) {\n Some(Err(err)) => return Poll::Ready(Some(Err(err))),\n\n Some(Ok(chunk)) => {\n if let Some(mut decoder) = this.decoder.take() {\n if chunk.len() < MAX_CHUNK_SIZE_DECODE_IN_PLACE {\n let chunk = decoder.feed_data(chunk)?;\n *this.decoder = Some(decoder);\n\n if let Some(chunk) = chunk {\n return Poll::Ready(Some(Ok(chunk)));\n }\n } else {\n *this.fut = Some(spawn_blocking(move || {\n let chunk = decoder.feed_data(chunk)?;\n Ok((chunk, decoder))\n }));\n }\n\n continue;\n } else {\n return Poll::Ready(Some(Ok(chunk)));\n }\n }\n\n None => {\n *this.eof = true;\n\n return if let Some(mut decoder) = this.decoder.take() {\n match decoder.feed_eof() {\n Ok(Some(res)) => Poll::Ready(Some(Ok(res))),\n Ok(None) => Poll::Ready(None),\n Err(err) => Poll::Ready(Some(Err(err.into()))),\n }\n } else {\n Poll::Ready(None)\n };\n }\n }\n }\n }\n}\n\nenum ContentDecoder {\n #[cfg(feature = \"compress-gzip\")]\n Deflate(Box>),\n\n #[cfg(feature = \"compress-gzip\")]\n Gzip(Box>),\n\n #[cfg(feature = \"compress-brotli\")]\n Brotli(Box>),\n\n // We need explicit 'static lifetime here because ZstdDecoder need lifetime\n // argument, and we use `spawn_blocking` in `Decoder::poll_next` that require `FnOnce() -> R + Send + 'static`\n #[cfg(feature = \"compress-zstd\")]\n Zstd(Box>),\n}\n\nimpl ContentDecoder {\n fn feed_eof(&mut self) -> io::Result> {\n match self {\n #[cfg(feature = \"compress-brotli\")]\n ContentDecoder::Brotli(ref mut decoder) => match decoder.flush() {\n Ok(()) => {\n let b = decoder.get_mut().take();\n\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentDecoder::Gzip(ref mut decoder) => match decoder.try_finish() {\n Ok(_) => {\n let b = decoder.get_mut().take();\n\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentDecoder::Deflate(ref mut decoder) => match decoder.try_finish() {\n Ok(_) => {\n let b = decoder.get_mut().take();\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-zstd\")]\n ContentDecoder::Zstd(ref mut decoder) => match decoder.flush() {\n Ok(_) => {\n let b = decoder.get_mut().take();\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n }\n }\n\n fn feed_data(&mut self, data: Bytes) -> io::Result> {\n match self {\n #[cfg(feature = \"compress-brotli\")]\n ContentDecoder::Brotli(ref mut decoder) => match decoder.write_all(&data) {\n Ok(_) => {\n decoder.flush()?;\n let b = decoder.get_mut().take();\n\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentDecoder::Gzip(ref mut decoder) => match decoder.write_all(&data) {\n Ok(_) => {\n decoder.flush()?;\n let b = decoder.get_mut().take();\n\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentDecoder::Deflate(ref mut decoder) => match decoder.write_all(&data) {\n Ok(_) => {\n decoder.flush()?;\n\n let b = decoder.get_mut().take();\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-zstd\")]\n ContentDecoder::Zstd(ref mut decoder) => match decoder.write_all(&data) {\n Ok(_) => {\n decoder.flush()?;\n\n let b = decoder.get_mut().take();\n if !b.is_empty() {\n Ok(Some(b))\n } else {\n Ok(None)\n }\n }\n Err(err) => Err(err),\n },\n }\n }\n}\n" }, { "path": "actix-http/src/encoding/encoder.rs", "content": "//! Stream encoders.\n\nuse std::{\n error::Error as StdError,\n future::Future,\n io::{self, Write as _},\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse actix_rt::task::{spawn_blocking, JoinHandle};\nuse bytes::Bytes;\nuse derive_more::Display;\n#[cfg(feature = \"compress-gzip\")]\nuse flate2::write::{GzEncoder, ZlibEncoder};\nuse futures_core::ready;\nuse pin_project_lite::pin_project;\nuse tracing::trace;\n#[cfg(feature = \"compress-zstd\")]\nuse zstd::stream::write::Encoder as ZstdEncoder;\n\nuse super::Writer;\nuse crate::{\n body::{self, BodySize, MessageBody},\n header::{self, ContentEncoding, HeaderValue, CONTENT_ENCODING},\n ResponseHead, StatusCode,\n};\n\nconst MAX_CHUNK_SIZE_ENCODE_IN_PLACE: usize = 1024;\n\npin_project! {\n pub struct Encoder {\n #[pin]\n body: EncoderBody,\n encoder: Option,\n fut: Option>>,\n eof: bool,\n }\n}\n\nimpl Encoder {\n fn none() -> Self {\n Encoder {\n body: EncoderBody::None {\n body: body::None::new(),\n },\n encoder: None,\n fut: None,\n eof: true,\n }\n }\n\n fn empty() -> Self {\n Encoder {\n body: EncoderBody::Full { body: Bytes::new() },\n encoder: None,\n fut: None,\n eof: true,\n }\n }\n\n pub fn response(encoding: ContentEncoding, head: &mut ResponseHead, body: B) -> Self {\n // no need to compress empty bodies\n match body.size() {\n BodySize::None => return Self::none(),\n BodySize::Sized(0) => return Self::empty(),\n _ => {}\n }\n\n let should_encode = !(head.headers().contains_key(&CONTENT_ENCODING)\n || head.status == StatusCode::SWITCHING_PROTOCOLS\n || head.status == StatusCode::NO_CONTENT\n || head.status == StatusCode::PARTIAL_CONTENT\n || encoding == ContentEncoding::Identity);\n\n let body = match body.try_into_bytes() {\n Ok(body) => EncoderBody::Full { body },\n Err(body) => EncoderBody::Stream { body },\n };\n\n if should_encode {\n // wrap body only if encoder is feature-enabled\n if let Some(enc) = ContentEncoder::select(encoding) {\n update_head(encoding, head);\n\n return Encoder {\n body,\n encoder: Some(enc),\n fut: None,\n eof: false,\n };\n }\n }\n\n Encoder {\n body,\n encoder: None,\n fut: None,\n eof: false,\n }\n }\n}\n\npin_project! {\n #[project = EncoderBodyProj]\n enum EncoderBody {\n None { body: body::None },\n Full { body: Bytes },\n Stream { #[pin] body: B },\n }\n}\n\nimpl MessageBody for EncoderBody\nwhere\n B: MessageBody,\n{\n type Error = EncoderError;\n\n #[inline]\n fn size(&self) -> BodySize {\n match self {\n EncoderBody::None { body } => body.size(),\n EncoderBody::Full { body } => body.size(),\n EncoderBody::Stream { body } => body.size(),\n }\n }\n\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n match self.project() {\n EncoderBodyProj::None { body } => {\n Pin::new(body).poll_next(cx).map_err(|err| match err {})\n }\n EncoderBodyProj::Full { body } => {\n Pin::new(body).poll_next(cx).map_err(|err| match err {})\n }\n EncoderBodyProj::Stream { body } => body\n .poll_next(cx)\n .map_err(|err| EncoderError::Body(err.into())),\n }\n }\n\n #[inline]\n fn try_into_bytes(self) -> Result\n where\n Self: Sized,\n {\n match self {\n EncoderBody::None { body } => Ok(body.try_into_bytes().unwrap()),\n EncoderBody::Full { body } => Ok(body.try_into_bytes().unwrap()),\n _ => Err(self),\n }\n }\n}\n\nimpl MessageBody for Encoder\nwhere\n B: MessageBody,\n{\n type Error = EncoderError;\n\n #[inline]\n fn size(&self) -> BodySize {\n if self.encoder.is_some() {\n BodySize::Stream\n } else {\n self.body.size()\n }\n }\n\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n let mut this = self.project();\n\n loop {\n if *this.eof {\n return Poll::Ready(None);\n }\n\n if let Some(ref mut fut) = this.fut {\n let mut encoder = ready!(Pin::new(fut).poll(cx))\n .map_err(|_| {\n EncoderError::Io(io::Error::other(\n \"Blocking task was cancelled unexpectedly\",\n ))\n })?\n .map_err(EncoderError::Io)?;\n\n let chunk = encoder.take();\n *this.encoder = Some(encoder);\n this.fut.take();\n\n if !chunk.is_empty() {\n return Poll::Ready(Some(Ok(chunk)));\n }\n }\n\n let result = ready!(this.body.as_mut().poll_next(cx));\n\n match result {\n Some(Err(err)) => return Poll::Ready(Some(Err(err))),\n\n Some(Ok(chunk)) => {\n if let Some(mut encoder) = this.encoder.take() {\n if chunk.len() < MAX_CHUNK_SIZE_ENCODE_IN_PLACE {\n encoder.write(&chunk).map_err(EncoderError::Io)?;\n let chunk = encoder.take();\n *this.encoder = Some(encoder);\n\n if !chunk.is_empty() {\n return Poll::Ready(Some(Ok(chunk)));\n }\n } else {\n *this.fut = Some(spawn_blocking(move || {\n encoder.write(&chunk)?;\n Ok(encoder)\n }));\n }\n } else {\n return Poll::Ready(Some(Ok(chunk)));\n }\n }\n\n None => {\n if let Some(encoder) = this.encoder.take() {\n let chunk = encoder.finish().map_err(EncoderError::Io)?;\n\n if chunk.is_empty() {\n return Poll::Ready(None);\n } else {\n *this.eof = true;\n return Poll::Ready(Some(Ok(chunk)));\n }\n } else {\n return Poll::Ready(None);\n }\n }\n }\n }\n }\n\n #[inline]\n fn try_into_bytes(mut self) -> Result\n where\n Self: Sized,\n {\n if self.encoder.is_some() {\n Err(self)\n } else {\n match self.body.try_into_bytes() {\n Ok(body) => Ok(body),\n Err(body) => {\n self.body = body;\n Err(self)\n }\n }\n }\n }\n}\n\nfn update_head(encoding: ContentEncoding, head: &mut ResponseHead) {\n head.headers_mut()\n .insert(header::CONTENT_ENCODING, encoding.to_header_value());\n head.headers_mut()\n .append(header::VARY, HeaderValue::from_static(\"accept-encoding\"));\n\n head.no_chunking(false);\n}\n\nenum ContentEncoder {\n #[cfg(feature = \"compress-gzip\")]\n Deflate(ZlibEncoder),\n\n #[cfg(feature = \"compress-gzip\")]\n Gzip(GzEncoder),\n\n #[cfg(feature = \"compress-brotli\")]\n Brotli(Box>),\n\n // Wwe need explicit 'static lifetime here because ZstdEncoder needs a lifetime argument and we\n // use `spawn_blocking` in `Encoder::poll_next` that requires `FnOnce() -> R + Send + 'static`.\n #[cfg(feature = \"compress-zstd\")]\n Zstd(ZstdEncoder<'static, Writer>),\n}\n\nimpl ContentEncoder {\n fn select(encoding: ContentEncoding) -> Option {\n match encoding {\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoding::Deflate => Some(ContentEncoder::Deflate(ZlibEncoder::new(\n Writer::new(),\n flate2::Compression::fast(),\n ))),\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoding::Gzip => Some(ContentEncoder::Gzip(GzEncoder::new(\n Writer::new(),\n flate2::Compression::fast(),\n ))),\n\n #[cfg(feature = \"compress-brotli\")]\n ContentEncoding::Brotli => Some(ContentEncoder::Brotli(new_brotli_compressor())),\n\n #[cfg(feature = \"compress-zstd\")]\n ContentEncoding::Zstd => {\n let encoder = ZstdEncoder::new(Writer::new(), 3).ok()?;\n Some(ContentEncoder::Zstd(encoder))\n }\n\n _ => None,\n }\n }\n\n #[inline]\n pub(crate) fn take(&mut self) -> Bytes {\n match *self {\n #[cfg(feature = \"compress-brotli\")]\n ContentEncoder::Brotli(ref mut encoder) => encoder.get_mut().take(),\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoder::Deflate(ref mut encoder) => encoder.get_mut().take(),\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoder::Gzip(ref mut encoder) => encoder.get_mut().take(),\n\n #[cfg(feature = \"compress-zstd\")]\n ContentEncoder::Zstd(ref mut encoder) => encoder.get_mut().take(),\n }\n }\n\n fn finish(self) -> Result {\n match self {\n #[cfg(feature = \"compress-brotli\")]\n ContentEncoder::Brotli(mut encoder) => match encoder.flush() {\n Ok(()) => Ok(encoder.into_inner().buf.freeze()),\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoder::Gzip(encoder) => match encoder.finish() {\n Ok(writer) => Ok(writer.buf.freeze()),\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoder::Deflate(encoder) => match encoder.finish() {\n Ok(writer) => Ok(writer.buf.freeze()),\n Err(err) => Err(err),\n },\n\n #[cfg(feature = \"compress-zstd\")]\n ContentEncoder::Zstd(encoder) => match encoder.finish() {\n Ok(writer) => Ok(writer.buf.freeze()),\n Err(err) => Err(err),\n },\n }\n }\n\n fn write(&mut self, data: &[u8]) -> Result<(), io::Error> {\n match *self {\n #[cfg(feature = \"compress-brotli\")]\n ContentEncoder::Brotli(ref mut encoder) => match encoder.write_all(data) {\n Ok(_) => Ok(()),\n Err(err) => {\n trace!(\"Error decoding br encoding: {}\", err);\n Err(err)\n }\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoder::Gzip(ref mut encoder) => match encoder.write_all(data) {\n Ok(_) => Ok(()),\n Err(err) => {\n trace!(\"Error decoding gzip encoding: {}\", err);\n Err(err)\n }\n },\n\n #[cfg(feature = \"compress-gzip\")]\n ContentEncoder::Deflate(ref mut encoder) => match encoder.write_all(data) {\n Ok(_) => Ok(()),\n Err(err) => {\n trace!(\"Error decoding deflate encoding: {}\", err);\n Err(err)\n }\n },\n\n #[cfg(feature = \"compress-zstd\")]\n ContentEncoder::Zstd(ref mut encoder) => match encoder.write_all(data) {\n Ok(_) => Ok(()),\n Err(err) => {\n trace!(\"Error decoding ztsd encoding: {}\", err);\n Err(err)\n }\n },\n }\n }\n}\n\n#[cfg(feature = \"compress-brotli\")]\nfn new_brotli_compressor() -> Box> {\n Box::new(brotli::CompressorWriter::new(\n Writer::new(),\n 32 * 1024, // 32 KiB buffer\n 3, // BROTLI_PARAM_QUALITY\n 22, // BROTLI_PARAM_LGWIN\n ))\n}\n\n#[derive(Debug, Display)]\n#[non_exhaustive]\npub enum EncoderError {\n /// Wrapped body stream error.\n #[display(\"body\")]\n Body(Box),\n\n /// Generic I/O error.\n #[display(\"io\")]\n Io(io::Error),\n}\n\nimpl StdError for EncoderError {\n fn source(&self) -> Option<&(dyn StdError + 'static)> {\n match self {\n EncoderError::Body(err) => Some(&**err),\n EncoderError::Io(err) => Some(err),\n }\n }\n}\n\nimpl From for crate::Error {\n fn from(err: EncoderError) -> Self {\n crate::Error::new_encoder().with_cause(err)\n }\n}\n" }, { "path": "actix-http/src/encoding/mod.rs", "content": "//! Content-Encoding support.\n\nuse std::io;\n\nuse bytes::{Bytes, BytesMut};\n\nmod decoder;\nmod encoder;\n\npub use self::{decoder::Decoder, encoder::Encoder};\n\n/// Special-purpose writer for streaming (de-)compression.\n///\n/// Pre-allocates 8KiB of capacity.\nstruct Writer {\n buf: BytesMut,\n}\n\nimpl Writer {\n fn new() -> Writer {\n Writer {\n buf: BytesMut::with_capacity(8192),\n }\n }\n\n fn take(&mut self) -> Bytes {\n self.buf.split().freeze()\n }\n}\n\nimpl io::Write for Writer {\n fn write(&mut self, buf: &[u8]) -> io::Result {\n self.buf.extend_from_slice(buf);\n Ok(buf.len())\n }\n\n fn flush(&mut self) -> io::Result<()> {\n Ok(())\n }\n}\n" }, { "path": "actix-http/src/error.rs", "content": "//! Error and Result module\n\nuse std::{error::Error as StdError, fmt, io, str::Utf8Error, string::FromUtf8Error};\n\nuse derive_more::{Display, Error, From};\npub use http::{status::InvalidStatusCode, Error as HttpError};\nuse http::{uri::InvalidUri, StatusCode};\n\nuse crate::{body::BoxBody, Response};\n\npub struct Error {\n inner: Box,\n}\n\npub(crate) struct ErrorInner {\n #[allow(dead_code)]\n kind: Kind,\n cause: Option>,\n}\n\nimpl Error {\n fn new(kind: Kind) -> Self {\n Self {\n inner: Box::new(ErrorInner { kind, cause: None }),\n }\n }\n\n pub(crate) fn with_cause(mut self, cause: impl Into>) -> Self {\n self.inner.cause = Some(cause.into());\n self\n }\n\n pub(crate) fn new_http() -> Self {\n Self::new(Kind::Http)\n }\n\n pub(crate) fn new_parse() -> Self {\n Self::new(Kind::Parse)\n }\n\n pub(crate) fn new_payload() -> Self {\n Self::new(Kind::Payload)\n }\n\n pub(crate) fn new_body() -> Self {\n Self::new(Kind::Body)\n }\n\n pub(crate) fn new_send_response() -> Self {\n Self::new(Kind::SendResponse)\n }\n\n #[allow(unused)] // available for future use\n pub(crate) fn new_io() -> Self {\n Self::new(Kind::Io)\n }\n\n #[allow(unused)] // used in encoder behind feature flag so ignore unused warning\n pub(crate) fn new_encoder() -> Self {\n Self::new(Kind::Encoder)\n }\n\n #[allow(unused)] // used with `ws` feature flag\n pub(crate) fn new_ws() -> Self {\n Self::new(Kind::Ws)\n }\n}\n\nimpl From for Response {\n fn from(err: Error) -> Self {\n // TODO: more appropriate error status codes, usage assessment needed\n let status_code = match err.inner.kind {\n Kind::Parse => StatusCode::BAD_REQUEST,\n _ => StatusCode::INTERNAL_SERVER_ERROR,\n };\n\n Response::new(status_code).set_body(BoxBody::new(err.to_string()))\n }\n}\n\n#[derive(Debug, Clone, Copy, PartialEq, Eq, Display)]\npub(crate) enum Kind {\n #[display(\"error processing HTTP\")]\n Http,\n\n #[display(\"error parsing HTTP message\")]\n Parse,\n\n #[display(\"request payload read error\")]\n Payload,\n\n #[display(\"response body write error\")]\n Body,\n\n #[display(\"send response error\")]\n SendResponse,\n\n #[display(\"error in WebSocket process\")]\n Ws,\n\n #[display(\"connection error\")]\n Io,\n\n #[display(\"encoder error\")]\n Encoder,\n}\n\nimpl fmt::Debug for Error {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"actix_http::Error\")\n .field(\"kind\", &self.inner.kind)\n .field(\"cause\", &self.inner.cause)\n .finish()\n }\n}\n\nimpl fmt::Display for Error {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n match self.inner.cause.as_ref() {\n Some(err) => write!(f, \"{}: {}\", &self.inner.kind, err),\n None => write!(f, \"{}\", &self.inner.kind),\n }\n }\n}\n\nimpl StdError for Error {\n fn source(&self) -> Option<&(dyn StdError + 'static)> {\n self.inner.cause.as_ref().map(Box::as_ref)\n }\n}\n\nimpl From for Error {\n fn from(err: std::convert::Infallible) -> Self {\n match err {}\n }\n}\n\nimpl From for Error {\n fn from(err: HttpError) -> Self {\n Self::new_http().with_cause(err)\n }\n}\n\n#[cfg(feature = \"ws\")]\nimpl From for Error {\n fn from(err: crate::ws::HandshakeError) -> Self {\n Self::new_ws().with_cause(err)\n }\n}\n\n#[cfg(feature = \"ws\")]\nimpl From for Error {\n fn from(err: crate::ws::ProtocolError) -> Self {\n Self::new_ws().with_cause(err)\n }\n}\n\n/// A set of errors that can occur during parsing HTTP streams.\n#[derive(Debug, Display, Error)]\n#[non_exhaustive]\npub enum ParseError {\n /// An invalid `Method`, such as `GE.T`.\n #[display(\"invalid method specified\")]\n Method,\n\n /// An invalid `Uri`, such as `exam ple.domain`.\n #[display(\"URI error: {}\", _0)]\n Uri(InvalidUri),\n\n /// An invalid `HttpVersion`, such as `HTP/1.1`\n #[display(\"invalid HTTP version specified\")]\n Version,\n\n /// An invalid `Header`.\n #[display(\"invalid Header provided\")]\n Header,\n\n /// A message head is too large to be reasonable.\n #[display(\"message head is too large\")]\n TooLarge,\n\n /// A message reached EOF, but is not complete.\n #[display(\"message is incomplete\")]\n Incomplete,\n\n /// An invalid `Status`, such as `1337 ELITE`.\n #[display(\"invalid status provided\")]\n Status,\n\n /// A timeout occurred waiting for an IO event.\n #[allow(dead_code)]\n #[display(\"timeout\")]\n Timeout,\n\n /// An I/O error that occurred while trying to read or write to a network stream.\n #[display(\"I/O error: {}\", _0)]\n Io(io::Error),\n\n /// Parsing a field as string failed.\n #[display(\"UTF-8 error: {}\", _0)]\n Utf8(Utf8Error),\n}\n\nimpl From for ParseError {\n fn from(err: io::Error) -> ParseError {\n ParseError::Io(err)\n }\n}\n\nimpl From for ParseError {\n fn from(err: InvalidUri) -> ParseError {\n ParseError::Uri(err)\n }\n}\n\nimpl From for ParseError {\n fn from(err: Utf8Error) -> ParseError {\n ParseError::Utf8(err)\n }\n}\n\nimpl From for ParseError {\n fn from(err: FromUtf8Error) -> ParseError {\n ParseError::Utf8(err.utf8_error())\n }\n}\n\nimpl From for ParseError {\n fn from(err: httparse::Error) -> ParseError {\n match err {\n httparse::Error::HeaderName\n | httparse::Error::HeaderValue\n | httparse::Error::NewLine\n | httparse::Error::Token => ParseError::Header,\n httparse::Error::Status => ParseError::Status,\n httparse::Error::TooManyHeaders => ParseError::TooLarge,\n httparse::Error::Version => ParseError::Version,\n }\n }\n}\n\nimpl From for Error {\n fn from(err: ParseError) -> Self {\n Self::new_parse().with_cause(err)\n }\n}\n\nimpl From for Response {\n fn from(err: ParseError) -> Self {\n Error::from(err).into()\n }\n}\n\n/// A set of errors that can occur during payload parsing.\n#[derive(Debug, Display)]\n#[non_exhaustive]\npub enum PayloadError {\n /// A payload reached EOF, but is not complete.\n #[display(\"payload reached EOF before completing: {:?}\", _0)]\n Incomplete(Option),\n\n /// Content encoding stream corruption.\n #[display(\"can not decode content-encoding\")]\n EncodingCorrupted,\n\n /// Payload reached size limit.\n #[display(\"payload reached size limit\")]\n Overflow,\n\n /// Payload length is unknown.\n #[display(\"payload length is unknown\")]\n UnknownLength,\n\n /// HTTP/2 payload error.\n #[cfg(feature = \"http2\")]\n #[display(\"{}\", _0)]\n Http2Payload(::h2::Error),\n\n /// Generic I/O error.\n #[display(\"{}\", _0)]\n Io(io::Error),\n}\n\nimpl std::error::Error for PayloadError {\n fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {\n match self {\n PayloadError::Incomplete(None) => None,\n PayloadError::Incomplete(Some(err)) => Some(err),\n PayloadError::EncodingCorrupted => None,\n PayloadError::Overflow => None,\n PayloadError::UnknownLength => None,\n #[cfg(feature = \"http2\")]\n PayloadError::Http2Payload(err) => Some(err),\n PayloadError::Io(err) => Some(err),\n }\n }\n}\n\n#[cfg(feature = \"http2\")]\nimpl From<::h2::Error> for PayloadError {\n fn from(err: ::h2::Error) -> Self {\n PayloadError::Http2Payload(err)\n }\n}\n\nimpl From> for PayloadError {\n fn from(err: Option) -> Self {\n PayloadError::Incomplete(err)\n }\n}\n\nimpl From for PayloadError {\n fn from(err: io::Error) -> Self {\n PayloadError::Incomplete(Some(err))\n }\n}\n\nimpl From for Error {\n fn from(err: PayloadError) -> Self {\n Self::new_payload().with_cause(err)\n }\n}\n\n/// A set of errors that can occur during dispatching HTTP requests.\n#[derive(Debug, Display, From)]\n#[non_exhaustive]\npub enum DispatchError {\n /// Service error.\n #[display(\"service error\")]\n Service(Response),\n\n /// Body streaming error.\n #[display(\"body error: {}\", _0)]\n Body(Box),\n\n /// Upgrade service error.\n #[display(\"upgrade error\")]\n Upgrade,\n\n /// An `io::Error` that occurred while trying to read or write to a network stream.\n #[display(\"I/O error: {}\", _0)]\n Io(io::Error),\n\n /// Request parse error.\n #[display(\"request parse error: {}\", _0)]\n Parse(ParseError),\n\n /// HTTP/2 error.\n #[display(\"{}\", _0)]\n #[cfg(feature = \"http2\")]\n H2(h2::Error),\n\n /// The first request did not complete within the specified timeout.\n #[display(\"request did not complete within the specified timeout\")]\n SlowRequestTimeout,\n\n /// Disconnect timeout. Makes sense for TLS streams.\n #[display(\"connection shutdown timeout\")]\n DisconnectTimeout,\n\n /// Handler dropped payload before reading EOF.\n #[display(\"handler dropped payload before reading EOF\")]\n HandlerDroppedPayload,\n\n /// Internal error.\n #[display(\"internal error\")]\n InternalError,\n}\n\nimpl StdError for DispatchError {\n fn source(&self) -> Option<&(dyn StdError + 'static)> {\n match self {\n DispatchError::Service(_res) => None,\n DispatchError::Body(err) => Some(&**err),\n DispatchError::Io(err) => Some(err),\n DispatchError::Parse(err) => Some(err),\n\n #[cfg(feature = \"http2\")]\n DispatchError::H2(err) => Some(err),\n\n _ => None,\n }\n }\n}\n\n/// A set of error that can occur during parsing content type.\n#[derive(Debug, Display, Error)]\n#[cfg_attr(test, derive(PartialEq, Eq))]\n#[non_exhaustive]\npub enum ContentTypeError {\n /// Can not parse content type.\n #[display(\"could not parse content type\")]\n ParseError,\n\n /// Unknown content encoding.\n #[display(\"unknown content encoding\")]\n UnknownEncoding,\n}\n\n#[cfg(test)]\nmod tests {\n use http::Error as HttpError;\n\n use super::*;\n\n #[test]\n fn test_into_response() {\n let resp: Response = ParseError::Incomplete.into();\n assert_eq!(resp.status(), StatusCode::BAD_REQUEST);\n\n let err: HttpError = StatusCode::from_u16(10000).err().unwrap().into();\n let resp: Response = Error::new_http().with_cause(err).into();\n assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR);\n }\n\n #[test]\n fn test_as_response() {\n let orig = io::Error::other(\"other\");\n let err: Error = ParseError::Io(orig).into();\n assert_eq!(\n format!(\"{}\", err),\n \"error parsing HTTP message: I/O error: other\"\n );\n }\n\n #[test]\n fn test_error_display() {\n let orig = io::Error::other(\"other\");\n let err = Error::new_io().with_cause(orig);\n assert_eq!(\"connection error: other\", err.to_string());\n }\n\n #[test]\n fn test_error_http_response() {\n let orig = io::Error::other(\"other\");\n let err = Error::new_io().with_cause(orig);\n let resp: Response = err.into();\n assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR);\n }\n\n #[test]\n fn test_payload_error() {\n let err: PayloadError = io::Error::other(\"ParseError\").into();\n assert!(err.to_string().contains(\"ParseError\"));\n\n let err = PayloadError::Incomplete(None);\n assert_eq!(\n err.to_string(),\n \"payload reached EOF before completing: None\"\n );\n }\n\n macro_rules! from {\n ($from:expr => $error:pat) => {\n match ParseError::from($from) {\n err @ $error => {\n assert!(err.to_string().len() >= 5);\n }\n err => unreachable!(\"{:?}\", err),\n }\n };\n }\n\n macro_rules! from_and_cause {\n ($from:expr => $error:pat) => {\n match ParseError::from($from) {\n e @ $error => {\n let desc = format!(\"{}\", e);\n assert_eq!(desc, format!(\"I/O error: {}\", $from));\n }\n _ => unreachable!(\"{:?}\", $from),\n }\n };\n }\n\n #[test]\n fn test_from() {\n from_and_cause!(io::Error::other(\"other\") => ParseError::Io(..));\n from!(httparse::Error::HeaderName => ParseError::Header);\n from!(httparse::Error::HeaderName => ParseError::Header);\n from!(httparse::Error::HeaderValue => ParseError::Header);\n from!(httparse::Error::NewLine => ParseError::Header);\n from!(httparse::Error::Status => ParseError::Status);\n from!(httparse::Error::Token => ParseError::Header);\n from!(httparse::Error::TooManyHeaders => ParseError::TooLarge);\n from!(httparse::Error::Version => ParseError::Version);\n }\n}\n" }, { "path": "actix-http/src/extensions.rs", "content": "use std::{\n any::{Any, TypeId},\n collections::HashMap,\n fmt,\n hash::{BuildHasherDefault, Hasher},\n};\n\n/// A hasher for `TypeId`s that takes advantage of its known characteristics.\n///\n/// Author of `anymap` crate has done research on the topic:\n/// https://github.com/chris-morgan/anymap/blob/2e9a5704/src/lib.rs#L599\n#[derive(Debug, Default)]\nstruct NoOpHasher(u64);\n\nimpl Hasher for NoOpHasher {\n fn write(&mut self, _bytes: &[u8]) {\n unimplemented!(\"This NoOpHasher can only handle u64s\")\n }\n\n fn write_u64(&mut self, i: u64) {\n self.0 = i;\n }\n\n fn finish(&self) -> u64 {\n self.0\n }\n}\n\n/// A type map for request extensions.\n///\n/// All entries into this map must be owned types (or static references).\n#[derive(Default)]\npub struct Extensions {\n // use no-op hasher with a std HashMap with for faster lookups on the small `TypeId` keys\n map: HashMap, BuildHasherDefault>,\n}\n\nimpl Extensions {\n /// Creates an empty `Extensions`.\n #[inline]\n pub fn new() -> Extensions {\n Extensions {\n map: HashMap::default(),\n }\n }\n\n /// Insert an item into the map.\n ///\n /// If an item of this type was already stored, it will be replaced and returned.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n /// assert_eq!(map.insert(\"\"), None);\n /// assert_eq!(map.insert(1u32), None);\n /// assert_eq!(map.insert(2u32), Some(1u32));\n /// assert_eq!(*map.get::().unwrap(), 2u32);\n /// ```\n pub fn insert(&mut self, val: T) -> Option {\n self.map\n .insert(TypeId::of::(), Box::new(val))\n .and_then(downcast_owned)\n }\n\n /// Check if map contains an item of a given type.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n /// assert!(!map.contains::());\n ///\n /// assert_eq!(map.insert(1u32), None);\n /// assert!(map.contains::());\n /// ```\n pub fn contains(&self) -> bool {\n self.map.contains_key(&TypeId::of::())\n }\n\n /// Get a reference to an item of a given type.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n /// map.insert(1u32);\n /// assert_eq!(map.get::(), Some(&1u32));\n /// ```\n pub fn get(&self) -> Option<&T> {\n self.map\n .get(&TypeId::of::())\n .and_then(|boxed| boxed.downcast_ref())\n }\n\n /// Get a mutable reference to an item of a given type.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n /// map.insert(1u32);\n /// assert_eq!(map.get_mut::(), Some(&mut 1u32));\n /// ```\n pub fn get_mut(&mut self) -> Option<&mut T> {\n self.map\n .get_mut(&TypeId::of::())\n .and_then(|boxed| boxed.downcast_mut())\n }\n\n /// Inserts the given `value` into the extensions if it is not present, then returns a reference\n /// to the value in the extensions.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n /// assert_eq!(map.get::>(), None);\n ///\n /// map.get_or_insert(Vec::::new()).push(1);\n /// assert_eq!(map.get::>(), Some(&vec![1]));\n ///\n /// map.get_or_insert(Vec::::new()).push(2);\n /// assert_eq!(map.get::>(), Some(&vec![1,2]));\n /// ```\n pub fn get_or_insert(&mut self, value: T) -> &mut T {\n self.get_or_insert_with(|| value)\n }\n\n /// Inserts a value computed from `f` into the extensions if the given `value` is not present,\n /// then returns a reference to the value in the extensions.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n /// assert_eq!(map.get::>(), None);\n ///\n /// map.get_or_insert_with(Vec::::new).push(1);\n /// assert_eq!(map.get::>(), Some(&vec![1]));\n ///\n /// map.get_or_insert_with(Vec::::new).push(2);\n /// assert_eq!(map.get::>(), Some(&vec![1,2]));\n /// ```\n pub fn get_or_insert_with T>(&mut self, default: F) -> &mut T {\n self.map\n .entry(TypeId::of::())\n .or_insert_with(|| Box::new(default()))\n .downcast_mut()\n .expect(\"extensions map should now contain a T value\")\n }\n\n /// Remove an item from the map of a given type.\n ///\n /// If an item of this type was already stored, it will be returned.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n ///\n /// map.insert(1u32);\n /// assert_eq!(map.get::(), Some(&1u32));\n ///\n /// assert_eq!(map.remove::(), Some(1u32));\n /// assert!(!map.contains::());\n /// ```\n pub fn remove(&mut self) -> Option {\n self.map.remove(&TypeId::of::()).and_then(downcast_owned)\n }\n\n /// Clear the `Extensions` of all inserted extensions.\n ///\n /// ```\n /// # use actix_http::Extensions;\n /// let mut map = Extensions::new();\n ///\n /// map.insert(1u32);\n /// assert!(map.contains::());\n ///\n /// map.clear();\n /// assert!(!map.contains::());\n /// ```\n #[inline]\n pub fn clear(&mut self) {\n self.map.clear();\n }\n\n /// Extends self with the items from another `Extensions`.\n pub fn extend(&mut self, other: Extensions) {\n self.map.extend(other.map);\n }\n}\n\nimpl fmt::Debug for Extensions {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"Extensions\").finish()\n }\n}\n\nfn downcast_owned(boxed: Box) -> Option {\n boxed.downcast().ok().map(|boxed| *boxed)\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n\n #[test]\n fn test_remove() {\n let mut map = Extensions::new();\n\n map.insert::(123);\n assert!(map.get::().is_some());\n\n map.remove::();\n assert!(map.get::().is_none());\n }\n\n #[test]\n fn test_clear() {\n let mut map = Extensions::new();\n\n map.insert::(8);\n map.insert::(16);\n map.insert::(32);\n\n assert!(map.contains::());\n assert!(map.contains::());\n assert!(map.contains::());\n\n map.clear();\n\n assert!(!map.contains::());\n assert!(!map.contains::());\n assert!(!map.contains::());\n\n map.insert::(10);\n assert_eq!(*map.get::().unwrap(), 10);\n }\n\n #[test]\n fn test_integers() {\n static A: u32 = 8;\n\n let mut map = Extensions::new();\n\n map.insert::(8);\n map.insert::(16);\n map.insert::(32);\n map.insert::(64);\n map.insert::(128);\n map.insert::(8);\n map.insert::(16);\n map.insert::(32);\n map.insert::(64);\n map.insert::(128);\n map.insert::<&'static u32>(&A);\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::().is_some());\n assert!(map.get::<&'static u32>().is_some());\n }\n\n #[test]\n fn test_composition() {\n struct Magi(pub T);\n\n struct Madoka {\n pub god: bool,\n }\n\n struct Homura {\n pub attempts: usize,\n }\n\n struct Mami {\n pub guns: usize,\n }\n\n let mut map = Extensions::new();\n\n map.insert(Magi(Madoka { god: false }));\n map.insert(Magi(Homura { attempts: 0 }));\n map.insert(Magi(Mami { guns: 999 }));\n\n assert!(!map.get::>().unwrap().0.god);\n assert_eq!(0, map.get::>().unwrap().0.attempts);\n assert_eq!(999, map.get::>().unwrap().0.guns);\n }\n\n #[test]\n fn test_extensions() {\n #[derive(Debug, PartialEq)]\n struct MyType(i32);\n\n let mut extensions = Extensions::new();\n\n extensions.insert(5i32);\n extensions.insert(MyType(10));\n\n assert_eq!(extensions.get(), Some(&5i32));\n assert_eq!(extensions.get_mut(), Some(&mut 5i32));\n\n assert_eq!(extensions.remove::(), Some(5i32));\n assert!(extensions.get::().is_none());\n\n assert_eq!(extensions.get::(), None);\n assert_eq!(extensions.get(), Some(&MyType(10)));\n }\n\n #[test]\n fn test_extend() {\n #[derive(Debug, PartialEq)]\n struct MyType(i32);\n\n let mut extensions = Extensions::new();\n\n extensions.insert(5i32);\n extensions.insert(MyType(10));\n\n let mut other = Extensions::new();\n\n other.insert(15i32);\n other.insert(20u8);\n\n extensions.extend(other);\n\n assert_eq!(extensions.get(), Some(&15i32));\n assert_eq!(extensions.get_mut(), Some(&mut 15i32));\n\n assert_eq!(extensions.remove::(), Some(15i32));\n assert!(extensions.get::().is_none());\n\n assert_eq!(extensions.get::(), None);\n assert_eq!(extensions.get(), Some(&MyType(10)));\n\n assert_eq!(extensions.get(), Some(&20u8));\n assert_eq!(extensions.get_mut(), Some(&mut 20u8));\n }\n}\n" }, { "path": "actix-http/src/h1/chunked.rs", "content": "use std::{io, task::Poll};\n\nuse bytes::{Buf as _, Bytes, BytesMut};\nuse tracing::{debug, trace};\n\nmacro_rules! byte (\n ($rdr:ident) => ({\n if $rdr.len() > 0 {\n let b = $rdr[0];\n $rdr.advance(1);\n b\n } else {\n return Poll::Pending\n }\n })\n);\n\n#[derive(Debug, Clone, PartialEq, Eq)]\npub(super) enum ChunkedState {\n Size,\n SizeLws,\n Extension,\n SizeLf,\n Body,\n BodyCr,\n BodyLf,\n EndCr,\n EndLf,\n End,\n}\n\nimpl ChunkedState {\n pub(super) fn step(\n &self,\n body: &mut BytesMut,\n size: &mut u64,\n buf: &mut Option,\n ) -> Poll> {\n use self::ChunkedState::*;\n match *self {\n Size => ChunkedState::read_size(body, size),\n SizeLws => ChunkedState::read_size_lws(body),\n Extension => ChunkedState::read_extension(body),\n SizeLf => ChunkedState::read_size_lf(body, *size),\n Body => ChunkedState::read_body(body, size, buf),\n BodyCr => ChunkedState::read_body_cr(body),\n BodyLf => ChunkedState::read_body_lf(body),\n EndCr => ChunkedState::read_end_cr(body),\n EndLf => ChunkedState::read_end_lf(body),\n End => Poll::Ready(Ok(ChunkedState::End)),\n }\n }\n\n fn read_size(rdr: &mut BytesMut, size: &mut u64) -> Poll> {\n let radix = 16;\n\n let rem = match byte!(rdr) {\n b @ b'0'..=b'9' => b - b'0',\n b @ b'a'..=b'f' => b + 10 - b'a',\n b @ b'A'..=b'F' => b + 10 - b'A',\n b'\\t' | b' ' => return Poll::Ready(Ok(ChunkedState::SizeLws)),\n b';' => return Poll::Ready(Ok(ChunkedState::Extension)),\n b'\\r' => return Poll::Ready(Ok(ChunkedState::SizeLf)),\n _ => {\n return Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk size line: Invalid Size\",\n )));\n }\n };\n\n match size.checked_mul(radix) {\n Some(n) => {\n *size = n;\n *size += rem as u64;\n\n Poll::Ready(Ok(ChunkedState::Size))\n }\n None => {\n debug!(\"chunk size would overflow u64\");\n Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk size line: Size is too big\",\n )))\n }\n }\n }\n\n fn read_size_lws(rdr: &mut BytesMut) -> Poll> {\n match byte!(rdr) {\n // LWS can follow the chunk size, but no more digits can come\n b'\\t' | b' ' => Poll::Ready(Ok(ChunkedState::SizeLws)),\n b';' => Poll::Ready(Ok(ChunkedState::Extension)),\n b'\\r' => Poll::Ready(Ok(ChunkedState::SizeLf)),\n _ => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk size linear white space\",\n ))),\n }\n }\n fn read_extension(rdr: &mut BytesMut) -> Poll> {\n match byte!(rdr) {\n b'\\r' => Poll::Ready(Ok(ChunkedState::SizeLf)),\n // strictly 0x20 (space) should be disallowed but we don't parse quoted strings here\n 0x00..=0x08 | 0x0a..=0x1f | 0x7f => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid character in chunk extension\",\n ))),\n _ => Poll::Ready(Ok(ChunkedState::Extension)), // no supported extensions\n }\n }\n fn read_size_lf(rdr: &mut BytesMut, size: u64) -> Poll> {\n match byte!(rdr) {\n b'\\n' if size > 0 => Poll::Ready(Ok(ChunkedState::Body)),\n b'\\n' if size == 0 => Poll::Ready(Ok(ChunkedState::EndCr)),\n _ => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk size LF\",\n ))),\n }\n }\n\n fn read_body(\n rdr: &mut BytesMut,\n rem: &mut u64,\n buf: &mut Option,\n ) -> Poll> {\n trace!(\"Chunked read, remaining={:?}\", rem);\n\n let len = rdr.len() as u64;\n if len == 0 {\n Poll::Ready(Ok(ChunkedState::Body))\n } else {\n let slice;\n if *rem > len {\n slice = rdr.split().freeze();\n *rem -= len;\n } else {\n slice = rdr.split_to(*rem as usize).freeze();\n *rem = 0;\n }\n *buf = Some(slice);\n if *rem > 0 {\n Poll::Ready(Ok(ChunkedState::Body))\n } else {\n Poll::Ready(Ok(ChunkedState::BodyCr))\n }\n }\n }\n\n fn read_body_cr(rdr: &mut BytesMut) -> Poll> {\n match byte!(rdr) {\n b'\\r' => Poll::Ready(Ok(ChunkedState::BodyLf)),\n _ => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk body CR\",\n ))),\n }\n }\n fn read_body_lf(rdr: &mut BytesMut) -> Poll> {\n match byte!(rdr) {\n b'\\n' => Poll::Ready(Ok(ChunkedState::Size)),\n _ => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk body LF\",\n ))),\n }\n }\n fn read_end_cr(rdr: &mut BytesMut) -> Poll> {\n match byte!(rdr) {\n b'\\r' => Poll::Ready(Ok(ChunkedState::EndLf)),\n _ => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk end CR\",\n ))),\n }\n }\n fn read_end_lf(rdr: &mut BytesMut) -> Poll> {\n match byte!(rdr) {\n b'\\n' => Poll::Ready(Ok(ChunkedState::End)),\n _ => Poll::Ready(Err(io::Error::new(\n io::ErrorKind::InvalidInput,\n \"Invalid chunk end LF\",\n ))),\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use actix_codec::Decoder as _;\n use bytes::{Bytes, BytesMut};\n use http::Method;\n\n use crate::{\n error::ParseError,\n h1::decoder::{MessageDecoder, PayloadItem},\n HttpMessage as _, Request,\n };\n\n macro_rules! parse_ready {\n ($e:expr) => {{\n match MessageDecoder::::default().decode($e) {\n Ok(Some((msg, _))) => msg,\n Ok(_) => unreachable!(\"Eof during parsing http request\"),\n Err(err) => unreachable!(\"Error during parsing http request: {:?}\", err),\n }\n }};\n }\n\n macro_rules! expect_parse_err {\n ($e:expr) => {{\n match MessageDecoder::::default().decode($e) {\n Err(err) => match err {\n ParseError::Io(_) => unreachable!(\"Parse error expected\"),\n _ => {}\n },\n _ => unreachable!(\"Error expected\"),\n }\n }};\n }\n\n #[test]\n fn test_parse_chunked_payload_chunk_extension() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\\n \\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (msg, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n assert!(msg.chunked().unwrap());\n\n buf.extend(b\"4;test\\r\\ndata\\r\\n4\\r\\nline\\r\\n0\\r\\n\\r\\n\"); // test: test\\r\\n\\r\\n\")\n let chunk = pl.decode(&mut buf).unwrap().unwrap().chunk();\n assert_eq!(chunk, Bytes::from_static(b\"data\"));\n let chunk = pl.decode(&mut buf).unwrap().unwrap().chunk();\n assert_eq!(chunk, Bytes::from_static(b\"line\"));\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert!(msg.eof());\n }\n\n #[test]\n fn test_request_chunked() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\",\n );\n let req = parse_ready!(&mut buf);\n\n if let Ok(val) = req.chunked() {\n assert!(val);\n } else {\n unreachable!(\"Error\");\n }\n\n // intentional typo in \"chunked\"\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chnked\\r\\n\\r\\n\",\n );\n expect_parse_err!(&mut buf);\n }\n\n #[test]\n fn test_http_request_chunked_payload() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\",\n );\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n assert!(req.chunked().unwrap());\n\n buf.extend(b\"4\\r\\ndata\\r\\n4\\r\\nline\\r\\n0\\r\\n\\r\\n\");\n assert_eq!(\n pl.decode(&mut buf).unwrap().unwrap().chunk().as_ref(),\n b\"data\"\n );\n assert_eq!(\n pl.decode(&mut buf).unwrap().unwrap().chunk().as_ref(),\n b\"line\"\n );\n assert!(pl.decode(&mut buf).unwrap().unwrap().eof());\n }\n\n #[test]\n fn test_http_request_chunked_payload_and_next_message() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\",\n );\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n assert!(req.chunked().unwrap());\n\n buf.extend(\n b\"4\\r\\ndata\\r\\n4\\r\\nline\\r\\n0\\r\\n\\r\\n\\\n POST /test2 HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\"\n .iter(),\n );\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"data\");\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"line\");\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert!(msg.eof());\n\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert!(req.chunked().unwrap());\n assert_eq!(*req.method(), Method::POST);\n assert!(req.chunked().unwrap());\n }\n\n #[test]\n fn test_http_request_chunked_payload_chunks() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n assert!(req.chunked().unwrap());\n\n buf.extend(b\"4\\r\\n1111\\r\\n\");\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"1111\");\n\n buf.extend(b\"4\\r\\ndata\\r\");\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"data\");\n\n buf.extend(b\"\\n4\");\n assert!(pl.decode(&mut buf).unwrap().is_none());\n\n buf.extend(b\"\\r\");\n assert!(pl.decode(&mut buf).unwrap().is_none());\n buf.extend(b\"\\n\");\n assert!(pl.decode(&mut buf).unwrap().is_none());\n\n buf.extend(b\"li\");\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"li\");\n\n //trailers\n //buf.feed_data(\"test: test\\r\\n\");\n //not_ready!(reader.parse(&mut buf, &mut readbuf));\n\n buf.extend(b\"ne\\r\\n0\\r\\n\");\n let msg = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"ne\");\n assert!(pl.decode(&mut buf).unwrap().is_none());\n\n buf.extend(b\"\\r\\n\");\n assert!(pl.decode(&mut buf).unwrap().unwrap().eof());\n }\n\n #[test]\n fn chunk_extension_quoted() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n Host: localhost:8080\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n 2;hello=b;one=\\\"1 2 3\\\"\\r\\n\\\n xx\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (_msg, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n\n let chunk = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(chunk, PayloadItem::Chunk(Bytes::from_static(b\"xx\")));\n }\n\n #[test]\n fn hrs_chunk_extension_invalid() {\n let mut buf = BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: localhost:8080\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n 2;x\\nx\\r\\n\\\n 4c\\r\\n\\\n 0\\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (_msg, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n\n let err = pl.decode(&mut buf).unwrap_err();\n assert!(err\n .to_string()\n .contains(\"Invalid character in chunk extension\"));\n }\n\n #[test]\n fn hrs_chunk_size_overflow() {\n let mut buf = BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n f0000000000000003\\r\\n\\\n abc\\r\\n\\\n 0\\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (_msg, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n\n let err = pl.decode(&mut buf).unwrap_err();\n assert!(err\n .to_string()\n .contains(\"Invalid chunk size line: Size is too big\"));\n }\n}\n" }, { "path": "actix-http/src/h1/client.rs", "content": "use std::{fmt, io};\n\nuse bitflags::bitflags;\nuse bytes::{Bytes, BytesMut};\nuse http::{Method, Version};\nuse tokio_util::codec::{Decoder, Encoder};\n\nuse super::{\n decoder::{self, PayloadDecoder, PayloadItem, PayloadType},\n encoder, reserve_readbuf, Message, MessageType,\n};\nuse crate::{\n body::BodySize,\n error::{ParseError, PayloadError},\n ConnectionType, RequestHeadType, ResponseHead, ServiceConfig,\n};\n\nbitflags! {\n #[derive(Debug, Clone, Copy)]\n struct Flags: u8 {\n const HEAD = 0b0000_0001;\n const KEEP_ALIVE_ENABLED = 0b0000_1000;\n const STREAM = 0b0001_0000;\n }\n}\n\n/// HTTP/1 Codec\npub struct ClientCodec {\n inner: ClientCodecInner,\n}\n\n/// HTTP/1 Payload Codec\npub struct ClientPayloadCodec {\n inner: ClientCodecInner,\n}\n\nstruct ClientCodecInner {\n config: ServiceConfig,\n decoder: decoder::MessageDecoder,\n payload: Option,\n version: Version,\n conn_type: ConnectionType,\n\n // encoder part\n flags: Flags,\n encoder: encoder::MessageEncoder,\n}\n\nimpl Default for ClientCodec {\n fn default() -> Self {\n ClientCodec::new(ServiceConfig::default())\n }\n}\n\nimpl fmt::Debug for ClientCodec {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"h1::ClientCodec\")\n .field(\"flags\", &self.inner.flags)\n .finish_non_exhaustive()\n }\n}\n\nimpl ClientCodec {\n /// Create HTTP/1 codec.\n ///\n /// `keepalive_enabled` how response `connection` header get generated.\n pub fn new(config: ServiceConfig) -> Self {\n let flags = if config.keep_alive().enabled() {\n Flags::KEEP_ALIVE_ENABLED\n } else {\n Flags::empty()\n };\n\n ClientCodec {\n inner: ClientCodecInner {\n config,\n decoder: decoder::MessageDecoder::default(),\n payload: None,\n version: Version::HTTP_11,\n conn_type: ConnectionType::Close,\n\n flags,\n encoder: encoder::MessageEncoder::default(),\n },\n }\n }\n\n /// Check if request is upgrade\n pub fn upgrade(&self) -> bool {\n self.inner.conn_type == ConnectionType::Upgrade\n }\n\n /// Check if last response is keep-alive\n pub fn keep_alive(&self) -> bool {\n self.inner.conn_type == ConnectionType::KeepAlive\n }\n\n /// Check last request's message type\n pub fn message_type(&self) -> MessageType {\n if self.inner.flags.contains(Flags::STREAM) {\n MessageType::Stream\n } else if self.inner.payload.is_none() {\n MessageType::None\n } else {\n MessageType::Payload\n }\n }\n\n /// Convert message codec to a payload codec\n pub fn into_payload_codec(self) -> ClientPayloadCodec {\n ClientPayloadCodec { inner: self.inner }\n }\n}\n\nimpl ClientPayloadCodec {\n /// Check if last response is keep-alive\n pub fn keep_alive(&self) -> bool {\n self.inner.conn_type == ConnectionType::KeepAlive\n }\n\n /// Transform payload codec to a message codec\n pub fn into_message_codec(self) -> ClientCodec {\n ClientCodec { inner: self.inner }\n }\n}\n\nimpl Decoder for ClientCodec {\n type Item = ResponseHead;\n type Error = ParseError;\n\n fn decode(&mut self, src: &mut BytesMut) -> Result, Self::Error> {\n debug_assert!(\n self.inner.payload.is_none(),\n \"Payload decoder should not be set\"\n );\n\n if let Some((req, payload)) = self.inner.decoder.decode(src)? {\n if let Some(conn_type) = req.conn_type() {\n // do not use peer's keep-alive\n self.inner.conn_type = if conn_type == ConnectionType::KeepAlive {\n self.inner.conn_type\n } else {\n conn_type\n };\n }\n\n if !self.inner.flags.contains(Flags::HEAD) {\n match payload {\n PayloadType::None => self.inner.payload = None,\n PayloadType::Payload(pl) => self.inner.payload = Some(pl),\n PayloadType::Stream(pl) => {\n self.inner.payload = Some(pl);\n self.inner.flags.insert(Flags::STREAM);\n }\n }\n } else {\n self.inner.payload = None;\n }\n reserve_readbuf(src);\n Ok(Some(req))\n } else {\n Ok(None)\n }\n }\n}\n\nimpl Decoder for ClientPayloadCodec {\n type Item = Option;\n type Error = PayloadError;\n\n fn decode(&mut self, src: &mut BytesMut) -> Result, Self::Error> {\n debug_assert!(\n self.inner.payload.is_some(),\n \"Payload decoder is not specified\"\n );\n\n Ok(match self.inner.payload.as_mut().unwrap().decode(src)? {\n Some(PayloadItem::Chunk(chunk)) => {\n reserve_readbuf(src);\n Some(Some(chunk))\n }\n Some(PayloadItem::Eof) => {\n self.inner.payload.take();\n Some(None)\n }\n None => None,\n })\n }\n}\n\nimpl Encoder> for ClientCodec {\n type Error = io::Error;\n\n fn encode(\n &mut self,\n item: Message<(RequestHeadType, BodySize)>,\n dst: &mut BytesMut,\n ) -> Result<(), Self::Error> {\n match item {\n Message::Item((mut head, length)) => {\n let inner = &mut self.inner;\n inner.version = head.as_ref().version;\n inner\n .flags\n .set(Flags::HEAD, head.as_ref().method == Method::HEAD);\n\n // connection status\n inner.conn_type = match head.as_ref().connection_type() {\n ConnectionType::KeepAlive => {\n if inner.flags.contains(Flags::KEEP_ALIVE_ENABLED) {\n ConnectionType::KeepAlive\n } else {\n ConnectionType::Close\n }\n }\n ConnectionType::Upgrade => ConnectionType::Upgrade,\n ConnectionType::Close => ConnectionType::Close,\n };\n\n inner.encoder.encode(\n dst,\n &mut head,\n false,\n false,\n inner.version,\n length,\n inner.conn_type,\n &inner.config,\n )?;\n }\n Message::Chunk(Some(bytes)) => {\n self.inner.encoder.encode_chunk(bytes.as_ref(), dst)?;\n }\n Message::Chunk(None) => {\n self.inner.encoder.encode_eof(dst)?;\n }\n }\n Ok(())\n }\n}\n" }, { "path": "actix-http/src/h1/codec.rs", "content": "use std::{fmt, io};\n\nuse bitflags::bitflags;\nuse bytes::BytesMut;\nuse http::{Method, Version};\nuse tokio_util::codec::{Decoder, Encoder};\n\nuse super::{\n decoder::{self, PayloadDecoder, PayloadItem, PayloadType},\n encoder, Message, MessageType,\n};\nuse crate::{body::BodySize, error::ParseError, ConnectionType, Request, Response, ServiceConfig};\n\nbitflags! {\n #[derive(Debug, Clone, Copy)]\n struct Flags: u8 {\n const HEAD = 0b0000_0001;\n const KEEP_ALIVE_ENABLED = 0b0000_0010;\n const STREAM = 0b0000_0100;\n }\n}\n\n/// HTTP/1 Codec\npub struct Codec {\n config: ServiceConfig,\n decoder: decoder::MessageDecoder,\n payload: Option,\n version: Version,\n conn_type: ConnectionType,\n\n // encoder part\n flags: Flags,\n encoder: encoder::MessageEncoder>,\n}\n\nimpl Default for Codec {\n fn default() -> Self {\n Codec::new(ServiceConfig::default())\n }\n}\n\nimpl fmt::Debug for Codec {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"h1::Codec\")\n .field(\"flags\", &self.flags)\n .finish_non_exhaustive()\n }\n}\n\nimpl Codec {\n /// Create HTTP/1 codec.\n ///\n /// `keepalive_enabled` how response `connection` header get generated.\n pub fn new(config: ServiceConfig) -> Self {\n let flags = if config.keep_alive().enabled() {\n Flags::KEEP_ALIVE_ENABLED\n } else {\n Flags::empty()\n };\n\n Codec {\n config,\n flags,\n decoder: decoder::MessageDecoder::default(),\n payload: None,\n version: Version::HTTP_11,\n conn_type: ConnectionType::Close,\n encoder: encoder::MessageEncoder::default(),\n }\n }\n\n /// Check if request is upgrade.\n #[inline]\n pub fn upgrade(&self) -> bool {\n self.conn_type == ConnectionType::Upgrade\n }\n\n /// Check if last response is keep-alive.\n #[inline]\n pub fn keep_alive(&self) -> bool {\n self.conn_type == ConnectionType::KeepAlive\n }\n\n /// Check if keep-alive enabled on server level.\n #[inline]\n pub fn keep_alive_enabled(&self) -> bool {\n self.flags.contains(Flags::KEEP_ALIVE_ENABLED)\n }\n\n /// Check last request's message type.\n #[inline]\n pub fn message_type(&self) -> MessageType {\n if self.flags.contains(Flags::STREAM) {\n MessageType::Stream\n } else if self.payload.is_none() {\n MessageType::None\n } else {\n MessageType::Payload\n }\n }\n\n #[inline]\n pub fn config(&self) -> &ServiceConfig {\n &self.config\n }\n}\n\nimpl Decoder for Codec {\n type Item = Message;\n type Error = ParseError;\n\n fn decode(&mut self, src: &mut BytesMut) -> Result, Self::Error> {\n if let Some(ref mut payload) = self.payload {\n Ok(match payload.decode(src)? {\n Some(PayloadItem::Chunk(chunk)) => Some(Message::Chunk(Some(chunk))),\n Some(PayloadItem::Eof) => {\n self.payload.take();\n Some(Message::Chunk(None))\n }\n None => None,\n })\n } else if let Some((req, payload)) = self.decoder.decode(src)? {\n let head = req.head();\n self.flags.set(Flags::HEAD, head.method == Method::HEAD);\n self.version = head.version;\n self.conn_type = head.connection_type();\n\n if self.conn_type == ConnectionType::KeepAlive\n && !self.flags.contains(Flags::KEEP_ALIVE_ENABLED)\n {\n self.conn_type = ConnectionType::Close\n }\n\n match payload {\n PayloadType::None => self.payload = None,\n PayloadType::Payload(pl) => self.payload = Some(pl),\n PayloadType::Stream(pl) => {\n self.payload = Some(pl);\n self.flags.insert(Flags::STREAM);\n }\n }\n Ok(Some(Message::Item(req)))\n } else {\n Ok(None)\n }\n }\n}\n\nimpl Encoder, BodySize)>> for Codec {\n type Error = io::Error;\n\n fn encode(\n &mut self,\n item: Message<(Response<()>, BodySize)>,\n dst: &mut BytesMut,\n ) -> Result<(), Self::Error> {\n match item {\n Message::Item((mut res, length)) => {\n // set response version\n res.head_mut().version = self.version;\n\n // connection status\n self.conn_type = if let Some(ct) = res.head().conn_type() {\n if ct == ConnectionType::KeepAlive {\n self.conn_type\n } else {\n ct\n }\n } else {\n self.conn_type\n };\n\n // encode message\n self.encoder.encode(\n dst,\n &mut res,\n self.flags.contains(Flags::HEAD),\n self.flags.contains(Flags::STREAM),\n self.version,\n length,\n self.conn_type,\n &self.config,\n )?;\n }\n\n Message::Chunk(Some(bytes)) => {\n self.encoder.encode_chunk(bytes.as_ref(), dst)?;\n }\n\n Message::Chunk(None) => {\n self.encoder.encode_eof(dst)?;\n }\n }\n\n Ok(())\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n use crate::HttpMessage as _;\n\n #[actix_rt::test]\n async fn test_http_request_chunked_payload_and_next_message() {\n let mut codec = Codec::default();\n\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\",\n );\n let item = codec.decode(&mut buf).unwrap().unwrap();\n let req = item.message();\n\n assert_eq!(req.method(), Method::GET);\n assert!(req.chunked().unwrap());\n\n buf.extend(\n b\"4\\r\\ndata\\r\\n4\\r\\nline\\r\\n0\\r\\n\\r\\n\\\n POST /test2 HTTP/1.1\\r\\n\\\n transfer-encoding: chunked\\r\\n\\r\\n\"\n .iter(),\n );\n\n let msg = codec.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"data\");\n\n let msg = codec.decode(&mut buf).unwrap().unwrap();\n assert_eq!(msg.chunk().as_ref(), b\"line\");\n\n let msg = codec.decode(&mut buf).unwrap().unwrap();\n assert!(msg.eof());\n\n // decode next message\n let item = codec.decode(&mut buf).unwrap().unwrap();\n let req = item.message();\n assert_eq!(*req.method(), Method::POST);\n assert!(req.chunked().unwrap());\n }\n}\n" }, { "path": "actix-http/src/h1/decoder.rs", "content": "use std::{io, marker::PhantomData, mem::MaybeUninit, task::Poll};\n\nuse actix_codec::Decoder;\nuse bytes::{Bytes, BytesMut};\nuse http::{\n header::{self, HeaderName, HeaderValue},\n Method, StatusCode, Uri, Version,\n};\nuse tracing::{debug, error, trace};\n\nuse super::chunked::ChunkedState;\nuse crate::{error::ParseError, header::HeaderMap, ConnectionType, Request, ResponseHead};\n\npub(crate) const MAX_BUFFER_SIZE: usize = 131_072;\nconst MAX_HEADERS: usize = 96;\n\n/// Incoming message decoder\npub(crate) struct MessageDecoder(PhantomData);\n\n#[derive(Debug)]\n/// Incoming request type\npub(crate) enum PayloadType {\n None,\n Payload(PayloadDecoder),\n Stream(PayloadDecoder),\n}\n\nimpl Default for MessageDecoder {\n fn default() -> Self {\n MessageDecoder(PhantomData)\n }\n}\n\nimpl Decoder for MessageDecoder {\n type Item = (T, PayloadType);\n type Error = ParseError;\n\n fn decode(&mut self, src: &mut BytesMut) -> Result, Self::Error> {\n T::decode(src)\n }\n}\n\npub(crate) enum PayloadLength {\n Payload(PayloadType),\n UpgradeWebSocket,\n None,\n}\n\nimpl PayloadLength {\n /// Returns true if variant is `None`.\n fn is_none(&self) -> bool {\n matches!(self, Self::None)\n }\n\n /// Returns true if variant is represents zero-length (not none) payload.\n fn is_zero(&self) -> bool {\n matches!(\n self,\n PayloadLength::Payload(PayloadType::Payload(PayloadDecoder {\n kind: Kind::Length(0)\n }))\n )\n }\n}\n\npub(crate) trait MessageType: Sized {\n fn set_connection_type(&mut self, conn_type: Option);\n\n fn set_expect(&mut self);\n\n fn headers_mut(&mut self) -> &mut HeaderMap;\n\n fn decode(src: &mut BytesMut) -> Result, ParseError>;\n\n fn set_headers(\n &mut self,\n slice: &Bytes,\n raw_headers: &[HeaderIndex],\n version: Version,\n ) -> Result {\n let mut ka = None;\n let mut has_upgrade_websocket = false;\n let mut expect = false;\n let mut chunked = false;\n let mut seen_te = false;\n let mut content_length = None;\n\n {\n let headers = self.headers_mut();\n\n for idx in raw_headers.iter() {\n let name = HeaderName::from_bytes(&slice[idx.name.0..idx.name.1]).unwrap();\n\n // SAFETY: httparse already checks header value is only visible ASCII bytes\n // from_maybe_shared_unchecked contains debug assertions so they are omitted here\n let value = unsafe {\n HeaderValue::from_maybe_shared_unchecked(slice.slice(idx.value.0..idx.value.1))\n };\n\n match name {\n header::CONTENT_LENGTH if content_length.is_some() => {\n debug!(\"multiple Content-Length\");\n return Err(ParseError::Header);\n }\n\n header::CONTENT_LENGTH => match value.to_str().map(str::trim) {\n Ok(val) if val.starts_with('+') => {\n debug!(\"illegal Content-Length: {:?}\", val);\n return Err(ParseError::Header);\n }\n\n Ok(val) => {\n if let Ok(len) = val.parse::() {\n // accept 0 lengths here and remove them in `decode` after all\n // headers have been processed to prevent request smuggling issues\n content_length = Some(len);\n } else {\n debug!(\"illegal Content-Length: {:?}\", val);\n return Err(ParseError::Header);\n }\n }\n\n Err(_) => {\n debug!(\"illegal Content-Length: {:?}\", value);\n return Err(ParseError::Header);\n }\n },\n\n // transfer-encoding\n header::TRANSFER_ENCODING if seen_te => {\n debug!(\"multiple Transfer-Encoding not allowed\");\n return Err(ParseError::Header);\n }\n\n header::TRANSFER_ENCODING if version == Version::HTTP_11 => {\n seen_te = true;\n\n if let Ok(val) = value.to_str().map(str::trim) {\n if val.eq_ignore_ascii_case(\"chunked\") {\n chunked = true;\n } else if val.eq_ignore_ascii_case(\"identity\") {\n // allow silently since multiple TE headers are already checked\n } else {\n debug!(\"illegal Transfer-Encoding: {:?}\", val);\n return Err(ParseError::Header);\n }\n } else {\n return Err(ParseError::Header);\n }\n }\n\n // connection keep-alive state\n header::CONNECTION => {\n ka = if let Ok(conn) = value.to_str().map(str::trim) {\n if conn.eq_ignore_ascii_case(\"keep-alive\") {\n Some(ConnectionType::KeepAlive)\n } else if conn.eq_ignore_ascii_case(\"close\") {\n Some(ConnectionType::Close)\n } else if conn.eq_ignore_ascii_case(\"upgrade\") {\n Some(ConnectionType::Upgrade)\n } else {\n None\n }\n } else {\n None\n };\n }\n\n header::UPGRADE => {\n if let Ok(val) = value.to_str().map(str::trim) {\n if val.eq_ignore_ascii_case(\"websocket\") {\n has_upgrade_websocket = true;\n }\n }\n }\n\n header::EXPECT => {\n let bytes = value.as_bytes();\n if bytes.len() >= 4 && &bytes[0..4] == b\"100-\" {\n expect = true;\n }\n }\n\n _ => {}\n }\n\n headers.append(name, value);\n }\n }\n\n self.set_connection_type(ka);\n\n if expect {\n self.set_expect()\n }\n\n // https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.3\n if chunked {\n // Chunked encoding\n Ok(PayloadLength::Payload(PayloadType::Payload(\n PayloadDecoder::chunked(),\n )))\n } else if has_upgrade_websocket {\n Ok(PayloadLength::UpgradeWebSocket)\n } else if let Some(len) = content_length {\n // Content-Length\n Ok(PayloadLength::Payload(PayloadType::Payload(\n PayloadDecoder::length(len),\n )))\n } else {\n Ok(PayloadLength::None)\n }\n }\n}\n\nimpl MessageType for Request {\n fn set_connection_type(&mut self, conn_type: Option) {\n if let Some(ctype) = conn_type {\n self.head_mut().set_connection_type(ctype);\n }\n }\n\n fn set_expect(&mut self) {\n self.head_mut().set_expect();\n }\n\n fn headers_mut(&mut self) -> &mut HeaderMap {\n &mut self.head_mut().headers\n }\n\n fn decode(src: &mut BytesMut) -> Result, ParseError> {\n let mut headers: [HeaderIndex; MAX_HEADERS] = EMPTY_HEADER_INDEX_ARRAY;\n\n let (len, method, uri, ver, h_len) = {\n // SAFETY:\n // Create an uninitialized array of `MaybeUninit`. The `assume_init` is safe because the\n // type we are claiming to have initialized here is a bunch of `MaybeUninit`s, which\n // do not require initialization.\n let mut parsed = unsafe {\n MaybeUninit::<[MaybeUninit>; MAX_HEADERS]>::uninit()\n .assume_init()\n };\n\n let mut req = httparse::Request::new(&mut []);\n\n match req.parse_with_uninit_headers(src, &mut parsed)? {\n httparse::Status::Complete(len) => {\n let method = Method::from_bytes(req.method.unwrap().as_bytes())\n .map_err(|_| ParseError::Method)?;\n let uri = Uri::try_from(req.path.unwrap())?;\n let version = if req.version.unwrap() == 1 {\n Version::HTTP_11\n } else {\n Version::HTTP_10\n };\n HeaderIndex::record(src, req.headers, &mut headers);\n\n (len, method, uri, version, req.headers.len())\n }\n\n httparse::Status::Partial => {\n return if src.len() >= MAX_BUFFER_SIZE {\n trace!(\"MAX_BUFFER_SIZE unprocessed data reached, closing\");\n Err(ParseError::TooLarge)\n } else {\n // Return None to notify more read are needed for parsing request\n Ok(None)\n };\n }\n }\n };\n\n let mut msg = Request::new();\n\n // convert headers\n let mut length = msg.set_headers(&src.split_to(len).freeze(), &headers[..h_len], ver)?;\n\n // disallow HTTP/1.0 POST requests that do not contain a Content-Length headers\n // see https://datatracker.ietf.org/doc/html/rfc1945#section-7.2.2\n if ver == Version::HTTP_10 && method == Method::POST && length.is_none() {\n debug!(\"no Content-Length specified for HTTP/1.0 POST request\");\n return Err(ParseError::Header);\n }\n\n // Remove CL value if 0 now that all headers and HTTP/1.0 special cases are processed.\n // Protects against some request smuggling attacks.\n // See https://github.com/actix/actix-web/issues/2767.\n if length.is_zero() {\n length = PayloadLength::None;\n }\n\n // payload decoder\n let decoder = match length {\n PayloadLength::Payload(pl) => pl,\n PayloadLength::UpgradeWebSocket => {\n // upgrade (WebSocket)\n PayloadType::Stream(PayloadDecoder::eof())\n }\n PayloadLength::None => {\n if method == Method::CONNECT {\n PayloadType::Stream(PayloadDecoder::eof())\n } else {\n PayloadType::None\n }\n }\n };\n\n let head = msg.head_mut();\n head.uri = uri;\n head.method = method;\n head.version = ver;\n\n Ok(Some((msg, decoder)))\n }\n}\n\nimpl MessageType for ResponseHead {\n fn set_connection_type(&mut self, conn_type: Option) {\n if let Some(ctype) = conn_type {\n ResponseHead::set_connection_type(self, ctype);\n }\n }\n\n fn set_expect(&mut self) {}\n\n fn headers_mut(&mut self) -> &mut HeaderMap {\n &mut self.headers\n }\n\n fn decode(src: &mut BytesMut) -> Result, ParseError> {\n let mut headers: [HeaderIndex; MAX_HEADERS] = EMPTY_HEADER_INDEX_ARRAY;\n\n let (len, ver, status, h_len) = {\n // SAFETY:\n // Create an uninitialized array of `MaybeUninit`. The `assume_init` is safe because the\n // type we are claiming to have initialized here is a bunch of `MaybeUninit`s, which\n // do not require initialization.\n let mut parsed = unsafe {\n MaybeUninit::<[MaybeUninit>; MAX_HEADERS]>::uninit()\n .assume_init()\n };\n\n let mut res = httparse::Response::new(&mut []);\n\n let mut config = httparse::ParserConfig::default();\n config.allow_spaces_after_header_name_in_responses(true);\n\n match config.parse_response_with_uninit_headers(&mut res, src, &mut parsed)? {\n httparse::Status::Complete(len) => {\n let version = if res.version.unwrap() == 1 {\n Version::HTTP_11\n } else {\n Version::HTTP_10\n };\n\n let status =\n StatusCode::from_u16(res.code.unwrap()).map_err(|_| ParseError::Status)?;\n HeaderIndex::record(src, res.headers, &mut headers);\n\n (len, version, status, res.headers.len())\n }\n\n httparse::Status::Partial => {\n return if src.len() >= MAX_BUFFER_SIZE {\n error!(\"MAX_BUFFER_SIZE unprocessed data reached, closing\");\n Err(ParseError::TooLarge)\n } else {\n Ok(None)\n }\n }\n }\n };\n\n let mut msg = ResponseHead::new(status);\n msg.version = ver;\n\n // convert headers\n let mut length = msg.set_headers(&src.split_to(len).freeze(), &headers[..h_len], ver)?;\n\n // Remove CL value if 0 now that all headers and HTTP/1.0 special cases are processed.\n // Protects against some request smuggling attacks.\n // See https://github.com/actix/actix-web/issues/2767.\n if length.is_zero() {\n length = PayloadLength::None;\n }\n\n // message payload\n let decoder = if let PayloadLength::Payload(pl) = length {\n pl\n } else if status == StatusCode::SWITCHING_PROTOCOLS {\n // switching protocol or connect\n PayloadType::Stream(PayloadDecoder::eof())\n } else {\n // for HTTP/1.0 read to eof and close connection\n if msg.version == Version::HTTP_10 {\n msg.set_connection_type(ConnectionType::Close);\n PayloadType::Payload(PayloadDecoder::eof())\n } else {\n PayloadType::None\n }\n };\n\n Ok(Some((msg, decoder)))\n }\n}\n\n#[derive(Clone, Copy)]\npub(crate) struct HeaderIndex {\n pub(crate) name: (usize, usize),\n pub(crate) value: (usize, usize),\n}\n\npub(crate) const EMPTY_HEADER_INDEX: HeaderIndex = HeaderIndex {\n name: (0, 0),\n value: (0, 0),\n};\n\npub(crate) const EMPTY_HEADER_INDEX_ARRAY: [HeaderIndex; MAX_HEADERS] =\n [EMPTY_HEADER_INDEX; MAX_HEADERS];\n\nimpl HeaderIndex {\n pub(crate) fn record(\n bytes: &[u8],\n headers: &[httparse::Header<'_>],\n indices: &mut [HeaderIndex],\n ) {\n let bytes_ptr = bytes.as_ptr() as usize;\n for (header, indices) in headers.iter().zip(indices.iter_mut()) {\n let name_start = header.name.as_ptr() as usize - bytes_ptr;\n let name_end = name_start + header.name.len();\n indices.name = (name_start, name_end);\n let value_start = header.value.as_ptr() as usize - bytes_ptr;\n let value_end = value_start + header.value.len();\n indices.value = (value_start, value_end);\n }\n }\n}\n\n#[derive(Debug, Clone, PartialEq, Eq)]\n/// Chunk type yielded while decoding a payload.\npub enum PayloadItem {\n Chunk(Bytes),\n Eof,\n}\n\n/// Decoder that can handle different payload types.\n///\n/// If a message body does not use `Transfer-Encoding`, it should include a `Content-Length`.\n#[derive(Debug, Clone, PartialEq, Eq)]\npub struct PayloadDecoder {\n kind: Kind,\n}\n\nimpl PayloadDecoder {\n /// Constructs a fixed-length payload decoder.\n pub fn length(x: u64) -> PayloadDecoder {\n PayloadDecoder {\n kind: Kind::Length(x),\n }\n }\n\n /// Constructs a chunked encoding decoder.\n pub fn chunked() -> PayloadDecoder {\n PayloadDecoder {\n kind: Kind::Chunked(ChunkedState::Size, 0),\n }\n }\n\n /// Creates an decoder that yields chunks until the stream returns EOF.\n pub fn eof() -> PayloadDecoder {\n PayloadDecoder { kind: Kind::Eof }\n }\n}\n\n#[derive(Debug, Clone, PartialEq, Eq)]\nenum Kind {\n /// A reader used when a `Content-Length` header is passed with a positive integer.\n Length(u64),\n\n /// A reader used when `Transfer-Encoding` is `chunked`.\n Chunked(ChunkedState, u64),\n\n /// A reader used for responses that don't indicate a length or chunked.\n ///\n /// Note: This should only used for `Response`s. It is illegal for a `Request` to be made\n /// without either of `Content-Length` and `Transfer-Encoding: chunked` missing, as explained\n /// in [RFC 7230 §3.3.3]:\n ///\n /// > If a Transfer-Encoding header field is present in a response and the chunked transfer\n /// > coding is not the final encoding, the message body length is determined by reading the\n /// > connection until it is closed by the server. If a Transfer-Encoding header field is\n /// > present in a request and the chunked transfer coding is not the final encoding, the\n /// > message body length cannot be determined reliably; the server MUST respond with the 400\n /// > (Bad Request) status code and then close the connection.\n ///\n /// [RFC 7230 §3.3.3]: https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.3\n Eof,\n}\n\nimpl Decoder for PayloadDecoder {\n type Item = PayloadItem;\n type Error = io::Error;\n\n fn decode(&mut self, src: &mut BytesMut) -> Result, Self::Error> {\n match self.kind {\n Kind::Length(ref mut remaining) => {\n if *remaining == 0 {\n Ok(Some(PayloadItem::Eof))\n } else {\n if src.is_empty() {\n return Ok(None);\n }\n let len = src.len() as u64;\n let buf;\n if *remaining > len {\n buf = src.split().freeze();\n *remaining -= len;\n } else {\n buf = src.split_to(*remaining as usize).freeze();\n *remaining = 0;\n };\n trace!(\"Length read: {}\", buf.len());\n Ok(Some(PayloadItem::Chunk(buf)))\n }\n }\n\n Kind::Chunked(ref mut state, ref mut size) => {\n loop {\n let mut buf = None;\n\n // advances the chunked state\n *state = match state.step(src, size, &mut buf) {\n Poll::Pending => return Ok(None),\n Poll::Ready(Ok(state)) => state,\n Poll::Ready(Err(err)) => return Err(err),\n };\n\n if *state == ChunkedState::End {\n trace!(\"End of chunked stream\");\n return Ok(Some(PayloadItem::Eof));\n }\n\n if let Some(buf) = buf {\n return Ok(Some(PayloadItem::Chunk(buf)));\n }\n\n if src.is_empty() {\n return Ok(None);\n }\n }\n }\n\n Kind::Eof => {\n if src.is_empty() {\n Ok(None)\n } else {\n Ok(Some(PayloadItem::Chunk(src.split().freeze())))\n }\n }\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n use crate::{header::SET_COOKIE, HttpMessage as _};\n\n impl PayloadType {\n pub(crate) fn unwrap(self) -> PayloadDecoder {\n match self {\n PayloadType::Payload(pl) => pl,\n _ => panic!(),\n }\n }\n\n pub(crate) fn is_unhandled(&self) -> bool {\n matches!(self, PayloadType::Stream(_))\n }\n }\n\n impl PayloadItem {\n pub(crate) fn chunk(self) -> Bytes {\n match self {\n PayloadItem::Chunk(chunk) => chunk,\n _ => panic!(\"error\"),\n }\n }\n\n pub(crate) fn eof(&self) -> bool {\n matches!(*self, PayloadItem::Eof)\n }\n }\n\n macro_rules! parse_ready {\n ($e:expr) => {{\n match MessageDecoder::::default().decode($e) {\n Ok(Some((msg, _))) => msg,\n Ok(_) => unreachable!(\"Eof during parsing http request\"),\n Err(err) => unreachable!(\"Error during parsing http request: {:?}\", err),\n }\n }};\n }\n\n macro_rules! expect_parse_err {\n ($e:expr) => {{\n match MessageDecoder::::default().decode($e) {\n Err(err) => match err {\n ParseError::Io(_) => unreachable!(\"Parse error expected\"),\n _ => {}\n },\n _ => unreachable!(\"Error expected\"),\n }\n }};\n }\n\n #[test]\n fn test_parse() {\n let mut buf = BytesMut::from(\"GET /test HTTP/1.1\\r\\n\\r\\n\");\n\n let mut reader = MessageDecoder::::default();\n match reader.decode(&mut buf) {\n Ok(Some((req, _))) => {\n assert_eq!(req.version(), Version::HTTP_11);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test\");\n }\n Ok(_) | Err(_) => unreachable!(\"Error during parsing http request\"),\n }\n }\n\n #[test]\n fn test_parse_partial() {\n let mut buf = BytesMut::from(\"PUT /test HTTP/1\");\n\n let mut reader = MessageDecoder::::default();\n assert!(reader.decode(&mut buf).unwrap().is_none());\n\n buf.extend(b\".1\\r\\n\\r\\n\");\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_11);\n assert_eq!(*req.method(), Method::PUT);\n assert_eq!(req.path(), \"/test\");\n }\n\n #[test]\n fn parse_h09_reject() {\n let mut buf = BytesMut::from(\n \"GET /test1 HTTP/0.9\\r\\n\\\n \\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n reader.decode(&mut buf).unwrap_err();\n\n let mut buf = BytesMut::from(\n \"POST /test2 HTTP/0.9\\r\\n\\\n Content-Length: 3\\r\\n\\\n \\r\\n\n abc\",\n );\n\n let mut reader = MessageDecoder::::default();\n reader.decode(&mut buf).unwrap_err();\n }\n\n #[test]\n fn parse_h10_get() {\n let mut buf = BytesMut::from(\n \"GET /test1 HTTP/1.0\\r\\n\\\n \\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_10);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test1\");\n\n let mut buf = BytesMut::from(\n \"GET /test2 HTTP/1.0\\r\\n\\\n Content-Length: 0\\r\\n\\\n \\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_10);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test2\");\n\n let mut buf = BytesMut::from(\n \"GET /test3 HTTP/1.0\\r\\n\\\n Content-Length: 3\\r\\n\\\n \\r\\n\n abc\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_10);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test3\");\n }\n\n #[test]\n fn parse_h10_post() {\n let mut buf = BytesMut::from(\n \"POST /test1 HTTP/1.0\\r\\n\\\n Content-Length: 3\\r\\n\\\n \\r\\n\\\n abc\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_10);\n assert_eq!(*req.method(), Method::POST);\n assert_eq!(req.path(), \"/test1\");\n\n let mut buf = BytesMut::from(\n \"POST /test2 HTTP/1.0\\r\\n\\\n Content-Length: 0\\r\\n\\\n \\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_10);\n assert_eq!(*req.method(), Method::POST);\n assert_eq!(req.path(), \"/test2\");\n\n let mut buf = BytesMut::from(\n \"POST /test3 HTTP/1.0\\r\\n\\\n \\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let err = reader.decode(&mut buf).unwrap_err();\n assert!(err.to_string().contains(\"Header\"))\n }\n\n #[test]\n fn test_parse_body() {\n let mut buf = BytesMut::from(\"GET /test HTTP/1.1\\r\\nContent-Length: 4\\r\\n\\r\\nbody\");\n\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n assert_eq!(req.version(), Version::HTTP_11);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test\");\n assert_eq!(\n pl.decode(&mut buf).unwrap().unwrap().chunk().as_ref(),\n b\"body\"\n );\n }\n\n #[test]\n fn test_parse_body_crlf() {\n let mut buf = BytesMut::from(\"\\r\\nGET /test HTTP/1.1\\r\\nContent-Length: 4\\r\\n\\r\\nbody\");\n\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n assert_eq!(req.version(), Version::HTTP_11);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test\");\n assert_eq!(\n pl.decode(&mut buf).unwrap().unwrap().chunk().as_ref(),\n b\"body\"\n );\n }\n\n #[test]\n fn test_parse_partial_eof() {\n let mut buf = BytesMut::from(\"GET /test HTTP/1.1\\r\\n\");\n let mut reader = MessageDecoder::::default();\n assert!(reader.decode(&mut buf).unwrap().is_none());\n\n buf.extend(b\"\\r\\n\");\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_11);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test\");\n }\n\n #[test]\n fn test_headers_split_field() {\n let mut buf = BytesMut::from(\"GET /test HTTP/1.1\\r\\n\");\n\n let mut reader = MessageDecoder::::default();\n assert! { reader.decode(&mut buf).unwrap().is_none() }\n\n buf.extend(b\"t\");\n assert! { reader.decode(&mut buf).unwrap().is_none() }\n\n buf.extend(b\"es\");\n assert! { reader.decode(&mut buf).unwrap().is_none() }\n\n buf.extend(b\"t: value\\r\\n\\r\\n\");\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.version(), Version::HTTP_11);\n assert_eq!(*req.method(), Method::GET);\n assert_eq!(req.path(), \"/test\");\n assert_eq!(\n req.headers()\n .get(HeaderName::try_from(\"test\").unwrap())\n .unwrap()\n .as_bytes(),\n b\"value\"\n );\n }\n\n #[test]\n fn test_headers_multi_value() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n Set-Cookie: c1=cookie1\\r\\n\\\n Set-Cookie: c2=cookie2\\r\\n\\r\\n\",\n );\n let mut reader = MessageDecoder::::default();\n let (req, _) = reader.decode(&mut buf).unwrap().unwrap();\n\n let val: Vec<_> = req\n .headers()\n .get_all(SET_COOKIE)\n .map(|v| v.to_str().unwrap().to_owned())\n .collect();\n assert_eq!(val[0], \"c1=cookie1\");\n assert_eq!(val[1], \"c2=cookie2\");\n }\n\n #[test]\n fn test_conn_default_1_0() {\n let req = parse_ready!(&mut BytesMut::from(\"GET /test HTTP/1.0\\r\\n\\r\\n\"));\n assert_eq!(req.head().connection_type(), ConnectionType::Close);\n }\n\n #[test]\n fn test_conn_default_1_1() {\n let req = parse_ready!(&mut BytesMut::from(\"GET /test HTTP/1.1\\r\\n\\r\\n\"));\n assert_eq!(req.head().connection_type(), ConnectionType::KeepAlive);\n }\n\n #[test]\n fn test_conn_close() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n connection: close\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::Close);\n\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n connection: Close\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::Close);\n }\n\n #[test]\n fn test_conn_close_1_0() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.0\\r\\n\\\n connection: close\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::Close);\n }\n\n #[test]\n fn test_conn_keep_alive_1_0() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.0\\r\\n\\\n connection: keep-alive\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::KeepAlive);\n\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.0\\r\\n\\\n connection: Keep-Alive\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::KeepAlive);\n }\n\n #[test]\n fn test_conn_keep_alive_1_1() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n connection: keep-alive\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::KeepAlive);\n }\n\n #[test]\n fn test_conn_other_1_0() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.0\\r\\n\\\n connection: other\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::Close);\n }\n\n #[test]\n fn test_conn_other_1_1() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n connection: other\\r\\n\\r\\n\",\n ));\n assert_eq!(req.head().connection_type(), ConnectionType::KeepAlive);\n }\n\n #[test]\n fn test_conn_upgrade() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n upgrade: websockets\\r\\n\\\n connection: upgrade\\r\\n\\r\\n\",\n ));\n\n assert!(req.upgrade());\n assert_eq!(req.head().connection_type(), ConnectionType::Upgrade);\n\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n upgrade: Websockets\\r\\n\\\n connection: Upgrade\\r\\n\\r\\n\",\n ));\n\n assert!(req.upgrade());\n assert_eq!(req.head().connection_type(), ConnectionType::Upgrade);\n }\n\n #[test]\n fn test_conn_upgrade_connect_method() {\n let req = parse_ready!(&mut BytesMut::from(\n \"CONNECT /test HTTP/1.1\\r\\n\\\n content-type: text/plain\\r\\n\\r\\n\",\n ));\n\n assert!(req.upgrade());\n }\n\n #[test]\n fn test_headers_bad_content_length() {\n // string CL\n expect_parse_err!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n content-length: line\\r\\n\\r\\n\",\n ));\n\n // negative CL\n expect_parse_err!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n content-length: -1\\r\\n\\r\\n\",\n ));\n }\n\n #[test]\n fn octal_ish_cl_parsed_as_decimal() {\n let mut buf = BytesMut::from(\n \"POST /test HTTP/1.1\\r\\n\\\n content-length: 011\\r\\n\\r\\n\",\n );\n let mut reader = MessageDecoder::::default();\n let (_req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n assert!(matches!(\n pl,\n PayloadType::Payload(pl) if pl == PayloadDecoder::length(11)\n ));\n }\n\n #[test]\n fn test_invalid_header() {\n expect_parse_err!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n test line\\r\\n\\r\\n\",\n ));\n }\n\n #[test]\n fn test_invalid_name() {\n expect_parse_err!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n test[]: line\\r\\n\\r\\n\",\n ));\n }\n\n #[test]\n fn test_http_request_bad_status_line() {\n expect_parse_err!(&mut BytesMut::from(\"getpath \\r\\n\\r\\n\"));\n }\n\n #[test]\n fn test_http_request_upgrade_websocket() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n connection: upgrade\\r\\n\\\n upgrade: websocket\\r\\n\\r\\n\\\n some raw data\",\n );\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n assert_eq!(req.head().connection_type(), ConnectionType::Upgrade);\n assert!(req.upgrade());\n assert!(pl.is_unhandled());\n }\n\n #[test]\n fn test_http_request_upgrade_h2c() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n connection: upgrade, http2-settings\\r\\n\\\n upgrade: h2c\\r\\n\\\n http2-settings: dummy\\r\\n\\r\\n\",\n );\n let mut reader = MessageDecoder::::default();\n let (req, pl) = reader.decode(&mut buf).unwrap().unwrap();\n // `connection: upgrade, http2-settings` doesn't work properly..\n // see MessageType::set_headers().\n //\n // The line below should be:\n // assert_eq!(req.head().connection_type(), ConnectionType::Upgrade);\n assert_eq!(req.head().connection_type(), ConnectionType::KeepAlive);\n assert!(req.upgrade());\n assert!(!pl.is_unhandled());\n }\n\n #[test]\n fn test_http_request_parser_utf8() {\n let req = parse_ready!(&mut BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n x-test: тест\\r\\n\\r\\n\",\n ));\n\n assert_eq!(\n req.headers().get(\"x-test\").unwrap().as_bytes(),\n \"тест\".as_bytes()\n );\n }\n\n #[test]\n fn test_http_request_parser_two_slashes() {\n let req = parse_ready!(&mut BytesMut::from(\"GET //path HTTP/1.1\\r\\n\\r\\n\"));\n assert_eq!(req.path(), \"//path\");\n }\n\n #[test]\n fn test_http_request_parser_bad_method() {\n expect_parse_err!(&mut BytesMut::from(\"!12%()+=~$ /get HTTP/1.1\\r\\n\\r\\n\"));\n }\n\n #[test]\n fn test_http_request_parser_bad_version() {\n expect_parse_err!(&mut BytesMut::from(\"GET //get HT/11\\r\\n\\r\\n\"));\n }\n\n #[test]\n fn test_response_http10_read_until_eof() {\n let mut buf = BytesMut::from(\"HTTP/1.0 200 Ok\\r\\n\\r\\ntest data\");\n\n let mut reader = MessageDecoder::::default();\n let (_msg, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n\n let chunk = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(chunk, PayloadItem::Chunk(Bytes::from_static(b\"test data\")));\n }\n\n #[test]\n fn hrs_multiple_content_length() {\n expect_parse_err!(&mut BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Content-Length: 4\\r\\n\\\n Content-Length: 2\\r\\n\\\n \\r\\n\\\n abcd\",\n ));\n\n expect_parse_err!(&mut BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Content-Length: 0\\r\\n\\\n Content-Length: 2\\r\\n\\\n \\r\\n\\\n ab\",\n ));\n }\n\n #[test]\n fn hrs_content_length_plus() {\n expect_parse_err!(&mut BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Content-Length: +3\\r\\n\\\n \\r\\n\\\n 000\",\n ));\n }\n\n #[test]\n fn hrs_te_http10() {\n // in HTTP/1.0 transfer encoding is ignored and must therefore contain a CL header\n\n expect_parse_err!(&mut BytesMut::from(\n \"POST / HTTP/1.0\\r\\n\\\n Host: example.com\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n 3\\r\\n\\\n aaa\\r\\n\\\n 0\\r\\n\\\n \",\n ));\n }\n\n #[test]\n fn hrs_cl_and_te_http10() {\n // in HTTP/1.0 transfer encoding is simply ignored so it's fine to have both\n\n let mut buf = BytesMut::from(\n \"GET / HTTP/1.0\\r\\n\\\n Host: example.com\\r\\n\\\n Content-Length: 3\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n 000\",\n );\n\n parse_ready!(&mut buf);\n }\n\n #[test]\n fn hrs_unknown_transfer_encoding() {\n let mut buf = BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Transfer-Encoding: JUNK\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n 5\\r\\n\\\n hello\\r\\n\\\n 0\",\n );\n\n expect_parse_err!(&mut buf);\n }\n\n #[test]\n fn hrs_multiple_transfer_encoding() {\n let mut buf = BytesMut::from(\n \"GET / HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Content-Length: 51\\r\\n\\\n Transfer-Encoding: identity\\r\\n\\\n Transfer-Encoding: chunked\\r\\n\\\n \\r\\n\\\n 0\\r\\n\\\n \\r\\n\\\n GET /forbidden HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\r\\n\",\n );\n\n expect_parse_err!(&mut buf);\n }\n\n #[test]\n fn transfer_encoding_agrees() {\n let mut buf = BytesMut::from(\n \"GET /test HTTP/1.1\\r\\n\\\n Host: example.com\\r\\n\\\n Content-Length: 3\\r\\n\\\n Transfer-Encoding: identity\\r\\n\\\n \\r\\n\\\n 0\\r\\n\",\n );\n\n let mut reader = MessageDecoder::::default();\n let (_msg, pl) = reader.decode(&mut buf).unwrap().unwrap();\n let mut pl = pl.unwrap();\n\n let chunk = pl.decode(&mut buf).unwrap().unwrap();\n assert_eq!(chunk, PayloadItem::Chunk(Bytes::from_static(b\"0\\r\\n\")));\n }\n}\n" }, { "path": "actix-http/src/h1/dispatcher.rs", "content": "use std::{\n collections::VecDeque,\n fmt,\n future::Future,\n io, mem, net,\n pin::Pin,\n rc::Rc,\n task::{Context, Poll},\n};\n\nuse actix_codec::{Framed, FramedParts};\nuse actix_rt::time::sleep_until;\nuse actix_service::Service;\nuse bitflags::bitflags;\nuse bytes::{Buf, BytesMut};\nuse futures_core::ready;\nuse pin_project_lite::pin_project;\nuse tokio::io::{AsyncRead, AsyncWrite};\nuse tokio_util::codec::{Decoder as _, Encoder as _};\nuse tracing::{error, trace};\n\nuse super::{\n codec::Codec,\n decoder::MAX_BUFFER_SIZE,\n payload::{Payload, PayloadSender, PayloadStatus},\n timer::TimerState,\n Message, MessageType,\n};\nuse crate::{\n body::{BodySize, BoxBody, MessageBody},\n config::ServiceConfig,\n error::{DispatchError, ParseError, PayloadError},\n service::HttpFlow,\n Error, Extensions, HttpMessage, OnConnectData, Request, Response, StatusCode,\n};\n\nconst LW_BUFFER_SIZE: usize = 1024;\nconst HW_BUFFER_SIZE: usize = 1024 * 8;\nconst MAX_PIPELINED_MESSAGES: usize = 16;\n\nbitflags! {\n #[derive(Debug, Clone, Copy)]\n pub struct Flags: u8 {\n /// Set when stream is read for first time.\n const STARTED = 0b0000_0001;\n\n /// Set when full request-response cycle has occurred.\n const FINISHED = 0b0000_0010;\n\n /// Set if connection is in keep-alive (inactive) state.\n const KEEP_ALIVE = 0b0000_0100;\n\n /// Set if in shutdown procedure.\n const SHUTDOWN = 0b0000_1000;\n\n /// Set if read-half is disconnected.\n const READ_DISCONNECT = 0b0001_0000;\n\n /// Set if write-half is disconnected.\n const WRITE_DISCONNECT = 0b0010_0000;\n }\n}\n\n// there's 2 versions of Dispatcher state because of:\n// https://github.com/taiki-e/pin-project-lite/issues/3\n//\n// tl;dr: pin-project-lite doesn't play well with other attribute macros\n\n#[cfg(not(test))]\npin_project! {\n /// Dispatcher for HTTP/1.1 protocol\n pub struct Dispatcher\n where\n S: Service,\n S::Error: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n {\n #[pin]\n inner: DispatcherState,\n }\n}\n\n#[cfg(test)]\npin_project! {\n /// Dispatcher for HTTP/1.1 protocol\n pub struct Dispatcher\n where\n S: Service,\n S::Error: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n {\n #[pin]\n pub(super) inner: DispatcherState,\n\n // used in tests\n pub(super) poll_count: u64,\n }\n}\n\npin_project! {\n #[project = DispatcherStateProj]\n pub(super) enum DispatcherState\n where\n S: Service,\n S::Error: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n {\n Normal { #[pin] inner: InnerDispatcher },\n Upgrade { #[pin] fut: U::Future },\n }\n}\n\npin_project! {\n #[project = InnerDispatcherProj]\n pub(super) struct InnerDispatcher\n where\n S: Service,\n S::Error: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n {\n flow: Rc>,\n pub(super) flags: Flags,\n peer_addr: Option,\n conn_data: Option>,\n config: ServiceConfig,\n error: Option,\n\n #[pin]\n pub(super) state: State,\n // when Some(_) dispatcher is in state of receiving request payload\n payload: Option,\n // true when current request uses chunked transfer encoding (drainable when payload is dropped)\n payload_drainable: bool,\n messages: VecDeque,\n\n head_timer: TimerState,\n ka_timer: TimerState,\n shutdown_timer: TimerState,\n\n pub(super) io: Option,\n read_buf: BytesMut,\n write_buf: BytesMut,\n codec: Codec,\n }\n}\n\nenum DispatcherMessage {\n Item(Request),\n Upgrade(Request),\n Error(Response<()>),\n}\n\npin_project! {\n #[project = StateProj]\n pub(super) enum State\n where\n S: Service,\n X: Service,\n B: MessageBody,\n {\n None,\n ExpectCall { #[pin] fut: X::Future },\n ServiceCall { #[pin] fut: S::Future },\n SendPayload { #[pin] body: B },\n SendErrorPayload { #[pin] body: BoxBody },\n }\n}\n\nimpl State\nwhere\n S: Service,\n X: Service,\n B: MessageBody,\n{\n pub(super) fn is_none(&self) -> bool {\n matches!(self, State::None)\n }\n}\n\nimpl fmt::Debug for State\nwhere\n S: Service,\n X: Service,\n B: MessageBody,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n match self {\n Self::None => write!(f, \"State::None\"),\n Self::ExpectCall { .. } => f.debug_struct(\"State::ExpectCall\").finish_non_exhaustive(),\n Self::ServiceCall { .. } => {\n f.debug_struct(\"State::ServiceCall\").finish_non_exhaustive()\n }\n Self::SendPayload { .. } => {\n f.debug_struct(\"State::SendPayload\").finish_non_exhaustive()\n }\n Self::SendErrorPayload { .. } => f\n .debug_struct(\"State::SendErrorPayload\")\n .finish_non_exhaustive(),\n }\n }\n}\n\n#[derive(Debug)]\nenum PollResponse {\n Upgrade(Request),\n DoNothing,\n DrainWriteBuf,\n}\n\nimpl Dispatcher\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n\n S: Service,\n S::Error: Into>,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n{\n /// Create HTTP/1 dispatcher.\n pub(crate) fn new(\n io: T,\n flow: Rc>,\n config: ServiceConfig,\n peer_addr: Option,\n conn_data: OnConnectData,\n ) -> Self {\n Dispatcher {\n inner: DispatcherState::Normal {\n inner: InnerDispatcher {\n flow,\n flags: Flags::empty(),\n peer_addr,\n conn_data: conn_data.0.map(Rc::new),\n config: config.clone(),\n error: None,\n\n state: State::None,\n payload: None,\n payload_drainable: false,\n messages: VecDeque::new(),\n\n head_timer: TimerState::new(config.client_request_deadline().is_some()),\n ka_timer: TimerState::new(config.keep_alive().enabled()),\n shutdown_timer: TimerState::new(config.client_disconnect_deadline().is_some()),\n\n io: Some(io),\n read_buf: BytesMut::with_capacity(HW_BUFFER_SIZE),\n write_buf: BytesMut::with_capacity(HW_BUFFER_SIZE),\n codec: Codec::new(config),\n },\n },\n\n #[cfg(test)]\n poll_count: 0,\n }\n }\n}\n\nimpl InnerDispatcher\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n\n S: Service,\n S::Error: Into>,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n{\n fn can_read(&self, cx: &mut Context<'_>) -> bool {\n if self.flags.contains(Flags::READ_DISCONNECT) {\n false\n } else if let Some(ref info) = self.payload {\n matches!(\n info.need_read(cx),\n PayloadStatus::Read | PayloadStatus::Dropped\n )\n } else {\n true\n }\n }\n\n fn client_disconnected(self: Pin<&mut Self>) {\n let this = self.project();\n\n this.flags\n .insert(Flags::READ_DISCONNECT | Flags::WRITE_DISCONNECT);\n\n if let Some(mut payload) = this.payload.take() {\n payload.set_error(PayloadError::Incomplete(None));\n }\n }\n\n fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n let InnerDispatcherProj { io, write_buf, .. } = self.project();\n let mut io = Pin::new(io.as_mut().unwrap());\n\n let len = write_buf.len();\n let mut written = 0;\n\n while written < len {\n match io.as_mut().poll_write(cx, &write_buf[written..])? {\n Poll::Ready(0) => {\n error!(\"write zero; closing\");\n return Poll::Ready(Err(io::Error::new(io::ErrorKind::WriteZero, \"\")));\n }\n\n Poll::Ready(n) => written += n,\n\n Poll::Pending => {\n write_buf.advance(written);\n return Poll::Pending;\n }\n }\n }\n\n // everything has written to I/O; clear buffer\n write_buf.clear();\n\n // flush the I/O and check if get blocked\n io.poll_flush(cx)\n }\n\n fn send_response_inner(\n self: Pin<&mut Self>,\n res: Response<()>,\n body: &impl MessageBody,\n ) -> Result {\n let this = self.project();\n\n let size = body.size();\n\n this.codec\n .encode(Message::Item((res, size)), this.write_buf)\n .map_err(|err| {\n if let Some(mut payload) = this.payload.take() {\n payload.set_error(PayloadError::Incomplete(None));\n }\n\n DispatchError::Io(err)\n })?;\n\n Ok(size)\n }\n\n fn send_response(\n mut self: Pin<&mut Self>,\n res: Response<()>,\n body: B,\n ) -> Result<(), DispatchError> {\n let size = self.as_mut().send_response_inner(res, &body)?;\n let mut this = self.project();\n this.state.set(match size {\n BodySize::None | BodySize::Sized(0) => {\n let payload_unfinished = this.payload.is_some();\n let drain_payload = this.payload.as_ref().is_some_and(|pl| pl.is_dropped())\n && *this.payload_drainable;\n\n if payload_unfinished && !drain_payload {\n this.flags.insert(Flags::SHUTDOWN | Flags::FINISHED);\n } else {\n this.flags.insert(Flags::FINISHED);\n }\n\n State::None\n }\n _ => State::SendPayload { body },\n });\n\n Ok(())\n }\n\n fn send_error_response(\n mut self: Pin<&mut Self>,\n res: Response<()>,\n body: BoxBody,\n ) -> Result<(), DispatchError> {\n let size = self.as_mut().send_response_inner(res, &body)?;\n let mut this = self.project();\n this.state.set(match size {\n BodySize::None | BodySize::Sized(0) => {\n let payload_unfinished = this.payload.is_some();\n let drain_payload = this.payload.as_ref().is_some_and(|pl| pl.is_dropped())\n && *this.payload_drainable;\n\n if payload_unfinished && !drain_payload {\n this.flags.insert(Flags::SHUTDOWN | Flags::FINISHED);\n } else {\n this.flags.insert(Flags::FINISHED);\n }\n\n State::None\n }\n _ => State::SendErrorPayload { body },\n });\n\n Ok(())\n }\n\n fn send_continue(self: Pin<&mut Self>) {\n self.project()\n .write_buf\n .extend_from_slice(b\"HTTP/1.1 100 Continue\\r\\n\\r\\n\");\n }\n\n fn poll_response(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Result {\n 'res: loop {\n let mut this = self.as_mut().project();\n match this.state.as_mut().project() {\n // no future is in InnerDispatcher state; pop next message\n StateProj::None => match this.messages.pop_front() {\n // handle request message\n Some(DispatcherMessage::Item(req)) => {\n // Handle `EXPECT: 100-Continue` header\n if req.head().expect() {\n // set InnerDispatcher state and continue loop to poll it\n let fut = this.flow.expect.call(req);\n this.state.set(State::ExpectCall { fut });\n } else {\n // set InnerDispatcher state and continue loop to poll it\n let fut = this.flow.service.call(req);\n this.state.set(State::ServiceCall { fut });\n };\n }\n\n // handle error message\n Some(DispatcherMessage::Error(res)) => {\n // send_response would update InnerDispatcher state to SendPayload or None\n // (If response body is empty)\n // continue loop to poll it\n self.as_mut().send_error_response(res, BoxBody::new(()))?;\n }\n\n // return with upgrade request and poll it exclusively\n Some(DispatcherMessage::Upgrade(req)) => return Ok(PollResponse::Upgrade(req)),\n\n // all messages are dealt with\n None => {\n // start keep-alive only if request payload is fully read/drained\n this.flags.set(\n Flags::KEEP_ALIVE,\n this.payload.is_none() && this.codec.keep_alive(),\n );\n\n return Ok(PollResponse::DoNothing);\n }\n },\n\n StateProj::ServiceCall { fut } => {\n match fut.poll(cx) {\n // service call resolved. send response.\n Poll::Ready(Ok(res)) => {\n let (res, body) = res.into().replace_body(());\n self.as_mut().send_response(res, body)?;\n }\n\n // send service call error as response\n Poll::Ready(Err(err)) => {\n let res: Response = err.into();\n let (res, body) = res.replace_body(());\n self.as_mut().send_error_response(res, body)?;\n }\n\n // service call pending and could be waiting for more chunk messages\n // (pipeline message limit and/or payload can_read limit)\n Poll::Pending => {\n // no new message is decoded and no new payload is fed\n // nothing to do except waiting for new incoming data from client\n if !self.as_mut().poll_request(cx)? {\n return Ok(PollResponse::DoNothing);\n }\n // else loop\n }\n }\n }\n\n StateProj::SendPayload { mut body } => {\n // keep populate writer buffer until buffer size limit hit,\n // get blocked or finished.\n while this.write_buf.len() < super::payload::MAX_BUFFER_SIZE {\n match body.as_mut().poll_next(cx) {\n Poll::Ready(Some(Ok(item))) => {\n this.codec\n .encode(Message::Chunk(Some(item)), this.write_buf)?;\n }\n\n Poll::Ready(None) => {\n this.codec.encode(Message::Chunk(None), this.write_buf)?;\n\n // if we have not yet pipelined to the next request, then\n // this.payload was the payload for the request we just finished\n // responding to. We can check to see if we finished reading it\n // yet, and if not, shutdown the connection.\n let payload_unfinished = this.payload.is_some();\n let drain_payload =\n this.payload.as_ref().is_some_and(|pl| pl.is_dropped())\n && *this.payload_drainable;\n let not_pipelined = this.messages.is_empty();\n\n // payload stream finished.\n // set state to None and handle next message\n this.state.set(State::None);\n\n if not_pipelined && payload_unfinished && !drain_payload {\n this.flags.insert(Flags::SHUTDOWN | Flags::FINISHED);\n } else {\n this.flags.insert(Flags::FINISHED);\n }\n\n continue 'res;\n }\n\n Poll::Ready(Some(Err(err))) => {\n let err = err.into();\n tracing::error!(\"Response payload stream error: {err:?}\");\n this.flags.insert(Flags::FINISHED);\n return Err(DispatchError::Body(err));\n }\n\n Poll::Pending => return Ok(PollResponse::DoNothing),\n }\n }\n\n // buffer is beyond max size\n // return and try to write the whole buffer to I/O stream.\n return Ok(PollResponse::DrainWriteBuf);\n }\n\n StateProj::SendErrorPayload { mut body } => {\n // TODO: de-dupe impl with SendPayload\n\n // keep populate writer buffer until buffer size limit hit,\n // get blocked or finished.\n while this.write_buf.len() < super::payload::MAX_BUFFER_SIZE {\n match body.as_mut().poll_next(cx) {\n Poll::Ready(Some(Ok(item))) => {\n this.codec\n .encode(Message::Chunk(Some(item)), this.write_buf)?;\n }\n\n Poll::Ready(None) => {\n this.codec.encode(Message::Chunk(None), this.write_buf)?;\n\n // if we have not yet pipelined to the next request, then\n // this.payload was the payload for the request we just finished\n // responding to. We can check to see if we finished reading it\n // yet, and if not, shutdown the connection.\n let payload_unfinished = this.payload.is_some();\n let drain_payload =\n this.payload.as_ref().is_some_and(|pl| pl.is_dropped())\n && *this.payload_drainable;\n let not_pipelined = this.messages.is_empty();\n\n // payload stream finished.\n // set state to None and handle next message\n this.state.set(State::None);\n\n if not_pipelined && payload_unfinished && !drain_payload {\n this.flags.insert(Flags::SHUTDOWN | Flags::FINISHED);\n } else {\n this.flags.insert(Flags::FINISHED);\n }\n\n continue 'res;\n }\n\n Poll::Ready(Some(Err(err))) => {\n tracing::error!(\"Response payload stream error: {err:?}\");\n this.flags.insert(Flags::FINISHED);\n return Err(DispatchError::Body(\n Error::new_body().with_cause(err).into(),\n ));\n }\n\n Poll::Pending => return Ok(PollResponse::DoNothing),\n }\n }\n\n // buffer is beyond max size\n // return and try to write the whole buffer to stream\n return Ok(PollResponse::DrainWriteBuf);\n }\n\n StateProj::ExpectCall { fut } => {\n trace!(\" calling expect service\");\n\n match fut.poll(cx) {\n // expect resolved. write continue to buffer and set InnerDispatcher state\n // to service call.\n Poll::Ready(Ok(req)) => {\n this.write_buf\n .extend_from_slice(b\"HTTP/1.1 100 Continue\\r\\n\\r\\n\");\n let fut = this.flow.service.call(req);\n this.state.set(State::ServiceCall { fut });\n }\n\n // send expect error as response\n Poll::Ready(Err(err)) => {\n let res: Response = err.into();\n let (res, body) = res.replace_body(());\n self.as_mut().send_error_response(res, body)?;\n }\n\n // expect must be solved before progress can be made.\n Poll::Pending => return Ok(PollResponse::DoNothing),\n }\n }\n }\n }\n }\n\n fn handle_request(\n mut self: Pin<&mut Self>,\n req: Request,\n cx: &mut Context<'_>,\n ) -> Result<(), DispatchError> {\n // initialize dispatcher state\n {\n let mut this = self.as_mut().project();\n\n // Handle `EXPECT: 100-Continue` header\n if req.head().expect() {\n // set dispatcher state to call expect handler\n let fut = this.flow.expect.call(req);\n this.state.set(State::ExpectCall { fut });\n } else {\n // set dispatcher state to call service handler\n let fut = this.flow.service.call(req);\n this.state.set(State::ServiceCall { fut });\n };\n };\n\n // eagerly poll the future once (or twice if expect is resolved immediately).\n loop {\n match self.as_mut().project().state.project() {\n StateProj::ExpectCall { fut } => {\n match fut.poll(cx) {\n // expect is resolved; continue loop and poll the service call branch.\n Poll::Ready(Ok(req)) => {\n self.as_mut().send_continue();\n\n let mut this = self.as_mut().project();\n let fut = this.flow.service.call(req);\n this.state.set(State::ServiceCall { fut });\n\n continue;\n }\n\n // future is error; send response and return a result\n // on success to notify the dispatcher a new state is set and the outer loop\n // should be continued\n Poll::Ready(Err(err)) => {\n let res: Response = err.into();\n let (res, body) = res.replace_body(());\n return self.send_error_response(res, body);\n }\n\n // future is pending; return Ok(()) to notify that a new state is\n // set and the outer loop should be continue.\n Poll::Pending => return Ok(()),\n }\n }\n\n StateProj::ServiceCall { fut } => {\n // return no matter the service call future's result.\n return match fut.poll(cx) {\n // Future is resolved. Send response and return a result. On success\n // to notify the dispatcher a new state is set and the outer loop\n // should be continue.\n Poll::Ready(Ok(res)) => {\n let (res, body) = res.into().replace_body(());\n self.as_mut().send_response(res, body)\n }\n\n // see the comment on ExpectCall state branch's Pending\n Poll::Pending => Ok(()),\n\n // see the comment on ExpectCall state branch's Ready(Err(_))\n Poll::Ready(Err(err)) => {\n let res: Response = err.into();\n let (res, body) = res.replace_body(());\n self.as_mut().send_error_response(res, body)\n }\n };\n }\n\n _ => {\n unreachable!(\"State must be set to ServiceCall or ExceptCall in handle_request\")\n }\n }\n }\n }\n\n /// Process one incoming request.\n ///\n /// Returns true if any meaningful work was done.\n fn poll_request(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Result {\n let pipeline_queue_full = self.messages.len() >= MAX_PIPELINED_MESSAGES;\n let can_not_read = !self.can_read(cx);\n\n // limit amount of non-processed requests\n if pipeline_queue_full || can_not_read {\n return Ok(false);\n }\n\n let mut this = self.as_mut().project();\n\n let mut updated = false;\n\n // decode from read buf as many full requests as possible\n loop {\n match this.codec.decode(this.read_buf) {\n Ok(Some(msg)) => {\n updated = true;\n\n match msg {\n Message::Item(mut req) => {\n // head timer only applies to first request on connection\n this.head_timer.clear(line!());\n\n req.head_mut().peer_addr = *this.peer_addr;\n\n req.conn_data.clone_from(this.conn_data);\n\n match this.codec.message_type() {\n // request has no payload\n MessageType::None => *this.payload_drainable = false,\n\n // Request is upgradable. Add upgrade message and break.\n // Everything remaining in read buffer will be handed to\n // upgraded Request.\n MessageType::Stream if this.flow.upgrade.is_some() => {\n *this.payload_drainable = false;\n this.messages.push_back(DispatcherMessage::Upgrade(req));\n break;\n }\n\n // request is not upgradable\n MessageType::Payload | MessageType::Stream => {\n // PayloadSender and Payload are smart pointers share the\n // same state. PayloadSender is attached to dispatcher and used\n // to sink new chunked request data to state. Payload is\n // attached to Request and passed to Service::call where the\n // state can be collected and consumed.\n let (sender, payload) = Payload::create(false);\n *req.payload() = crate::Payload::H1 { payload };\n *this.payload = Some(sender);\n *this.payload_drainable = req.chunked().unwrap_or(false);\n }\n }\n\n // handle request early when no future in InnerDispatcher state.\n if this.state.is_none() {\n self.as_mut().handle_request(req, cx)?;\n this = self.as_mut().project();\n } else {\n this.messages.push_back(DispatcherMessage::Item(req));\n }\n }\n\n Message::Chunk(Some(chunk)) => {\n if let Some(ref mut payload) = this.payload {\n payload.feed_data(chunk);\n } else {\n error!(\"Internal server error: unexpected payload chunk\");\n this.flags.insert(Flags::READ_DISCONNECT);\n this.messages.push_back(DispatcherMessage::Error(\n Response::internal_server_error().drop_body(),\n ));\n *this.error = Some(DispatchError::InternalError);\n break;\n }\n }\n\n Message::Chunk(None) => {\n if let Some(mut payload) = this.payload.take() {\n payload.feed_eof();\n *this.payload_drainable = false;\n } else {\n error!(\"Internal server error: unexpected eof\");\n this.flags.insert(Flags::READ_DISCONNECT);\n this.messages.push_back(DispatcherMessage::Error(\n Response::internal_server_error().drop_body(),\n ));\n *this.error = Some(DispatchError::InternalError);\n break;\n }\n }\n }\n }\n\n // decode is partial and buffer is not full yet\n // break and wait for more read\n Ok(None) => break,\n\n Err(ParseError::Io(err)) => {\n trace!(\"I/O error: {}\", &err);\n self.as_mut().client_disconnected();\n this = self.as_mut().project();\n *this.error = Some(DispatchError::Io(err));\n break;\n }\n\n Err(ParseError::TooLarge) => {\n trace!(\"request head was too big; returning 431 response\");\n\n if let Some(mut payload) = this.payload.take() {\n payload.set_error(PayloadError::Overflow);\n }\n\n // request heads that overflow buffer size return a 431 error\n this.messages\n .push_back(DispatcherMessage::Error(Response::with_body(\n StatusCode::REQUEST_HEADER_FIELDS_TOO_LARGE,\n (),\n )));\n\n this.flags.insert(Flags::READ_DISCONNECT);\n *this.error = Some(ParseError::TooLarge.into());\n\n break;\n }\n\n Err(err) => {\n trace!(\"parse error {}\", &err);\n\n if let Some(mut payload) = this.payload.take() {\n payload.set_error(PayloadError::EncodingCorrupted);\n }\n\n // malformed requests should be responded with 400\n this.messages.push_back(DispatcherMessage::Error(\n Response::bad_request().drop_body(),\n ));\n\n this.flags.insert(Flags::READ_DISCONNECT);\n *this.error = Some(err.into());\n break;\n }\n }\n }\n\n Ok(updated)\n }\n\n fn poll_head_timer(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Result<(), DispatchError> {\n let this = self.as_mut().project();\n\n if let TimerState::Active { timer } = this.head_timer {\n if timer.as_mut().poll(cx).is_ready() {\n // timeout on first request (slow request) return 408\n\n trace!(\"timed out on slow request; replying with 408 and closing connection\");\n\n let _ = self.as_mut().send_error_response(\n Response::with_body(StatusCode::REQUEST_TIMEOUT, ()),\n BoxBody::new(()),\n );\n\n self.project().flags.insert(Flags::SHUTDOWN);\n }\n };\n\n Ok(())\n }\n\n fn poll_ka_timer(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Result<(), DispatchError> {\n let this = self.as_mut().project();\n if let TimerState::Active { timer } = this.ka_timer {\n debug_assert!(\n this.flags.contains(Flags::KEEP_ALIVE),\n \"keep-alive flag should be set when timer is active\",\n );\n debug_assert!(\n this.state.is_none(),\n \"dispatcher should not be in keep-alive phase if state is not none: {:?}\",\n this.state,\n );\n\n // Assert removed by @robjtede on account of issue #2655. There are cases where an I/O\n // flush can be pending after entering the keep-alive state causing the subsequent flush\n // wake up to panic here. This appears to be a Linux-only problem. Leaving original code\n // below for posterity because a simple and reliable test could not be found to trigger\n // the behavior.\n // debug_assert!(\n // this.write_buf.is_empty(),\n // \"dispatcher should not be in keep-alive phase if write_buf is not empty\",\n // );\n\n // keep-alive timer has timed out\n if timer.as_mut().poll(cx).is_ready() {\n // no tasks at hand\n trace!(\"timer timed out; closing connection\");\n this.flags.insert(Flags::SHUTDOWN);\n\n if let Some(deadline) = this.config.client_disconnect_deadline() {\n // start shutdown timeout if enabled\n this.shutdown_timer\n .set_and_init(cx, sleep_until(deadline.into()), line!());\n } else {\n // no shutdown timeout, drop socket\n this.flags.insert(Flags::WRITE_DISCONNECT);\n }\n }\n }\n\n Ok(())\n }\n\n fn poll_shutdown_timer(\n mut self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Result<(), DispatchError> {\n let this = self.as_mut().project();\n if let TimerState::Active { timer } = this.shutdown_timer {\n debug_assert!(\n this.flags.contains(Flags::SHUTDOWN),\n \"shutdown flag should be set when timer is active\",\n );\n\n // timed-out during shutdown; drop connection\n if timer.as_mut().poll(cx).is_ready() {\n trace!(\"timed-out during shutdown\");\n return Err(DispatchError::DisconnectTimeout);\n }\n }\n\n Ok(())\n }\n\n /// Poll head, keep-alive, and disconnect timer.\n fn poll_timers(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Result<(), DispatchError> {\n self.as_mut().poll_head_timer(cx)?;\n self.as_mut().poll_ka_timer(cx)?;\n self.as_mut().poll_shutdown_timer(cx)?;\n\n Ok(())\n }\n\n /// Returns true when I/O stream can be disconnected after write to it.\n ///\n /// It covers these conditions:\n /// - `std::io::ErrorKind::ConnectionReset` after partial read;\n /// - all data read done.\n #[inline(always)] // TODO: bench this inline\n fn read_available(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Result {\n let this = self.project();\n\n if this.flags.contains(Flags::READ_DISCONNECT) {\n return Ok(false);\n };\n\n let mut io = Pin::new(this.io.as_mut().unwrap());\n\n let mut read_some = false;\n\n loop {\n // Return early when read buf exceed decoder's max buffer size.\n if this.read_buf.len() >= MAX_BUFFER_SIZE {\n // At this point it's not known IO stream is still scheduled to be waked up so\n // force wake up dispatcher just in case.\n //\n // Reason:\n // AsyncRead mostly would only have guarantee wake up when the poll_read\n // return Poll::Pending.\n //\n // Case:\n // When read_buf is beyond max buffer size the early return could be successfully\n // be parsed as a new Request. This case would not generate ParseError::TooLarge and\n // at this point IO stream is not fully read to Pending and would result in\n // dispatcher stuck until timeout (keep-alive).\n //\n // Note:\n // This is a perf choice to reduce branch on ::decode.\n //\n // A Request head too large to parse is only checked on `httparse::Status::Partial`.\n\n match this.payload.as_ref().map(|p| p.need_read(cx)) {\n // Payload consumer is alive but applying backpressure. Wait for its waker.\n Some(PayloadStatus::Pause) => {}\n\n // Consumer dropped means drain/discard mode; keep polling to make progress.\n Some(PayloadStatus::Dropped) | Some(PayloadStatus::Read) | None => {\n cx.waker().wake_by_ref()\n }\n }\n\n return Ok(false);\n }\n\n // grow buffer if necessary.\n let remaining = this.read_buf.capacity() - this.read_buf.len();\n if remaining < LW_BUFFER_SIZE {\n this.read_buf.reserve(HW_BUFFER_SIZE - remaining);\n }\n\n match tokio_util::io::poll_read_buf(io.as_mut(), cx, this.read_buf) {\n Poll::Ready(Ok(n)) => {\n // When draining a dropped request payload, keep FINISHED set so the\n // disconnect/keep-alive decision can be made once the payload is fully drained.\n if !this.payload.as_ref().is_some_and(|pl| pl.is_dropped()) {\n this.flags.remove(Flags::FINISHED);\n }\n\n if n == 0 {\n return Ok(true);\n }\n\n read_some = true;\n }\n\n Poll::Pending => {\n return Ok(false);\n }\n\n Poll::Ready(Err(err)) => {\n return match err.kind() {\n // convert WouldBlock error to the same as Pending return\n io::ErrorKind::WouldBlock => Ok(false),\n\n // connection reset after partial read\n io::ErrorKind::ConnectionReset if read_some => Ok(true),\n\n _ => Err(DispatchError::Io(err)),\n };\n }\n }\n }\n }\n\n /// call upgrade service with request.\n fn upgrade(self: Pin<&mut Self>, req: Request) -> U::Future {\n let this = self.project();\n let mut parts = FramedParts::with_read_buf(\n this.io.take().unwrap(),\n mem::take(this.codec),\n mem::take(this.read_buf),\n );\n parts.write_buf = mem::take(this.write_buf);\n let framed = Framed::from_parts(parts);\n this.flow.upgrade.as_ref().unwrap().call((req, framed))\n }\n}\n\nimpl Future for Dispatcher\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n\n S: Service,\n S::Error: Into>,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display,\n{\n type Output = Result<(), DispatchError>;\n\n #[inline]\n fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll {\n let this = self.as_mut().project();\n\n #[cfg(test)]\n {\n *this.poll_count += 1;\n }\n\n match this.inner.project() {\n DispatcherStateProj::Upgrade { fut: upgrade } => upgrade.poll(cx).map_err(|err| {\n error!(\"Upgrade handler error: {}\", err);\n DispatchError::Upgrade\n }),\n\n DispatcherStateProj::Normal { mut inner } => {\n trace!(\"start flags: {:?}\", &inner.flags);\n\n trace_timer_states(\n \"start\",\n &inner.head_timer,\n &inner.ka_timer,\n &inner.shutdown_timer,\n );\n\n inner.as_mut().poll_timers(cx)?;\n\n let poll = if inner.flags.contains(Flags::SHUTDOWN) {\n if inner.flags.contains(Flags::WRITE_DISCONNECT) {\n Poll::Ready(Ok(()))\n } else {\n // flush buffer and wait on blocked\n ready!(inner.as_mut().poll_flush(cx))?;\n Pin::new(inner.as_mut().project().io.as_mut().unwrap())\n .poll_shutdown(cx)\n .map_err(DispatchError::from)\n }\n } else {\n // read from I/O stream and fill read buffer\n let should_disconnect = inner.as_mut().read_available(cx)?;\n\n // after reading something from stream, clear keep-alive timer\n if !inner.read_buf.is_empty() && inner.flags.contains(Flags::KEEP_ALIVE) {\n let inner = inner.as_mut().project();\n inner.flags.remove(Flags::KEEP_ALIVE);\n inner.ka_timer.clear(line!());\n }\n\n if !inner.flags.contains(Flags::STARTED) {\n inner.as_mut().project().flags.insert(Flags::STARTED);\n\n if let Some(deadline) = inner.config.client_request_deadline() {\n inner.as_mut().project().head_timer.set_and_init(\n cx,\n sleep_until(deadline.into()),\n line!(),\n );\n }\n }\n\n inner.as_mut().poll_request(cx)?;\n\n if should_disconnect {\n // I/O stream should to be closed\n let inner = inner.as_mut().project();\n inner.flags.insert(Flags::READ_DISCONNECT);\n if let Some(mut payload) = inner.payload.take() {\n payload.set_error(PayloadError::Incomplete(None));\n payload.feed_eof();\n }\n };\n\n loop {\n // poll response to populate write buffer\n // drain indicates whether write buffer should be emptied before next run\n let drain = match inner.as_mut().poll_response(cx)? {\n PollResponse::DrainWriteBuf => true,\n\n PollResponse::DoNothing => {\n // KEEP_ALIVE is set in send_response_inner if client allows it\n // FINISHED is set after writing last chunk of response\n if inner.flags.contains(Flags::KEEP_ALIVE | Flags::FINISHED) {\n if let Some(timer) = inner.config.keep_alive_deadline() {\n inner.as_mut().project().ka_timer.set_and_init(\n cx,\n sleep_until(timer.into()),\n line!(),\n );\n }\n }\n\n false\n }\n\n // upgrade request and goes Upgrade variant of DispatcherState.\n PollResponse::Upgrade(req) => {\n let upgrade = inner.upgrade(req);\n self.as_mut()\n .project()\n .inner\n .set(DispatcherState::Upgrade { fut: upgrade });\n return self.poll(cx);\n }\n };\n\n // we didn't get WouldBlock from write operation, so data get written to\n // kernel completely (macOS) and we have to write again otherwise response\n // can get stuck\n //\n // TODO: want to find a reference for this behavior\n // see introduced commit: 3872d3ba\n let flush_was_ready = inner.as_mut().poll_flush(cx)?.is_ready();\n\n // this assert seems to always be true but not willing to commit to it until\n // we understand what Nikolay meant when writing the above comment\n // debug_assert!(flush_was_ready);\n\n if !flush_was_ready || !drain {\n break;\n }\n }\n\n // client is gone\n if inner.flags.contains(Flags::WRITE_DISCONNECT) {\n trace!(\"client is gone; disconnecting\");\n return Poll::Ready(Ok(()));\n }\n\n let inner_p = inner.as_mut().project();\n let state_is_none = inner_p.state.is_none();\n\n // If the read-half is closed, we start the shutdown procedure if either is\n // true:\n //\n // - state is [`State::None`], which means that we're done with request\n // processing, so if the client closed its writer-side it means that it won't\n // send more requests.\n // - The user requested to not allow half-closures\n if inner_p.flags.contains(Flags::READ_DISCONNECT)\n && (!inner_p.config.h1_allow_half_closed() || state_is_none)\n {\n trace!(\"read half closed; start shutdown\");\n inner_p.flags.insert(Flags::SHUTDOWN);\n }\n\n // keep-alive and stream errors\n if state_is_none && inner_p.write_buf.is_empty() {\n if let Some(err) = inner_p.error.take() {\n error!(\"stream error: {}\", &err);\n return Poll::Ready(Err(err));\n }\n\n // disconnect if keep-alive is not enabled\n if inner_p.flags.contains(Flags::FINISHED)\n && !inner_p.flags.contains(Flags::KEEP_ALIVE)\n && inner_p.payload.is_none()\n {\n inner_p.flags.remove(Flags::FINISHED);\n inner_p.flags.insert(Flags::SHUTDOWN);\n return self.poll(cx);\n }\n\n // disconnect if shutdown\n if inner_p.flags.contains(Flags::SHUTDOWN) {\n return self.poll(cx);\n }\n }\n\n trace_timer_states(\n \"end\",\n inner_p.head_timer,\n inner_p.ka_timer,\n inner_p.shutdown_timer,\n );\n\n if inner_p.flags.contains(Flags::SHUTDOWN) {\n cx.waker().wake_by_ref();\n }\n Poll::Pending\n };\n\n trace!(\"end flags: {:?}\", &inner.flags);\n\n poll\n }\n }\n }\n}\n\n#[allow(dead_code)]\nfn trace_timer_states(\n label: &str,\n head_timer: &TimerState,\n ka_timer: &TimerState,\n shutdown_timer: &TimerState,\n) {\n trace!(\"{} timers:\", label);\n\n if head_timer.is_enabled() {\n trace!(\" head {}\", &head_timer);\n }\n\n if ka_timer.is_enabled() {\n trace!(\" keep-alive {}\", &ka_timer);\n }\n\n if shutdown_timer.is_enabled() {\n trace!(\" shutdown {}\", &shutdown_timer);\n }\n}\n" }, { "path": "actix-http/src/h1/dispatcher_tests.rs", "content": "use std::{\n future::Future,\n pin::Pin,\n str,\n task::{Context, Poll},\n time::Duration,\n};\n\nuse actix_codec::Framed;\nuse actix_rt::{pin, time::sleep};\nuse actix_service::{fn_service, Service};\nuse actix_utils::future::{ready, Ready};\nuse bytes::{Buf, Bytes, BytesMut};\nuse futures_util::future::lazy;\n\nuse super::dispatcher::{Dispatcher, DispatcherState, DispatcherStateProj, Flags};\nuse crate::{\n body::{BoxBody, MessageBody},\n config::ServiceConfig,\n h1::{Codec, ExpectHandler, UpgradeHandler},\n service::HttpFlow,\n test::{TestBuffer, TestSeqBuffer},\n Error, HttpMessage, KeepAlive, Method, OnConnectData, Request, Response, StatusCode,\n};\n\nstruct YieldService;\n\nimpl Service for YieldService {\n type Response = Response;\n type Error = Response;\n type Future = Pin>>>;\n\n actix_service::always_ready!();\n\n fn call(&self, _: Request) -> Self::Future {\n Box::pin(async {\n // Yield twice because the dispatcher can poll the service twice per dispatcher's poll:\n // once in `handle_request` and another in `poll_response`\n actix_rt::task::yield_now().await;\n actix_rt::task::yield_now().await;\n Ok(Response::ok())\n })\n }\n}\n\nfn find_slice(haystack: &[u8], needle: &[u8], from: usize) -> Option {\n memchr::memmem::find(&haystack[from..], needle)\n}\n\nfn stabilize_date_header(payload: &mut [u8]) {\n let mut from = 0;\n while let Some(pos) = find_slice(payload, b\"date\", from) {\n payload[(from + pos)..(from + pos + 35)]\n .copy_from_slice(b\"date: Thu, 01 Jan 1970 12:34:56 UTC\");\n from += 35;\n }\n}\n\nfn ok_service() -> impl Service, Error = Error> {\n status_service(StatusCode::OK)\n}\n\nfn status_service(\n status: StatusCode,\n) -> impl Service, Error = Error> {\n fn_service(move |_req: Request| ready(Ok::<_, Error>(Response::new(status))))\n}\n\nfn echo_path_service() -> impl Service, Error = Error>\n{\n fn_service(|req: Request| {\n let path = req.path().as_bytes();\n ready(Ok::<_, Error>(\n Response::ok().set_body(Bytes::copy_from_slice(path)),\n ))\n })\n}\n\nfn drop_payload_service() -> impl Service, Error = Error>\n{\n fn_service(|mut req: Request| async move {\n let _ = req.take_payload();\n Ok::<_, Error>(Response::with_body(StatusCode::OK, \"payload dropped\"))\n })\n}\n\nfn echo_payload_service() -> impl Service, Error = Error> {\n fn_service(|mut req: Request| {\n Box::pin(async move {\n use futures_util::StreamExt as _;\n\n let mut pl = req.take_payload();\n let mut body = BytesMut::new();\n while let Some(chunk) = pl.next().await {\n body.extend_from_slice(chunk.unwrap().chunk())\n }\n\n Ok::<_, Error>(Response::ok().set_body(body.freeze()))\n })\n })\n}\n\n#[actix_rt::test]\nasync fn late_request() {\n let mut buf = TestBuffer::empty();\n\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::from_millis(100),\n Duration::ZERO,\n false,\n None,\n );\n let services = HttpFlow::new(ok_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n pin!(h1);\n\n lazy(|cx| {\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n match h1.as_mut().poll(cx) {\n Poll::Ready(_) => panic!(\"first poll should not be ready\"),\n Poll::Pending => {}\n }\n\n // polls: initial\n assert_eq!(h1.poll_count, 1);\n\n buf.extend_read_buf(\"GET /abcd HTTP/1.1\\r\\nConnection: close\\r\\n\\r\\n\");\n\n match h1.as_mut().poll(cx) {\n Poll::Pending => panic!(\"second poll should not be pending\"),\n Poll::Ready(res) => assert!(res.is_ok()),\n }\n\n // polls: initial pending => handle req => shutdown\n assert_eq!(h1.poll_count, 3);\n\n let mut res = buf.take_write_buf().to_vec();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 0\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn oneshot_connection() {\n let buf = TestBuffer::new(\"GET /abcd HTTP/1.1\\r\\n\\r\\n\");\n\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::from_millis(100),\n Duration::ZERO,\n false,\n None,\n );\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n pin!(h1);\n\n lazy(|cx| {\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n match h1.as_mut().poll(cx) {\n Poll::Pending => panic!(\"first poll should not be pending\"),\n Poll::Ready(res) => assert!(res.is_ok()),\n }\n\n // polls: initial => shutdown\n assert_eq!(h1.poll_count, 2);\n\n let mut res = buf.take_write_buf().to_vec();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = http_msg(\n r\"\n HTTP/1.1 200 OK\n content-length: 5\n connection: close\n date: Thu, 01 Jan 1970 12:34:56 UTC\n\n /abcd\n \",\n );\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(&exp)\n );\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn keep_alive_timeout() {\n let buf = TestBuffer::new(\"GET /abcd HTTP/1.1\\r\\n\\r\\n\");\n\n let cfg = ServiceConfig::new(\n KeepAlive::Timeout(Duration::from_millis(200)),\n Duration::from_millis(100),\n Duration::ZERO,\n false,\n None,\n );\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n pin!(h1);\n\n lazy(|cx| {\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n assert!(\n h1.as_mut().poll(cx).is_pending(),\n \"keep-alive should prevent poll from resolving\"\n );\n\n // polls: initial\n assert_eq!(h1.poll_count, 1);\n\n let mut res = buf.take_write_buf().to_vec();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 5\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /abcd\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n })\n .await;\n\n // sleep slightly longer than keep-alive timeout\n sleep(Duration::from_millis(250)).await;\n\n lazy(|cx| {\n assert!(\n h1.as_mut().poll(cx).is_ready(),\n \"keep-alive should have resolved\",\n );\n\n // polls: initial => keep-alive wake-up shutdown\n assert_eq!(h1.poll_count, 2);\n\n if let DispatcherStateProj::Normal { inner } = h1.project().inner.project() {\n // connection closed\n assert!(inner.flags.contains(Flags::SHUTDOWN));\n assert!(inner.flags.contains(Flags::WRITE_DISCONNECT));\n // and nothing added to write buffer\n assert!(buf.write_buf_slice().is_empty());\n }\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn keep_alive_follow_up_req() {\n let mut buf = TestBuffer::new(\"GET /abcd HTTP/1.1\\r\\n\\r\\n\");\n\n let cfg = ServiceConfig::new(\n KeepAlive::Timeout(Duration::from_millis(500)),\n Duration::from_millis(100),\n Duration::ZERO,\n false,\n None,\n );\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n pin!(h1);\n\n lazy(|cx| {\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n assert!(\n h1.as_mut().poll(cx).is_pending(),\n \"keep-alive should prevent poll from resolving\"\n );\n\n // polls: initial\n assert_eq!(h1.poll_count, 1);\n\n let mut res = buf.take_write_buf().to_vec();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 5\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /abcd\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n })\n .await;\n\n // sleep for less than KA timeout\n sleep(Duration::from_millis(100)).await;\n\n lazy(|cx| {\n assert!(\n h1.as_mut().poll(cx).is_pending(),\n \"keep-alive should not have resolved dispatcher yet\",\n );\n\n // polls: initial => manual\n assert_eq!(h1.poll_count, 2);\n\n if let DispatcherStateProj::Normal { inner } = h1.as_mut().project().inner.project() {\n // connection not closed\n assert!(!inner.flags.contains(Flags::SHUTDOWN));\n assert!(!inner.flags.contains(Flags::WRITE_DISCONNECT));\n // and nothing added to write buffer\n assert!(buf.write_buf_slice().is_empty());\n }\n })\n .await;\n\n lazy(|cx| {\n buf.extend_read_buf(\n \"\\\n GET /efg HTTP/1.1\\r\\n\\\n Connection: close\\r\\n\\\n \\r\\n\\r\\n\",\n );\n\n assert!(\n h1.as_mut().poll(cx).is_ready(),\n \"connection close header should override keep-alive setting\",\n );\n\n // polls: initial => manual => follow-up req => shutdown\n assert_eq!(h1.poll_count, 4);\n\n if let DispatcherStateProj::Normal { inner } = h1.as_mut().project().inner.project() {\n // connection closed\n assert!(inner.flags.contains(Flags::SHUTDOWN));\n assert!(!inner.flags.contains(Flags::WRITE_DISCONNECT));\n }\n\n let mut res = buf.take_write_buf().to_vec();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 4\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /efg\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn req_parse_err() {\n lazy(|cx| {\n let buf = TestBuffer::new(\"GET /test HTTP/1\\r\\n\\r\\n\");\n\n let services = HttpFlow::new(ok_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n ServiceConfig::default(),\n None,\n OnConnectData::default(),\n );\n\n pin!(h1);\n\n match h1.as_mut().poll(cx) {\n Poll::Pending => panic!(),\n Poll::Ready(res) => assert!(res.is_err()),\n }\n\n if let DispatcherStateProj::Normal { inner } = h1.project().inner.project() {\n assert!(inner.flags.contains(Flags::READ_DISCONNECT));\n assert_eq!(\n &buf.write_buf_slice()[..26],\n b\"HTTP/1.1 400 Bad Request\\r\\n\"\n );\n }\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn pipelining_ok_then_ok() {\n lazy(|cx| {\n let buf = TestBuffer::new(\n \"\\\n GET /abcd HTTP/1.1\\r\\n\\r\\n\\\n GET /def HTTP/1.1\\r\\n\\r\\n\\\n \",\n );\n\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::from_millis(1),\n Duration::from_millis(1),\n false,\n None,\n );\n\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n\n pin!(h1);\n\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n match h1.as_mut().poll(cx) {\n Poll::Pending => panic!(\"first poll should not be pending\"),\n Poll::Ready(res) => assert!(res.is_ok()),\n }\n\n // polls: initial => shutdown\n assert_eq!(h1.poll_count, 2);\n\n let mut res = buf.write_buf_slice_mut();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 5\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /abcd\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 4\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /def\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn early_response_with_payload_closes_connection() {\n lazy(|cx| {\n let buf = TestBuffer::new(\n \"\\\n GET /unfinished HTTP/1.1\\r\\n\\\n Content-Length: 2\\r\\n\\\n \\r\\n\\\n \",\n );\n\n let cfg = ServiceConfig::new(\n KeepAlive::Os,\n Duration::from_millis(1),\n Duration::from_millis(1),\n false,\n None,\n );\n\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n\n pin!(h1);\n\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n match h1.as_mut().poll(cx) {\n Poll::Pending => panic!(\"Should have shut down\"),\n Poll::Ready(res) => assert!(res.is_ok()),\n }\n\n // polls: initial => shutdown\n assert_eq!(h1.poll_count, 2);\n\n {\n let mut res = buf.write_buf_slice_mut();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 11\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /unfinished\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n }\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn pipelining_ok_then_bad() {\n lazy(|cx| {\n let buf = TestBuffer::new(\n \"\\\n GET /abcd HTTP/1.1\\r\\n\\r\\n\\\n GET /def HTTP/1\\r\\n\\r\\n\\\n \",\n );\n\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::from_millis(1),\n Duration::from_millis(1),\n false,\n None,\n );\n\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n\n pin!(h1);\n\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n match h1.as_mut().poll(cx) {\n Poll::Pending => panic!(\"first poll should not be pending\"),\n Poll::Ready(res) => assert!(res.is_err()),\n }\n\n // polls: initial => shutdown\n assert_eq!(h1.poll_count, 1);\n\n let mut res = buf.write_buf_slice_mut();\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = b\"\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 5\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n /abcd\\\n HTTP/1.1 400 Bad Request\\r\\n\\\n content-length: 0\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\r\\n\\\n \";\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(exp)\n );\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn expect_handling() {\n lazy(|cx| {\n let mut buf = TestSeqBuffer::empty();\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::ZERO,\n Duration::ZERO,\n false,\n None,\n );\n\n let services = HttpFlow::new(echo_payload_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n\n buf.extend_read_buf(\n \"\\\n POST /upload HTTP/1.1\\r\\n\\\n Content-Length: 5\\r\\n\\\n Expect: 100-continue\\r\\n\\\n \\r\\n\\\n \",\n );\n\n pin!(h1);\n\n assert!(h1.as_mut().poll(cx).is_pending());\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n // polls: manual\n assert_eq!(h1.poll_count, 1);\n\n if let DispatcherState::Normal { ref inner } = h1.inner {\n let io = inner.io.as_ref().unwrap();\n let res = &io.write_buf()[..];\n assert_eq!(\n str::from_utf8(res).unwrap(),\n \"HTTP/1.1 100 Continue\\r\\n\\r\\n\"\n );\n }\n\n buf.extend_read_buf(\"12345\");\n assert!(h1.as_mut().poll(cx).is_ready());\n\n // polls: manual manual shutdown\n assert_eq!(h1.poll_count, 3);\n\n if let DispatcherState::Normal { ref inner } = h1.inner {\n let io = inner.io.as_ref().unwrap();\n let mut res = io.write_buf()[..].to_owned();\n stabilize_date_header(&mut res);\n\n assert_eq!(\n str::from_utf8(&res).unwrap(),\n \"\\\n HTTP/1.1 100 Continue\\r\\n\\\n \\r\\n\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 5\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\\n \\r\\n\\\n 12345\\\n \"\n );\n }\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn expect_eager() {\n lazy(|cx| {\n let mut buf = TestSeqBuffer::empty();\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::ZERO,\n Duration::ZERO,\n false,\n None,\n );\n\n let services = HttpFlow::new(echo_path_service(), ExpectHandler, None);\n\n let h1 = Dispatcher::<_, _, _, _, UpgradeHandler>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n\n buf.extend_read_buf(\n \"\\\n POST /upload HTTP/1.1\\r\\n\\\n Content-Length: 5\\r\\n\\\n Expect: 100-continue\\r\\n\\\n \\r\\n\\\n \",\n );\n\n pin!(h1);\n\n assert!(h1.as_mut().poll(cx).is_ready());\n assert!(matches!(&h1.inner, DispatcherState::Normal { .. }));\n\n // polls: manual shutdown\n assert_eq!(h1.poll_count, 2);\n\n if let DispatcherState::Normal { ref inner } = h1.inner {\n let io = inner.io.as_ref().unwrap();\n let mut res = io.write_buf()[..].to_owned();\n stabilize_date_header(&mut res);\n\n // Despite the content-length header and even though the request payload has not\n // been sent, this test expects a complete service response since the payload\n // is not used at all. The service passed to dispatcher is path echo and doesn't\n // consume payload bytes.\n assert_eq!(\n str::from_utf8(&res).unwrap(),\n \"\\\n HTTP/1.1 100 Continue\\r\\n\\\n \\r\\n\\\n HTTP/1.1 200 OK\\r\\n\\\n content-length: 7\\r\\n\\\n connection: close\\r\\n\\\n date: Thu, 01 Jan 1970 12:34:56 UTC\\r\\n\\\n \\r\\n\\\n /upload\\\n \"\n );\n }\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn upgrade_handling() {\n struct TestUpgrade;\n\n impl Service<(Request, Framed)> for TestUpgrade {\n type Response = ();\n type Error = Error;\n type Future = Ready>;\n\n actix_service::always_ready!();\n\n fn call(&self, (req, _framed): (Request, Framed)) -> Self::Future {\n assert_eq!(req.method(), Method::GET);\n assert!(req.upgrade());\n assert_eq!(req.headers().get(\"upgrade\").unwrap(), \"websocket\");\n ready(Ok(()))\n }\n }\n\n lazy(|cx| {\n let mut buf = TestSeqBuffer::empty();\n let cfg = ServiceConfig::new(\n KeepAlive::Disabled,\n Duration::ZERO,\n Duration::ZERO,\n false,\n None,\n );\n\n let services = HttpFlow::new(ok_service(), ExpectHandler, Some(TestUpgrade));\n\n let h1 = Dispatcher::<_, _, _, _, TestUpgrade>::new(\n buf.clone(),\n services,\n cfg,\n None,\n OnConnectData::default(),\n );\n\n buf.extend_read_buf(\n \"\\\n GET /ws HTTP/1.1\\r\\n\\\n Connection: Upgrade\\r\\n\\\n Upgrade: websocket\\r\\n\\\n \\r\\n\\\n \",\n );\n\n pin!(h1);\n\n assert!(h1.as_mut().poll(cx).is_ready());\n assert!(matches!(&h1.inner, DispatcherState::Upgrade { .. }));\n\n // polls: manual shutdown\n assert_eq!(h1.poll_count, 2);\n })\n .await;\n}\n\n// fix in #2624 reverted temporarily\n// complete fix tracked in #2745\n#[ignore]\n#[actix_rt::test]\nasync fn handler_drop_payload() {\n let _ = env_logger::try_init();\n\n let mut buf = TestBuffer::new(http_msg(\n r\"\n POST /drop-payload HTTP/1.1\n Content-Length: 3\n \n abc\n \",\n ));\n\n let services = HttpFlow::new(\n drop_payload_service(),\n ExpectHandler,\n None::,\n );\n\n let h1 = Dispatcher::new(\n buf.clone(),\n services,\n ServiceConfig::default(),\n None,\n OnConnectData::default(),\n );\n pin!(h1);\n\n lazy(|cx| {\n assert!(h1.as_mut().poll(cx).is_pending());\n\n // polls: manual\n assert_eq!(h1.poll_count, 1);\n\n let mut res = BytesMut::from(buf.take_write_buf().as_ref());\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = http_msg(\n r\"\n HTTP/1.1 200 OK\n content-length: 15\n date: Thu, 01 Jan 1970 12:34:56 UTC\n\n payload dropped\n \",\n );\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(&exp)\n );\n\n if let DispatcherStateProj::Normal { inner } = h1.as_mut().project().inner.project() {\n assert!(inner.state.is_none());\n }\n })\n .await;\n\n lazy(|cx| {\n // add message that claims to have payload longer than provided\n buf.extend_read_buf(http_msg(\n r\"\n POST /drop-payload HTTP/1.1\n Content-Length: 200\n \n abc\n \",\n ));\n\n assert!(h1.as_mut().poll(cx).is_pending());\n\n // polls: manual => manual\n assert_eq!(h1.poll_count, 2);\n\n let mut res = BytesMut::from(buf.take_write_buf().as_ref());\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n // expect response immediately even though request side has not finished reading payload\n let exp = http_msg(\n r\"\n HTTP/1.1 200 OK\n content-length: 15\n date: Thu, 01 Jan 1970 12:34:56 UTC\n\n payload dropped\n \",\n );\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(&exp)\n );\n })\n .await;\n\n lazy(|cx| {\n assert!(h1.as_mut().poll(cx).is_ready());\n\n // polls: manual => manual => manual\n assert_eq!(h1.poll_count, 3);\n\n let mut res = BytesMut::from(buf.take_write_buf().as_ref());\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n // expect that unrequested error response is sent back since connection could not be cleaned\n let exp = http_msg(\n r\"\n HTTP/1.1 500 Internal Server Error\n content-length: 0\n connection: close\n date: Thu, 01 Jan 1970 12:34:56 UTC\n\n \",\n );\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(&exp)\n );\n })\n .await;\n}\n\n// Handler drops request payload without reading it. Server should keep reading and discarding the\n// rest of the request body so clients that do not read the response until they've finished\n// writing the request (like `requests` in Python) do not deadlock.\n// ref. https://github.com/actix/actix-web/issues/2972\n#[actix_rt::test]\nasync fn handler_drop_payload_drains_body() {\n let _ = env_logger::try_init();\n\n let mut buf = TestSeqBuffer::new(http_msg(\n r\"\n POST /drop-payload HTTP/1.1\n Transfer-Encoding: chunked\n \n \",\n ));\n\n let services = HttpFlow::new(\n drop_payload_service(),\n ExpectHandler,\n None::,\n );\n\n let h1 = Dispatcher::new(\n buf.clone(),\n services,\n ServiceConfig::default(),\n None,\n OnConnectData::default(),\n );\n pin!(h1);\n\n lazy(|cx| {\n assert!(h1.as_mut().poll(cx).is_pending());\n\n let mut res = BytesMut::from(buf.take_write_buf().as_ref());\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = http_msg(\n r\"\n HTTP/1.1 200 OK\n content-length: 15\n date: Thu, 01 Jan 1970 12:34:56 UTC\n\n payload dropped\n \",\n );\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(&exp)\n );\n })\n .await;\n\n // stream a body larger than the dispatcher read buffer limit; it should still be drained\n // (read + decoded + discarded) without stalling.\n for _ in 0..32 {\n let data = vec![b'a'; 8192];\n let mut chunk = BytesMut::new();\n chunk.extend_from_slice(format!(\"{:x}\\r\\n\", data.len()).as_bytes());\n chunk.extend_from_slice(&data);\n chunk.extend_from_slice(b\"\\r\\n\");\n\n buf.extend_read_buf(chunk);\n\n lazy(|cx| {\n assert!(h1.as_mut().poll(cx).is_pending());\n assert!(buf.take_write_buf().is_empty());\n assert!(buf.read_buf().is_empty());\n })\n .await;\n }\n\n // terminating chunk\n buf.extend_read_buf(b\"0\\r\\n\\r\\n\");\n\n lazy(|cx| {\n assert!(h1.as_mut().poll(cx).is_pending());\n assert!(buf.take_write_buf().is_empty());\n assert!(buf.read_buf().is_empty());\n })\n .await;\n\n // connection should be able to accept another request after draining the previous body\n buf.extend_read_buf(http_msg(\"GET /drop-payload HTTP/1.1\"));\n\n lazy(|cx| {\n assert!(h1.as_mut().poll(cx).is_pending());\n\n let mut res = BytesMut::from(buf.take_write_buf().as_ref());\n stabilize_date_header(&mut res);\n let res = &res[..];\n\n let exp = http_msg(\n r\"\n HTTP/1.1 200 OK\n content-length: 15\n date: Thu, 01 Jan 1970 12:34:56 UTC\n\n payload dropped\n \",\n );\n\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(res),\n String::from_utf8_lossy(&exp)\n );\n })\n .await;\n}\n\n#[actix_rt::test]\nasync fn allow_half_closed() {\n let buf = TestSeqBuffer::new(http_msg(\"GET / HTTP/1.1\"));\n buf.close_read();\n let services = HttpFlow::new(YieldService, ExpectHandler, None::);\n\n let mut cx = Context::from_waker(futures_util::task::noop_waker_ref());\n let disptacher = Dispatcher::new(\n buf.clone(),\n services,\n ServiceConfig::default(),\n None,\n OnConnectData::default(),\n );\n pin!(disptacher);\n\n assert!(disptacher.as_mut().poll(&mut cx).is_pending());\n assert_eq!(disptacher.poll_count, 1);\n\n assert!(disptacher.as_mut().poll(&mut cx).is_ready());\n assert_eq!(disptacher.poll_count, 3);\n\n let mut res = BytesMut::from(buf.take_write_buf().as_ref());\n stabilize_date_header(&mut res);\n let exp = http_msg(\n r\"\n HTTP/1.1 200 OK\n content-length: 0\n date: Thu, 01 Jan 1970 12:34:56 UTC\n \",\n );\n assert_eq!(\n res,\n exp,\n \"\\nexpected response not in write buffer:\\n\\\n response: {:?}\\n\\\n expected: {:?}\",\n String::from_utf8_lossy(&res),\n String::from_utf8_lossy(&exp)\n );\n\n let DispatcherStateProj::Normal { inner } = disptacher.as_mut().project().inner.project()\n else {\n panic!(\"End dispatcher state should be Normal\");\n };\n assert!(inner.state.is_none());\n}\n\n#[actix_rt::test]\nasync fn disallow_half_closed() {\n use crate::{config::ServiceConfigBuilder, h1::dispatcher::State};\n\n let buf = TestSeqBuffer::new(http_msg(\"GET / HTTP/1.1\"));\n buf.close_read();\n let services = HttpFlow::new(YieldService, ExpectHandler, None::);\n let config = ServiceConfigBuilder::new()\n .h1_allow_half_closed(false)\n .build();\n\n let mut cx = Context::from_waker(futures_util::task::noop_waker_ref());\n let disptacher = Dispatcher::new(\n buf.clone(),\n services,\n config,\n None,\n OnConnectData::default(),\n );\n pin!(disptacher);\n\n assert!(disptacher.as_mut().poll(&mut cx).is_pending());\n assert_eq!(disptacher.poll_count, 1);\n\n assert!(disptacher.as_mut().poll(&mut cx).is_ready());\n assert_eq!(disptacher.poll_count, 2);\n\n let res = BytesMut::from(buf.take_write_buf().as_ref());\n assert!(res.is_empty());\n\n let DispatcherStateProj::Normal { inner } = disptacher.as_mut().project().inner.project()\n else {\n panic!(\"End dispatcher state should be Normal\");\n };\n assert!(matches!(inner.state, State::ServiceCall { .. }))\n}\n\nfn http_msg(msg: impl AsRef) -> BytesMut {\n let mut msg = msg\n .as_ref()\n .trim()\n .split('\\n')\n .map(|line| [line.trim_start(), \"\\r\"].concat())\n .collect::>()\n .join(\"\\n\");\n\n // remove trailing \\r\n msg.pop();\n\n if !msg.is_empty() && !msg.contains(\"\\r\\n\\r\\n\") {\n msg.push_str(\"\\r\\n\\r\\n\");\n }\n\n BytesMut::from(msg.as_bytes())\n}\n\n#[test]\nfn http_msg_creates_msg() {\n assert_eq!(http_msg(r\"\"), \"\");\n\n assert_eq!(\n http_msg(\n r\"\n POST / HTTP/1.1\n Content-Length: 3\n \n abc\n \"\n ),\n \"POST / HTTP/1.1\\r\\nContent-Length: 3\\r\\n\\r\\nabc\"\n );\n\n assert_eq!(\n http_msg(\n r\"\n GET / HTTP/1.1\n Content-Length: 3\n \n \"\n ),\n \"GET / HTTP/1.1\\r\\nContent-Length: 3\\r\\n\\r\\n\"\n );\n}\n" }, { "path": "actix-http/src/h1/encoder.rs", "content": "use std::{\n cmp,\n io::{self, Write as _},\n marker::PhantomData,\n ptr::copy_nonoverlapping,\n slice::from_raw_parts_mut,\n};\n\nuse bytes::{BufMut, BytesMut};\n\nuse crate::{\n body::BodySize,\n header::{\n map::Value, HeaderMap, HeaderName, CONNECTION, CONTENT_LENGTH, DATE, TRANSFER_ENCODING,\n },\n helpers, ConnectionType, RequestHeadType, Response, ServiceConfig, StatusCode, Version,\n};\n\nconst AVERAGE_HEADER_SIZE: usize = 30;\n\n#[derive(Debug)]\npub(crate) struct MessageEncoder {\n #[allow(dead_code)]\n pub length: BodySize,\n pub te: TransferEncoding,\n _phantom: PhantomData,\n}\n\nimpl Default for MessageEncoder {\n fn default() -> Self {\n MessageEncoder {\n length: BodySize::None,\n te: TransferEncoding::empty(),\n _phantom: PhantomData,\n }\n }\n}\n\npub(crate) trait MessageType: Sized {\n fn status(&self) -> Option;\n\n fn headers(&self) -> &HeaderMap;\n\n fn extra_headers(&self) -> Option<&HeaderMap>;\n\n fn camel_case(&self) -> bool {\n false\n }\n\n fn chunked(&self) -> bool;\n\n fn encode_status(&mut self, dst: &mut BytesMut) -> io::Result<()>;\n\n fn encode_headers(\n &mut self,\n dst: &mut BytesMut,\n version: Version,\n mut length: BodySize,\n conn_type: ConnectionType,\n config: &ServiceConfig,\n ) -> io::Result<()> {\n let chunked = self.chunked();\n let mut skip_len = length != BodySize::Stream;\n let camel_case = self.camel_case();\n\n // Content length\n if let Some(status) = self.status() {\n match status {\n StatusCode::CONTINUE\n | StatusCode::SWITCHING_PROTOCOLS\n | StatusCode::PROCESSING\n | StatusCode::NO_CONTENT => {\n // skip content-length and transfer-encoding headers\n // see https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.1\n // and https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.2\n skip_len = true;\n length = BodySize::None\n }\n\n StatusCode::NOT_MODIFIED => {\n // 304 responses should never have a body but should retain a manually set\n // content-length header\n // see https://datatracker.ietf.org/doc/html/rfc7232#section-4.1\n skip_len = false;\n length = BodySize::None;\n }\n\n _ => {}\n }\n }\n\n match length {\n BodySize::Stream => {\n if chunked {\n skip_len = true;\n if camel_case {\n dst.put_slice(b\"\\r\\nTransfer-Encoding: chunked\\r\\n\")\n } else {\n dst.put_slice(b\"\\r\\ntransfer-encoding: chunked\\r\\n\")\n }\n } else {\n skip_len = false;\n dst.put_slice(b\"\\r\\n\");\n }\n }\n BodySize::Sized(0) if camel_case => dst.put_slice(b\"\\r\\nContent-Length: 0\\r\\n\"),\n BodySize::Sized(0) => dst.put_slice(b\"\\r\\ncontent-length: 0\\r\\n\"),\n BodySize::Sized(len) => helpers::write_content_length(len, dst, camel_case),\n BodySize::None => dst.put_slice(b\"\\r\\n\"),\n }\n\n // Connection\n match conn_type {\n ConnectionType::Upgrade => {\n if camel_case {\n dst.put_slice(b\"Connection: Upgrade\\r\\n\")\n } else {\n dst.put_slice(b\"connection: upgrade\\r\\n\")\n }\n }\n ConnectionType::KeepAlive if version < Version::HTTP_11 => {\n if camel_case {\n dst.put_slice(b\"Connection: keep-alive\\r\\n\")\n } else {\n dst.put_slice(b\"connection: keep-alive\\r\\n\")\n }\n }\n ConnectionType::Close if version >= Version::HTTP_11 => {\n if camel_case {\n dst.put_slice(b\"Connection: close\\r\\n\")\n } else {\n dst.put_slice(b\"connection: close\\r\\n\")\n }\n }\n _ => {}\n }\n\n // write headers\n\n let mut has_date = false;\n\n let mut buf = dst.chunk_mut().as_mut_ptr();\n let mut remaining = dst.capacity() - dst.len();\n\n // tracks bytes written since last buffer resize\n // since buf is a raw pointer to a bytes container storage but is written to without the\n // container's knowledge, this is used to sync the containers cursor after data is written\n let mut pos = 0;\n\n self.write_headers(|key, value| {\n match *key {\n CONNECTION => return,\n TRANSFER_ENCODING | CONTENT_LENGTH if skip_len => return,\n DATE => has_date = true,\n _ => {}\n }\n\n let k = key.as_str().as_bytes();\n let k_len = k.len();\n\n for val in value.iter() {\n let v = val.as_ref();\n let v_len = v.len();\n\n // key length + value length + colon + space + \\r\\n\n let len = k_len + v_len + 4;\n\n if len > remaining {\n // SAFETY: all the bytes written up to position \"pos\" are initialized\n // the written byte count and pointer advancement are kept in sync\n unsafe {\n dst.advance_mut(pos);\n }\n\n pos = 0;\n dst.reserve(len * 2);\n remaining = dst.capacity() - dst.len();\n\n // re-assign buf raw pointer since it's possible that the buffer was\n // reallocated and/or resized\n buf = dst.chunk_mut().as_mut_ptr();\n }\n\n // SAFETY: on each write, it is enough to ensure that the advancement of\n // the cursor matches the number of bytes written\n unsafe {\n if camel_case {\n // use Camel-Case headers\n write_camel_case(k, buf, k_len);\n } else {\n write_data(k, buf, k_len);\n }\n\n buf = buf.add(k_len);\n\n write_data(b\": \", buf, 2);\n buf = buf.add(2);\n\n write_data(v, buf, v_len);\n buf = buf.add(v_len);\n\n write_data(b\"\\r\\n\", buf, 2);\n buf = buf.add(2);\n };\n\n pos += len;\n remaining -= len;\n }\n });\n\n // final cursor synchronization with the bytes container\n //\n // SAFETY: all the bytes written up to position \"pos\" are initialized\n // the written byte count and pointer advancement are kept in sync\n unsafe {\n dst.advance_mut(pos);\n }\n\n if !has_date {\n // optimized date header, write_date_header writes its own \\r\\n\n config.write_date_header(dst, camel_case);\n }\n\n // end-of-headers marker\n dst.extend_from_slice(b\"\\r\\n\");\n\n Ok(())\n }\n\n fn write_headers(&mut self, mut f: F)\n where\n F: FnMut(&HeaderName, &Value),\n {\n match self.extra_headers() {\n Some(headers) => {\n // merging headers from head and extra headers.\n self.headers()\n .inner\n .iter()\n .filter(|(name, _)| !headers.contains_key(*name))\n .chain(headers.inner.iter())\n .for_each(|(k, v)| f(k, v))\n }\n None => self.headers().inner.iter().for_each(|(k, v)| f(k, v)),\n }\n }\n}\n\nimpl MessageType for Response<()> {\n fn status(&self) -> Option {\n Some(self.head().status)\n }\n\n fn chunked(&self) -> bool {\n self.head().chunked()\n }\n\n fn headers(&self) -> &HeaderMap {\n &self.head().headers\n }\n\n fn extra_headers(&self) -> Option<&HeaderMap> {\n None\n }\n\n fn camel_case(&self) -> bool {\n self.head()\n .flags\n .contains(crate::message::Flags::CAMEL_CASE)\n }\n\n fn encode_status(&mut self, dst: &mut BytesMut) -> io::Result<()> {\n let head = self.head();\n let reason = head.reason().as_bytes();\n dst.reserve(256 + head.headers.len() * AVERAGE_HEADER_SIZE + reason.len());\n\n // status line\n helpers::write_status_line(head.version, head.status.as_u16(), dst);\n dst.put_slice(reason);\n Ok(())\n }\n}\n\nimpl MessageType for RequestHeadType {\n fn status(&self) -> Option {\n None\n }\n\n fn chunked(&self) -> bool {\n self.as_ref().chunked()\n }\n\n fn camel_case(&self) -> bool {\n self.as_ref().camel_case_headers()\n }\n\n fn headers(&self) -> &HeaderMap {\n self.as_ref().headers()\n }\n\n fn extra_headers(&self) -> Option<&HeaderMap> {\n self.extra_headers()\n }\n\n fn encode_status(&mut self, dst: &mut BytesMut) -> io::Result<()> {\n let head = self.as_ref();\n dst.reserve(256 + head.headers.len() * AVERAGE_HEADER_SIZE);\n write!(\n helpers::MutWriter(dst),\n \"{} {} {}\",\n head.method,\n head.uri.path_and_query().map(|u| u.as_str()).unwrap_or(\"/\"),\n match head.version {\n Version::HTTP_09 => \"HTTP/0.9\",\n Version::HTTP_10 => \"HTTP/1.0\",\n Version::HTTP_11 => \"HTTP/1.1\",\n Version::HTTP_2 => \"HTTP/2.0\",\n Version::HTTP_3 => \"HTTP/3.0\",\n _ => return Err(io::Error::other(\"Unsupported version\")),\n }\n )\n .map_err(io::Error::other)\n }\n}\n\nimpl MessageEncoder {\n /// Encode chunk.\n pub fn encode_chunk(&mut self, msg: &[u8], buf: &mut BytesMut) -> io::Result {\n self.te.encode(msg, buf)\n }\n\n /// Encode EOF.\n pub fn encode_eof(&mut self, buf: &mut BytesMut) -> io::Result<()> {\n self.te.encode_eof(buf)\n }\n\n /// Encode message.\n pub fn encode(\n &mut self,\n dst: &mut BytesMut,\n message: &mut T,\n head: bool,\n stream: bool,\n version: Version,\n length: BodySize,\n conn_type: ConnectionType,\n config: &ServiceConfig,\n ) -> io::Result<()> {\n // transfer encoding\n if !head {\n self.te = match length {\n BodySize::Sized(0) => TransferEncoding::empty(),\n BodySize::Sized(len) => TransferEncoding::length(len),\n BodySize::Stream => {\n if message.chunked() && !stream {\n TransferEncoding::chunked()\n } else {\n TransferEncoding::eof()\n }\n }\n BodySize::None => TransferEncoding::empty(),\n };\n } else {\n self.te = TransferEncoding::empty();\n }\n\n message.encode_status(dst)?;\n message.encode_headers(dst, version, length, conn_type, config)\n }\n}\n\n/// Encoders to handle different Transfer-Encodings.\n#[derive(Debug)]\npub(crate) struct TransferEncoding {\n kind: TransferEncodingKind,\n}\n\n#[derive(Debug, PartialEq, Clone)]\nenum TransferEncodingKind {\n /// An Encoder for when Transfer-Encoding includes `chunked`.\n Chunked(bool),\n\n /// An Encoder for when Content-Length is set.\n ///\n /// Enforces that the body is not longer than the Content-Length header.\n Length(u64),\n\n /// An Encoder for when Content-Length is not known.\n ///\n /// Application decides when to stop writing.\n Eof,\n}\n\nimpl TransferEncoding {\n #[inline]\n pub fn empty() -> TransferEncoding {\n TransferEncoding {\n kind: TransferEncodingKind::Length(0),\n }\n }\n\n #[inline]\n pub fn eof() -> TransferEncoding {\n TransferEncoding {\n kind: TransferEncodingKind::Eof,\n }\n }\n\n #[inline]\n pub fn chunked() -> TransferEncoding {\n TransferEncoding {\n kind: TransferEncodingKind::Chunked(false),\n }\n }\n\n #[inline]\n pub fn length(len: u64) -> TransferEncoding {\n TransferEncoding {\n kind: TransferEncodingKind::Length(len),\n }\n }\n\n /// Encode message. Return `EOF` state of encoder\n #[inline]\n pub fn encode(&mut self, msg: &[u8], buf: &mut BytesMut) -> io::Result {\n match self.kind {\n TransferEncodingKind::Eof => {\n let eof = msg.is_empty();\n buf.extend_from_slice(msg);\n Ok(eof)\n }\n TransferEncodingKind::Chunked(ref mut eof) => {\n if *eof {\n return Ok(true);\n }\n\n if msg.is_empty() {\n *eof = true;\n buf.extend_from_slice(b\"0\\r\\n\\r\\n\");\n } else {\n writeln!(helpers::MutWriter(buf), \"{:X}\\r\", msg.len())\n .map_err(io::Error::other)?;\n\n buf.reserve(msg.len() + 2);\n buf.extend_from_slice(msg);\n buf.extend_from_slice(b\"\\r\\n\");\n }\n Ok(*eof)\n }\n TransferEncodingKind::Length(ref mut remaining) => {\n if *remaining > 0 {\n if msg.is_empty() {\n return Ok(*remaining == 0);\n }\n let len = cmp::min(*remaining, msg.len() as u64);\n\n buf.extend_from_slice(&msg[..len as usize]);\n\n *remaining -= len;\n Ok(*remaining == 0)\n } else {\n Ok(true)\n }\n }\n }\n }\n\n /// Encode eof. Return `EOF` state of encoder\n #[inline]\n pub fn encode_eof(&mut self, buf: &mut BytesMut) -> io::Result<()> {\n match self.kind {\n TransferEncodingKind::Eof => Ok(()),\n TransferEncodingKind::Length(rem) => {\n if rem != 0 {\n Err(io::Error::new(io::ErrorKind::UnexpectedEof, \"\"))\n } else {\n Ok(())\n }\n }\n TransferEncodingKind::Chunked(ref mut eof) => {\n if !*eof {\n *eof = true;\n buf.extend_from_slice(b\"0\\r\\n\\r\\n\");\n }\n Ok(())\n }\n }\n }\n}\n\n/// # Safety\n/// Callers must ensure that the given `len` matches the given `value` length and that `buf` is\n/// valid for writes of at least `len` bytes.\nunsafe fn write_data(value: &[u8], buf: *mut u8, len: usize) {\n debug_assert_eq!(value.len(), len);\n copy_nonoverlapping(value.as_ptr(), buf, len);\n}\n\n/// # Safety\n/// Callers must ensure that the given `len` matches the given `value` length and that `buf` is\n/// valid for writes of at least `len` bytes.\nunsafe fn write_camel_case(value: &[u8], buf: *mut u8, len: usize) {\n // first copy entire (potentially wrong) slice to output\n write_data(value, buf, len);\n\n // SAFETY: We just initialized the buffer with `value`\n let buffer = from_raw_parts_mut(buf, len);\n\n let mut iter = value.iter();\n\n // first character should be uppercase\n if let Some(c @ b'a'..=b'z') = iter.next() {\n buffer[0] = c & 0b1101_1111;\n }\n\n // track 1 ahead of the current position since that's the location being assigned to\n let mut index = 2;\n\n // remaining characters after hyphens should also be uppercase\n while let Some(&c) = iter.next() {\n if c == b'-' {\n // advance iter by one and uppercase if needed\n if let Some(c @ b'a'..=b'z') = iter.next() {\n buffer[index] = c & 0b1101_1111;\n }\n index += 1;\n }\n\n index += 1;\n }\n}\n\n#[cfg(test)]\nmod tests {\n use std::rc::Rc;\n\n use bytes::Bytes;\n use http::header::{AUTHORIZATION, UPGRADE_INSECURE_REQUESTS};\n\n use super::*;\n use crate::{\n header::{HeaderValue, CONTENT_TYPE},\n RequestHead,\n };\n\n #[test]\n fn test_chunked_te() {\n let mut bytes = BytesMut::new();\n let mut enc = TransferEncoding::chunked();\n {\n assert!(!enc.encode(b\"test\", &mut bytes).ok().unwrap());\n assert!(enc.encode(b\"\", &mut bytes).ok().unwrap());\n }\n assert_eq!(\n bytes.split().freeze(),\n Bytes::from_static(b\"4\\r\\ntest\\r\\n0\\r\\n\\r\\n\")\n );\n }\n\n #[actix_rt::test]\n async fn test_camel_case() {\n let mut bytes = BytesMut::with_capacity(2048);\n let mut head = RequestHead::default();\n head.set_camel_case_headers(true);\n head.headers.insert(DATE, HeaderValue::from_static(\"date\"));\n head.headers\n .insert(CONTENT_TYPE, HeaderValue::from_static(\"plain/text\"));\n\n head.headers\n .insert(UPGRADE_INSECURE_REQUESTS, HeaderValue::from_static(\"1\"));\n\n let mut head = RequestHeadType::Owned(head);\n\n let _ = head.encode_headers(\n &mut bytes,\n Version::HTTP_11,\n BodySize::Sized(0),\n ConnectionType::Close,\n &ServiceConfig::default(),\n );\n let data = String::from_utf8(Vec::from(bytes.split().freeze().as_ref())).unwrap();\n\n assert!(data.contains(\"Content-Length: 0\\r\\n\"));\n assert!(data.contains(\"Connection: close\\r\\n\"));\n assert!(data.contains(\"Content-Type: plain/text\\r\\n\"));\n assert!(data.contains(\"Date: date\\r\\n\"));\n assert!(data.contains(\"Upgrade-Insecure-Requests: 1\\r\\n\"));\n\n let _ = head.encode_headers(\n &mut bytes,\n Version::HTTP_11,\n BodySize::None,\n ConnectionType::Upgrade,\n &ServiceConfig::default(),\n );\n let data = String::from_utf8(Vec::from(bytes.split().freeze().as_ref())).unwrap();\n assert!(data.contains(\"Connection: Upgrade\\r\\n\"));\n\n let _ = head.encode_headers(\n &mut bytes,\n Version::HTTP_11,\n BodySize::Stream,\n ConnectionType::KeepAlive,\n &ServiceConfig::default(),\n );\n let data = String::from_utf8(Vec::from(bytes.split().freeze().as_ref())).unwrap();\n assert!(data.contains(\"Transfer-Encoding: chunked\\r\\n\"));\n assert!(data.contains(\"Content-Type: plain/text\\r\\n\"));\n assert!(data.contains(\"Date: date\\r\\n\"));\n\n let mut head = RequestHead::default();\n head.set_camel_case_headers(false);\n head.headers.insert(DATE, HeaderValue::from_static(\"date\"));\n head.headers\n .insert(CONTENT_TYPE, HeaderValue::from_static(\"plain/text\"));\n head.headers\n .append(CONTENT_TYPE, HeaderValue::from_static(\"xml\"));\n\n let mut head = RequestHeadType::Owned(head);\n let _ = head.encode_headers(\n &mut bytes,\n Version::HTTP_11,\n BodySize::Stream,\n ConnectionType::KeepAlive,\n &ServiceConfig::default(),\n );\n let data = String::from_utf8(Vec::from(bytes.split().freeze().as_ref())).unwrap();\n assert!(data.contains(\"transfer-encoding: chunked\\r\\n\"));\n assert!(data.contains(\"content-type: xml\\r\\n\"));\n assert!(data.contains(\"content-type: plain/text\\r\\n\"));\n assert!(data.contains(\"date: date\\r\\n\"));\n }\n\n #[actix_rt::test]\n async fn test_extra_headers() {\n let mut bytes = BytesMut::with_capacity(2048);\n\n let mut head = RequestHead::default();\n head.headers.insert(\n AUTHORIZATION,\n HeaderValue::from_static(\"some authorization\"),\n );\n\n let mut extra_headers = HeaderMap::new();\n extra_headers.insert(\n AUTHORIZATION,\n HeaderValue::from_static(\"another authorization\"),\n );\n extra_headers.insert(DATE, HeaderValue::from_static(\"date\"));\n\n let mut head = RequestHeadType::Rc(Rc::new(head), Some(extra_headers));\n\n let _ = head.encode_headers(\n &mut bytes,\n Version::HTTP_11,\n BodySize::Sized(0),\n ConnectionType::Close,\n &ServiceConfig::default(),\n );\n let data = String::from_utf8(Vec::from(bytes.split().freeze().as_ref())).unwrap();\n assert!(data.contains(\"content-length: 0\\r\\n\"));\n assert!(data.contains(\"connection: close\\r\\n\"));\n assert!(data.contains(\"authorization: another authorization\\r\\n\"));\n assert!(data.contains(\"date: date\\r\\n\"));\n }\n\n #[actix_rt::test]\n async fn test_no_content_length() {\n let mut bytes = BytesMut::with_capacity(2048);\n\n let mut res = Response::with_body(StatusCode::SWITCHING_PROTOCOLS, ());\n res.headers_mut().insert(DATE, HeaderValue::from_static(\"\"));\n res.headers_mut()\n .insert(CONTENT_LENGTH, HeaderValue::from_static(\"0\"));\n\n let _ = res.encode_headers(\n &mut bytes,\n Version::HTTP_11,\n BodySize::Stream,\n ConnectionType::Upgrade,\n &ServiceConfig::default(),\n );\n let data = String::from_utf8(Vec::from(bytes.split().freeze().as_ref())).unwrap();\n assert!(!data.contains(\"content-length: 0\\r\\n\"));\n assert!(!data.contains(\"transfer-encoding: chunked\\r\\n\"));\n }\n}\n" }, { "path": "actix-http/src/h1/expect.rs", "content": "use actix_service::{Service, ServiceFactory};\nuse actix_utils::future::{ready, Ready};\n\nuse crate::{Error, Request};\n\npub struct ExpectHandler;\n\nimpl ServiceFactory for ExpectHandler {\n type Response = Request;\n type Error = Error;\n type Config = ();\n type Service = ExpectHandler;\n type InitError = Error;\n type Future = Ready>;\n\n fn new_service(&self, _: Self::Config) -> Self::Future {\n ready(Ok(ExpectHandler))\n }\n}\n\nimpl Service for ExpectHandler {\n type Response = Request;\n type Error = Error;\n type Future = Ready>;\n\n actix_service::always_ready!();\n\n fn call(&self, req: Request) -> Self::Future {\n ready(Ok(req))\n // TODO: add some way to trigger error\n // Err(error::ErrorExpectationFailed(\"test\"))\n }\n}\n" }, { "path": "actix-http/src/h1/mod.rs", "content": "//! HTTP/1 protocol implementation.\n\nuse bytes::{Bytes, BytesMut};\n\nmod chunked;\nmod client;\nmod codec;\nmod decoder;\nmod dispatcher;\n#[cfg(test)]\nmod dispatcher_tests;\nmod encoder;\nmod expect;\nmod payload;\nmod service;\nmod timer;\nmod upgrade;\nmod utils;\n\npub use self::{\n client::{ClientCodec, ClientPayloadCodec},\n codec::Codec,\n dispatcher::Dispatcher,\n expect::ExpectHandler,\n payload::Payload,\n service::{H1Service, H1ServiceHandler},\n upgrade::UpgradeHandler,\n utils::SendResponse,\n};\n\n#[derive(Debug)]\n/// Codec message\npub enum Message {\n /// HTTP message.\n Item(T),\n\n /// Payload chunk.\n Chunk(Option),\n}\n\nimpl From for Message {\n fn from(item: T) -> Self {\n Message::Item(item)\n }\n}\n\n/// Incoming request type\n#[derive(Debug, Clone, Copy, PartialEq, Eq)]\npub enum MessageType {\n None,\n Payload,\n Stream,\n}\n\nconst LW: usize = 2 * 1024;\nconst HW: usize = 32 * 1024;\n\npub(crate) fn reserve_readbuf(src: &mut BytesMut) {\n let cap = src.capacity();\n if cap < LW {\n src.reserve(HW - cap);\n }\n}\n\n#[cfg(test)]\nmod tests {\n use super::*;\n use crate::Request;\n\n impl Message {\n pub fn message(self) -> Request {\n match self {\n Message::Item(req) => req,\n _ => panic!(\"error\"),\n }\n }\n\n pub fn chunk(self) -> Bytes {\n match self {\n Message::Chunk(Some(data)) => data,\n _ => panic!(\"error\"),\n }\n }\n\n pub fn eof(self) -> bool {\n match self {\n Message::Chunk(None) => true,\n Message::Chunk(Some(_)) => false,\n _ => panic!(\"error\"),\n }\n }\n }\n}\n" }, { "path": "actix-http/src/h1/payload.rs", "content": "//! Payload stream\n\nuse std::{\n cell::RefCell,\n collections::VecDeque,\n pin::Pin,\n rc::{Rc, Weak},\n task::{Context, Poll, Waker},\n};\n\nuse bytes::Bytes;\nuse futures_core::Stream;\n\nuse crate::error::PayloadError;\n\n/// max buffer size 32k\npub(crate) const MAX_BUFFER_SIZE: usize = 32_768;\n\n#[derive(Debug, PartialEq, Eq)]\npub enum PayloadStatus {\n Read,\n Pause,\n Dropped,\n}\n\n/// Buffered stream of bytes chunks\n///\n/// Payload stores chunks in a vector. First chunk can be received with `poll_next`. Payload does\n/// not notify current task when new data is available.\n///\n/// Payload can be used as `Response` body stream.\n#[derive(Debug)]\npub struct Payload {\n inner: Rc>,\n}\n\nimpl Payload {\n /// Creates a payload stream.\n ///\n /// This method construct two objects responsible for bytes stream generation:\n /// - `PayloadSender` - *Sender* side of the stream\n /// - `Payload` - *Receiver* side of the stream\n pub fn create(eof: bool) -> (PayloadSender, Payload) {\n let shared = Rc::new(RefCell::new(Inner::new(eof)));\n\n (\n PayloadSender::new(Rc::downgrade(&shared)),\n Payload { inner: shared },\n )\n }\n\n /// Creates an empty payload.\n pub(crate) fn empty() -> Payload {\n Payload {\n inner: Rc::new(RefCell::new(Inner::new(true))),\n }\n }\n\n /// Length of the data in this payload\n #[cfg(test)]\n pub fn len(&self) -> usize {\n self.inner.borrow().len()\n }\n\n /// Is payload empty\n #[cfg(test)]\n pub fn is_empty(&self) -> bool {\n self.inner.borrow().len() == 0\n }\n\n /// Put unused data back to payload\n #[inline]\n pub fn unread_data(&mut self, data: Bytes) {\n self.inner.borrow_mut().unread_data(data);\n }\n}\n\nimpl Stream for Payload {\n type Item = Result;\n\n fn poll_next(\n self: Pin<&mut Self>,\n cx: &mut Context<'_>,\n ) -> Poll>> {\n Pin::new(&mut *self.inner.borrow_mut()).poll_next(cx)\n }\n}\n\n/// Sender part of the payload stream\npub struct PayloadSender {\n inner: Weak>,\n}\n\nimpl PayloadSender {\n fn new(inner: Weak>) -> Self {\n Self { inner }\n }\n\n #[inline]\n pub fn set_error(&mut self, err: PayloadError) {\n if let Some(shared) = self.inner.upgrade() {\n shared.borrow_mut().set_error(err)\n }\n }\n\n #[inline]\n pub fn feed_eof(&mut self) {\n if let Some(shared) = self.inner.upgrade() {\n shared.borrow_mut().feed_eof()\n }\n }\n\n #[inline]\n pub fn feed_data(&mut self, data: Bytes) {\n if let Some(shared) = self.inner.upgrade() {\n shared.borrow_mut().feed_data(data)\n }\n }\n\n #[allow(clippy::needless_pass_by_ref_mut)]\n #[inline]\n pub fn need_read(&self, cx: &mut Context<'_>) -> PayloadStatus {\n // we check need_read only if Payload (other side) is alive,\n // otherwise always return true (consume payload)\n if let Some(shared) = self.inner.upgrade() {\n if shared.borrow().need_read {\n PayloadStatus::Read\n } else {\n shared.borrow_mut().register_io(cx);\n PayloadStatus::Pause\n }\n } else {\n PayloadStatus::Dropped\n }\n }\n\n #[inline]\n pub fn is_dropped(&self) -> bool {\n self.inner.strong_count() == 0\n }\n}\n\n#[derive(Debug)]\nstruct Inner {\n len: usize,\n eof: bool,\n err: Option,\n need_read: bool,\n items: VecDeque,\n task: Option,\n io_task: Option,\n}\n\nimpl Inner {\n fn new(eof: bool) -> Self {\n Inner {\n eof,\n len: 0,\n err: None,\n items: VecDeque::new(),\n need_read: true,\n task: None,\n io_task: None,\n }\n }\n\n /// Wake up future waiting for payload data to be available.\n fn wake(&mut self) {\n if let Some(waker) = self.task.take() {\n waker.wake();\n }\n }\n\n /// Wake up future feeding data to Payload.\n fn wake_io(&mut self) {\n if let Some(waker) = self.io_task.take() {\n waker.wake();\n }\n }\n\n /// Register future waiting data from payload.\n /// Waker would be used in `Inner::wake`\n fn register(&mut self, cx: &Context<'_>) {\n if self.task.as_ref().is_none_or(|w| !cx.waker().will_wake(w)) {\n self.task = Some(cx.waker().clone());\n }\n }\n\n // Register future feeding data to payload.\n /// Waker would be used in `Inner::wake_io`\n fn register_io(&mut self, cx: &Context<'_>) {\n if self\n .io_task\n .as_ref()\n .is_none_or(|w| !cx.waker().will_wake(w))\n {\n self.io_task = Some(cx.waker().clone());\n }\n }\n\n #[inline]\n fn set_error(&mut self, err: PayloadError) {\n self.err = Some(err);\n self.wake();\n }\n\n #[inline]\n fn feed_eof(&mut self) {\n self.eof = true;\n self.wake();\n }\n\n #[inline]\n fn feed_data(&mut self, data: Bytes) {\n self.len += data.len();\n self.items.push_back(data);\n self.need_read = self.len < MAX_BUFFER_SIZE;\n self.wake();\n }\n\n #[cfg(test)]\n fn len(&self) -> usize {\n self.len\n }\n\n fn poll_next(\n mut self: Pin<&mut Self>,\n cx: &Context<'_>,\n ) -> Poll>> {\n if let Some(data) = self.items.pop_front() {\n self.len -= data.len();\n self.need_read = self.len < MAX_BUFFER_SIZE;\n\n if self.need_read && !self.eof {\n self.register(cx);\n }\n self.wake_io();\n Poll::Ready(Some(Ok(data)))\n } else if let Some(err) = self.err.take() {\n Poll::Ready(Some(Err(err)))\n } else if self.eof {\n Poll::Ready(None)\n } else {\n self.need_read = true;\n self.register(cx);\n self.wake_io();\n Poll::Pending\n }\n }\n\n fn unread_data(&mut self, data: Bytes) {\n self.len += data.len();\n self.items.push_front(data);\n }\n}\n\n#[cfg(test)]\nmod tests {\n use std::{task::Poll, time::Duration};\n\n use actix_rt::time::timeout;\n use actix_utils::future::poll_fn;\n use futures_util::{FutureExt, StreamExt};\n use static_assertions::{assert_impl_all, assert_not_impl_any};\n use tokio::sync::oneshot;\n\n use super::*;\n\n assert_impl_all!(Payload: Unpin);\n assert_not_impl_any!(Payload: Send, Sync);\n\n assert_impl_all!(Inner: Unpin, Send, Sync);\n\n const WAKE_TIMEOUT: Duration = Duration::from_secs(2);\n\n fn prepare_waking_test(\n mut payload: Payload,\n expected: Option>,\n ) -> (oneshot::Receiver<()>, actix_rt::task::JoinHandle<()>) {\n let (tx, rx) = oneshot::channel();\n\n let handle = actix_rt::spawn(async move {\n // Make sure to poll once to set the waker\n poll_fn(|cx| {\n assert!(payload.poll_next_unpin(cx).is_pending());\n Poll::Ready(())\n })\n .await;\n tx.send(()).unwrap();\n\n // actix-rt is single-threaded, so this won't race with `rx.await`\n let mut pend_once = false;\n poll_fn(|_| {\n if pend_once {\n Poll::Ready(())\n } else {\n // Return pending without storing wakers, we already did on the previous\n // `poll_fn`, now this task will only continue if the `sender` wakes us\n pend_once = true;\n Poll::Pending\n }\n })\n .await;\n\n let got = payload.next().now_or_never().unwrap();\n match expected {\n Some(Ok(_)) => assert!(got.unwrap().is_ok()),\n Some(Err(_)) => assert!(got.unwrap().is_err()),\n None => assert!(got.is_none()),\n }\n });\n (rx, handle)\n }\n\n #[actix_rt::test]\n async fn wake_on_error() {\n let (mut sender, payload) = Payload::create(false);\n let (rx, handle) = prepare_waking_test(payload, Some(Err(())));\n\n rx.await.unwrap();\n sender.set_error(PayloadError::Incomplete(None));\n timeout(WAKE_TIMEOUT, handle).await.unwrap().unwrap();\n }\n\n #[actix_rt::test]\n async fn wake_on_eof() {\n let (mut sender, payload) = Payload::create(false);\n let (rx, handle) = prepare_waking_test(payload, None);\n\n rx.await.unwrap();\n sender.feed_eof();\n timeout(WAKE_TIMEOUT, handle).await.unwrap().unwrap();\n }\n\n #[actix_rt::test]\n async fn test_unread_data() {\n let (_, mut payload) = Payload::create(false);\n\n payload.unread_data(Bytes::from(\"data\"));\n assert!(!payload.is_empty());\n assert_eq!(payload.len(), 4);\n\n assert_eq!(\n Bytes::from(\"data\"),\n poll_fn(|cx| Pin::new(&mut payload).poll_next(cx))\n .await\n .unwrap()\n .unwrap()\n );\n }\n}\n" }, { "path": "actix-http/src/h1/service.rs", "content": "use std::{\n fmt,\n marker::PhantomData,\n net,\n rc::Rc,\n task::{Context, Poll},\n};\n\nuse actix_codec::{AsyncRead, AsyncWrite, Framed};\nuse actix_rt::net::TcpStream;\nuse actix_service::{\n fn_service, IntoServiceFactory, Service, ServiceFactory, ServiceFactoryExt as _,\n};\nuse actix_utils::future::ready;\nuse futures_core::future::LocalBoxFuture;\nuse tracing::error;\n\nuse super::{codec::Codec, dispatcher::Dispatcher, ExpectHandler, UpgradeHandler};\nuse crate::{\n body::{BoxBody, MessageBody},\n config::ServiceConfig,\n error::DispatchError,\n service::HttpServiceHandler,\n ConnectCallback, OnConnectData, Request, Response,\n};\n\n/// `ServiceFactory` implementation for HTTP1 transport\npub struct H1Service {\n srv: S,\n cfg: ServiceConfig,\n expect: X,\n upgrade: Option,\n on_connect_ext: Option>>,\n _phantom: PhantomData,\n}\n\nimpl H1Service\nwhere\n S: ServiceFactory,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n B: MessageBody,\n{\n /// Create new `HttpService` instance with config.\n pub(crate) fn with_config>(\n cfg: ServiceConfig,\n service: F,\n ) -> Self {\n H1Service {\n cfg,\n srv: service.into_factory(),\n expect: ExpectHandler,\n upgrade: None,\n on_connect_ext: None,\n _phantom: PhantomData,\n }\n }\n}\n\nimpl H1Service\nwhere\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<(Request, Framed), Config = (), Response = ()>,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n{\n /// Create simple tcp stream service\n pub fn tcp(\n self,\n ) -> impl ServiceFactory\n {\n fn_service(|io: TcpStream| {\n let peer_addr = io.peer_addr().ok();\n ready(Ok((io, peer_addr)))\n })\n .and_then(self)\n }\n}\n\n#[cfg(feature = \"openssl\")]\nmod openssl {\n use actix_tls::accept::{\n openssl::{\n reexports::{Error as SslError, SslAcceptor},\n Acceptor, TlsStream,\n },\n TlsError,\n };\n\n use super::*;\n\n impl H1Service, S, B, X, U>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<\n (Request, Framed, Codec>),\n Config = (),\n Response = (),\n >,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n {\n /// Create OpenSSL based service.\n pub fn openssl(\n self,\n acceptor: SslAcceptor,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = (),\n > {\n Acceptor::new(acceptor)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(|io: TlsStream| {\n let peer_addr = io.get_ref().peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_20\")]\nmod rustls_0_20 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_20::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H1Service, S, B, X, U>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<\n (Request, Framed, Codec>),\n Config = (),\n Response = (),\n >,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n {\n /// Create Rustls v0.20 based service.\n pub fn rustls(\n self,\n config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = (),\n > {\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(|io: TlsStream| {\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_21\")]\nmod rustls_0_21 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_21::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H1Service, S, B, X, U>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<\n (Request, Framed, Codec>),\n Config = (),\n Response = (),\n >,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n {\n /// Create Rustls v0.21 based service.\n pub fn rustls_021(\n self,\n config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = (),\n > {\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(|io: TlsStream| {\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_22\")]\nmod rustls_0_22 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_22::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H1Service, S, B, X, U>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<\n (Request, Framed, Codec>),\n Config = (),\n Response = (),\n >,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n {\n /// Create Rustls v0.22 based service.\n pub fn rustls_0_22(\n self,\n config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = (),\n > {\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(|io: TlsStream| {\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_23\")]\nmod rustls_0_23 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_23::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H1Service, S, B, X, U>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::InitError: fmt::Debug,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<\n (Request, Framed, Codec>),\n Config = (),\n Response = (),\n >,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n {\n /// Create Rustls v0.23 based service.\n pub fn rustls_0_23(\n self,\n config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = (),\n > {\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(|io: TlsStream| {\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\nimpl H1Service\nwhere\n S: ServiceFactory,\n S::Error: Into>,\n S::Response: Into>,\n S::InitError: fmt::Debug,\n B: MessageBody,\n{\n pub fn expect(self, expect: X1) -> H1Service\n where\n X1: ServiceFactory,\n X1::Error: Into>,\n X1::InitError: fmt::Debug,\n {\n H1Service {\n expect,\n cfg: self.cfg,\n srv: self.srv,\n upgrade: self.upgrade,\n on_connect_ext: self.on_connect_ext,\n _phantom: PhantomData,\n }\n }\n\n pub fn upgrade(self, upgrade: Option) -> H1Service\n where\n U1: ServiceFactory<(Request, Framed), Response = ()>,\n U1::Error: fmt::Display,\n U1::InitError: fmt::Debug,\n {\n H1Service {\n upgrade,\n cfg: self.cfg,\n srv: self.srv,\n expect: self.expect,\n on_connect_ext: self.on_connect_ext,\n _phantom: PhantomData,\n }\n }\n\n /// Set on connect callback.\n pub(crate) fn on_connect_ext(mut self, f: Option>>) -> Self {\n self.on_connect_ext = f;\n self\n }\n}\n\nimpl ServiceFactory<(T, Option)> for H1Service\nwhere\n T: AsyncRead + AsyncWrite + Unpin + 'static,\n\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into>,\n S::Response: Into>,\n S::InitError: fmt::Debug,\n\n B: MessageBody,\n\n X: ServiceFactory,\n X::Future: 'static,\n X::Error: Into>,\n X::InitError: fmt::Debug,\n\n U: ServiceFactory<(Request, Framed), Config = (), Response = ()>,\n U::Future: 'static,\n U::Error: fmt::Display + Into>,\n U::InitError: fmt::Debug,\n{\n type Response = ();\n type Error = DispatchError;\n type Config = ();\n type Service = H1ServiceHandler;\n type InitError = ();\n type Future = LocalBoxFuture<'static, Result>;\n\n fn new_service(&self, _: ()) -> Self::Future {\n let service = self.srv.new_service(());\n let expect = self.expect.new_service(());\n let upgrade = self.upgrade.as_ref().map(|s| s.new_service(()));\n let on_connect_ext = self.on_connect_ext.clone();\n let cfg = self.cfg.clone();\n\n Box::pin(async move {\n let expect = expect.await.map_err(|err| {\n tracing::error!(\"Initialization of HTTP expect service error: {err:?}\");\n })?;\n\n let upgrade = match upgrade {\n Some(upgrade) => {\n let upgrade = upgrade.await.map_err(|err| {\n tracing::error!(\"Initialization of HTTP upgrade service error: {err:?}\");\n })?;\n Some(upgrade)\n }\n None => None,\n };\n\n let service = service\n .await\n .map_err(|err| error!(\"Initialization of HTTP service error: {err:?}\"))?;\n\n Ok(H1ServiceHandler::new(\n cfg,\n service,\n expect,\n upgrade,\n on_connect_ext,\n ))\n })\n }\n}\n\n/// `Service` implementation for HTTP/1 transport\npub type H1ServiceHandler = HttpServiceHandler;\n\nimpl Service<(T, Option)> for HttpServiceHandler\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n\n S: Service,\n S::Error: Into>,\n S::Response: Into>,\n\n B: MessageBody,\n\n X: Service,\n X::Error: Into>,\n\n U: Service<(Request, Framed), Response = ()>,\n U::Error: fmt::Display + Into>,\n{\n type Response = ();\n type Error = DispatchError;\n type Future = Dispatcher;\n\n fn poll_ready(&self, cx: &mut Context<'_>) -> Poll> {\n self._poll_ready(cx).map_err(|err| {\n error!(\"HTTP/1 service readiness error: {:?}\", err);\n DispatchError::Service(err)\n })\n }\n\n fn call(&self, (io, addr): (T, Option)) -> Self::Future {\n let conn_data = OnConnectData::from_io(&io, self.on_connect_ext.as_deref());\n Dispatcher::new(io, Rc::clone(&self.flow), self.cfg.clone(), addr, conn_data)\n }\n}\n" }, { "path": "actix-http/src/h1/timer.rs", "content": "use std::{fmt, future::Future, pin::Pin, task::Context};\n\nuse actix_rt::time::{Instant, Sleep};\nuse tracing::trace;\n\n#[derive(Debug)]\npub(super) enum TimerState {\n Disabled,\n Inactive,\n Active { timer: Pin> },\n}\n\nimpl TimerState {\n pub(super) fn new(enabled: bool) -> Self {\n if enabled {\n Self::Inactive\n } else {\n Self::Disabled\n }\n }\n\n pub(super) fn is_enabled(&self) -> bool {\n matches!(self, Self::Active { .. } | Self::Inactive)\n }\n\n pub(super) fn set(&mut self, timer: Sleep, line: u32) {\n if matches!(self, Self::Disabled) {\n trace!(\"setting disabled timer from line {}\", line);\n }\n\n *self = Self::Active {\n timer: Box::pin(timer),\n };\n }\n\n pub(super) fn set_and_init(&mut self, cx: &mut Context<'_>, timer: Sleep, line: u32) {\n self.set(timer, line);\n self.init(cx);\n }\n\n pub(super) fn clear(&mut self, line: u32) {\n if matches!(self, Self::Disabled) {\n trace!(\"trying to clear a disabled timer from line {}\", line);\n }\n\n if matches!(self, Self::Inactive) {\n trace!(\"trying to clear an inactive timer from line {}\", line);\n }\n\n *self = Self::Inactive;\n }\n\n pub(super) fn init(&mut self, cx: &mut Context<'_>) {\n if let TimerState::Active { timer } = self {\n let _ = timer.as_mut().poll(cx);\n }\n }\n}\n\nimpl fmt::Display for TimerState {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n match self {\n TimerState::Disabled => f.write_str(\"timer is disabled\"),\n TimerState::Inactive => f.write_str(\"timer is inactive\"),\n TimerState::Active { timer } => {\n let deadline = timer.deadline();\n let now = Instant::now();\n\n if deadline < now {\n f.write_str(\"timer is active and has reached deadline\")\n } else {\n write!(\n f,\n \"timer is active and due to expire in {} milliseconds\",\n ((deadline - now).as_secs_f32() * 1000.0)\n )\n }\n }\n }\n }\n}\n" }, { "path": "actix-http/src/h1/upgrade.rs", "content": "use actix_codec::Framed;\nuse actix_service::{Service, ServiceFactory};\nuse futures_core::future::LocalBoxFuture;\n\nuse crate::{h1::Codec, Error, Request};\n\npub struct UpgradeHandler;\n\nimpl ServiceFactory<(Request, Framed)> for UpgradeHandler {\n type Response = ();\n type Error = Error;\n type Config = ();\n type Service = UpgradeHandler;\n type InitError = Error;\n type Future = LocalBoxFuture<'static, Result>;\n\n fn new_service(&self, _: ()) -> Self::Future {\n unimplemented!()\n }\n}\n\nimpl Service<(Request, Framed)> for UpgradeHandler {\n type Response = ();\n type Error = Error;\n type Future = LocalBoxFuture<'static, Result>;\n\n actix_service::always_ready!();\n\n fn call(&self, _: (Request, Framed)) -> Self::Future {\n unimplemented!()\n }\n}\n" }, { "path": "actix-http/src/h1/utils.rs", "content": "use std::{\n future::Future,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse actix_codec::{AsyncRead, AsyncWrite, Framed};\nuse pin_project_lite::pin_project;\n\nuse crate::{\n body::{BodySize, MessageBody},\n h1::{Codec, Message},\n Error, Response,\n};\n\npin_project! {\n /// Send HTTP/1 response\n pub struct SendResponse {\n res: Option, BodySize)>>,\n\n #[pin]\n body: Option,\n\n #[pin]\n framed: Option>,\n }\n}\n\nimpl SendResponse\nwhere\n B: MessageBody,\n B::Error: Into,\n{\n pub fn new(framed: Framed, response: Response) -> Self {\n let (res, body) = response.into_parts();\n\n SendResponse {\n res: Some((res, body.size()).into()),\n body: Some(body),\n framed: Some(framed),\n }\n }\n}\n\nimpl Future for SendResponse\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n B: MessageBody,\n B::Error: Into,\n{\n type Output = Result, Error>;\n\n // TODO: rethink if we need loops in polls\n fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll {\n let mut this = self.as_mut().project();\n\n let mut body_done = this.body.is_none();\n loop {\n let mut body_ready = !body_done;\n\n // send body\n if this.res.is_none() && body_ready {\n while body_ready\n && !body_done\n && !this\n .framed\n .as_ref()\n .as_pin_ref()\n .unwrap()\n .is_write_buf_full()\n {\n let next = match this.body.as_mut().as_pin_mut().unwrap().poll_next(cx) {\n Poll::Ready(Some(Ok(item))) => Poll::Ready(Some(item)),\n Poll::Ready(Some(Err(err))) => return Poll::Ready(Err(err.into())),\n Poll::Ready(None) => Poll::Ready(None),\n Poll::Pending => Poll::Pending,\n };\n\n match next {\n Poll::Ready(item) => {\n // body is done when item is None\n body_done = item.is_none();\n if body_done {\n this.body.set(None);\n }\n let framed = this.framed.as_mut().as_pin_mut().unwrap();\n framed\n .write(Message::Chunk(item))\n .map_err(|err| Error::new_send_response().with_cause(err))?;\n }\n Poll::Pending => body_ready = false,\n }\n }\n }\n\n let framed = this.framed.as_mut().as_pin_mut().unwrap();\n\n // flush write buffer\n if !framed.is_write_buf_empty() {\n match framed\n .flush(cx)\n .map_err(|err| Error::new_send_response().with_cause(err))?\n {\n Poll::Ready(_) => {\n if body_ready {\n continue;\n } else {\n return Poll::Pending;\n }\n }\n Poll::Pending => return Poll::Pending,\n }\n }\n\n // send response\n if let Some(res) = this.res.take() {\n framed\n .write(res)\n .map_err(|err| Error::new_send_response().with_cause(err))?;\n continue;\n }\n\n if !body_done {\n if body_ready {\n continue;\n } else {\n return Poll::Pending;\n }\n } else {\n break;\n }\n }\n\n let framed = this.framed.take().unwrap();\n\n Poll::Ready(Ok(framed))\n }\n}\n" }, { "path": "actix-http/src/h2/dispatcher.rs", "content": "use std::{\n cmp,\n error::Error as StdError,\n future::Future,\n marker::PhantomData,\n net,\n pin::{pin, Pin},\n rc::Rc,\n task::{Context, Poll},\n};\n\nuse actix_codec::{AsyncRead, AsyncWrite};\nuse actix_rt::time::{sleep, Sleep};\nuse actix_service::Service;\nuse actix_utils::future::poll_fn;\nuse bytes::{Bytes, BytesMut};\nuse futures_core::ready;\nuse h2::{\n server::{Connection, SendResponse},\n Ping, PingPong,\n};\nuse pin_project_lite::pin_project;\n\nuse crate::{\n body::{BodySize, BoxBody, MessageBody},\n config::ServiceConfig,\n header::{\n HeaderName, HeaderValue, CONNECTION, CONTENT_LENGTH, DATE, TRANSFER_ENCODING, UPGRADE,\n },\n service::HttpFlow,\n Extensions, Method, OnConnectData, Payload, Request, Response, ResponseHead,\n};\n\nconst CHUNK_SIZE: usize = 16_384;\n\npin_project! {\n /// Dispatcher for HTTP/2 protocol.\n pub struct Dispatcher {\n flow: Rc>,\n connection: Connection,\n conn_data: Option>,\n config: ServiceConfig,\n peer_addr: Option,\n ping_pong: Option,\n _phantom: PhantomData\n }\n}\n\nimpl Dispatcher\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n{\n pub(crate) fn new(\n mut conn: Connection,\n flow: Rc>,\n config: ServiceConfig,\n peer_addr: Option,\n conn_data: OnConnectData,\n timer: Option>>,\n ) -> Self {\n let ping_pong = config.keep_alive().duration().map(|dur| H2PingPong {\n timer: timer\n .map(|mut timer| {\n // reuse timer slot if it was initialized for handshake\n timer.as_mut().reset((config.now() + dur).into());\n timer\n })\n .unwrap_or_else(|| Box::pin(sleep(dur))),\n in_flight: false,\n ping_pong: conn.ping_pong().unwrap(),\n });\n\n Self {\n flow,\n config,\n peer_addr,\n connection: conn,\n conn_data: conn_data.0.map(Rc::new),\n ping_pong,\n _phantom: PhantomData,\n }\n }\n}\n\nstruct H2PingPong {\n /// Handle to send ping frames from the peer.\n ping_pong: PingPong,\n\n /// True when a ping has been sent and is waiting for a reply.\n in_flight: bool,\n\n /// Timeout for pong response.\n timer: Pin>,\n}\n\nimpl Future for Dispatcher\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n\n S: Service,\n S::Error: Into>,\n S::Future: 'static,\n S::Response: Into>,\n\n B: MessageBody,\n{\n type Output = Result<(), crate::error::DispatchError>;\n\n #[inline]\n fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll {\n let this = self.get_mut();\n\n loop {\n match Pin::new(&mut this.connection).poll_accept(cx)? {\n Poll::Ready(Some((req, tx))) => {\n let (parts, body) = req.into_parts();\n let payload = crate::h2::Payload::new(body);\n let pl = Payload::H2 { payload };\n let mut req = Request::with_payload(pl);\n let head_req = parts.method == Method::HEAD;\n\n let head = req.head_mut();\n head.uri = parts.uri;\n head.method = parts.method;\n head.version = parts.version;\n head.headers = parts.headers.into();\n head.peer_addr = this.peer_addr;\n\n req.conn_data.clone_from(&this.conn_data);\n\n let fut = this.flow.service.call(req);\n let config = this.config.clone();\n\n // multiplex request handling with spawn task\n actix_rt::spawn(async move {\n // resolve service call and send response.\n let res = match fut.await {\n Ok(res) => handle_response(res.into(), tx, config, head_req).await,\n Err(err) => {\n let res: Response = err.into();\n handle_response(res, tx, config, head_req).await\n }\n };\n\n // log error.\n if let Err(err) = res {\n match err {\n DispatchError::SendResponse(err) => {\n tracing::trace!(\"Error sending response: {err:?}\");\n }\n DispatchError::SendData(err) => {\n tracing::warn!(\"Send data error: {err:?}\");\n }\n DispatchError::ResponseBody(err) => {\n tracing::error!(\"Response payload stream error: {err:?}\");\n }\n }\n }\n });\n }\n Poll::Ready(None) => return Poll::Ready(Ok(())),\n\n Poll::Pending => match this.ping_pong.as_mut() {\n Some(ping_pong) => loop {\n if ping_pong.in_flight {\n // When there is an in-flight ping-pong, poll pong and and keep-alive\n // timer. On successful pong received, update keep-alive timer to\n // determine the next timing of ping pong.\n match ping_pong.ping_pong.poll_pong(cx)? {\n Poll::Ready(_) => {\n ping_pong.in_flight = false;\n\n let dead_line = this.config.keep_alive_deadline().unwrap();\n ping_pong.timer.as_mut().reset(dead_line.into());\n }\n Poll::Pending => {\n return ping_pong.timer.as_mut().poll(cx).map(|_| Ok(()));\n }\n }\n } else {\n // When there is no in-flight ping-pong, keep-alive timer is used to\n // wait for next timing of ping-pong. Therefore, at this point it serves\n // as an interval instead.\n ready!(ping_pong.timer.as_mut().poll(cx));\n\n ping_pong.ping_pong.send_ping(Ping::opaque())?;\n\n let dead_line = this.config.keep_alive_deadline().unwrap();\n ping_pong.timer.as_mut().reset(dead_line.into());\n\n ping_pong.in_flight = true;\n }\n },\n None => return Poll::Pending,\n },\n }\n }\n }\n}\n\nenum DispatchError {\n SendResponse(h2::Error),\n SendData(h2::Error),\n ResponseBody(Box),\n}\n\nasync fn handle_response(\n res: Response,\n mut tx: SendResponse,\n config: ServiceConfig,\n head_req: bool,\n) -> Result<(), DispatchError>\nwhere\n B: MessageBody,\n{\n let (res, body) = res.replace_body(());\n\n // prepare response.\n let mut size = body.size();\n let res = prepare_response(config, res.head(), &mut size);\n let eof_or_head = size.is_eof() || head_req;\n\n // send response head and return on eof.\n let mut stream = tx\n .send_response(res, eof_or_head)\n .map_err(DispatchError::SendResponse)?;\n\n if eof_or_head {\n return Ok(());\n }\n\n let mut body = pin!(body);\n\n // poll response body and send chunks to client\n while let Some(res) = poll_fn(|cx| body.as_mut().poll_next(cx)).await {\n let mut chunk = res.map_err(|err| DispatchError::ResponseBody(err.into()))?;\n\n 'send: loop {\n let chunk_size = cmp::min(chunk.len(), CHUNK_SIZE);\n\n // reserve enough space and wait for stream ready.\n stream.reserve_capacity(chunk_size);\n\n match poll_fn(|cx| stream.poll_capacity(cx)).await {\n // No capacity left. drop body and return.\n None => return Ok(()),\n\n Some(Err(err)) => return Err(DispatchError::SendData(err)),\n\n Some(Ok(cap)) => {\n // split chunk to writeable size and send to client\n let len = chunk.len();\n let bytes = chunk.split_to(cmp::min(len, cap));\n\n stream\n .send_data(bytes, false)\n .map_err(DispatchError::SendData)?;\n\n // Current chuck completely sent. break send loop and poll next one.\n if chunk.is_empty() {\n break 'send;\n }\n }\n }\n }\n }\n\n // response body streaming finished. send end of stream and return.\n stream\n .send_data(Bytes::new(), true)\n .map_err(DispatchError::SendData)?;\n\n Ok(())\n}\n\nfn prepare_response(\n config: ServiceConfig,\n head: &ResponseHead,\n size: &mut BodySize,\n) -> http::Response<()> {\n let mut has_date = false;\n let mut skip_len = size != &BodySize::Stream;\n\n let mut res = http::Response::new(());\n *res.status_mut() = head.status;\n *res.version_mut() = http::Version::HTTP_2;\n\n // Content length\n match head.status {\n http::StatusCode::NO_CONTENT\n | http::StatusCode::CONTINUE\n | http::StatusCode::PROCESSING => *size = BodySize::None,\n http::StatusCode::SWITCHING_PROTOCOLS => {\n skip_len = true;\n *size = BodySize::Stream;\n }\n _ => {}\n }\n\n match size {\n BodySize::None | BodySize::Stream => {}\n\n BodySize::Sized(0) => {\n #[allow(clippy::declare_interior_mutable_const)]\n const HV_ZERO: HeaderValue = HeaderValue::from_static(\"0\");\n res.headers_mut().insert(CONTENT_LENGTH, HV_ZERO);\n }\n\n BodySize::Sized(len) => {\n let mut buf = itoa::Buffer::new();\n\n res.headers_mut().insert(\n CONTENT_LENGTH,\n HeaderValue::from_str(buf.format(*len)).unwrap(),\n );\n }\n };\n\n // copy headers\n for (key, value) in head.headers.iter() {\n match key {\n // omit HTTP/1.x only headers according to:\n // https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.2\n &CONNECTION | &TRANSFER_ENCODING | &UPGRADE => continue,\n\n &CONTENT_LENGTH if skip_len => continue,\n &DATE => has_date = true,\n\n // omit HTTP/1.x only headers according to:\n // https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.2\n hdr if hdr == HeaderName::from_static(\"keep-alive\")\n || hdr == HeaderName::from_static(\"proxy-connection\") =>\n {\n continue\n }\n\n _ => {}\n }\n\n res.headers_mut().append(key, value.clone());\n }\n\n // set date header\n if !has_date {\n let mut bytes = BytesMut::with_capacity(29);\n config.write_date_header_value(&mut bytes);\n res.headers_mut().insert(\n DATE,\n // SAFETY: serialized date-times are known ASCII strings\n unsafe { HeaderValue::from_maybe_shared_unchecked(bytes.freeze()) },\n );\n }\n\n res\n}\n" }, { "path": "actix-http/src/h2/mod.rs", "content": "//! HTTP/2 protocol.\n\nuse std::{\n future::Future,\n pin::Pin,\n task::{Context, Poll},\n};\n\nuse actix_codec::{AsyncRead, AsyncWrite};\nuse actix_rt::time::{sleep_until, Sleep};\nuse bytes::Bytes;\nuse futures_core::{ready, Stream};\nuse h2::{\n server::{Builder, Connection, Handshake},\n RecvStream,\n};\n\nuse crate::{\n config::ServiceConfig,\n error::{DispatchError, PayloadError},\n};\n\nmod dispatcher;\nmod service;\n\npub use self::{dispatcher::Dispatcher, service::H2Service};\n\n/// HTTP/2 peer stream.\npub struct Payload {\n stream: RecvStream,\n}\n\nimpl Payload {\n pub(crate) fn new(stream: RecvStream) -> Self {\n Self { stream }\n }\n}\n\nimpl Stream for Payload {\n type Item = Result;\n\n fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n let this = self.get_mut();\n\n match ready!(Pin::new(&mut this.stream).poll_data(cx)) {\n Some(Ok(chunk)) => {\n let len = chunk.len();\n\n match this.stream.flow_control().release_capacity(len) {\n Ok(()) => Poll::Ready(Some(Ok(chunk))),\n Err(err) => Poll::Ready(Some(Err(err.into()))),\n }\n }\n Some(Err(err)) => Poll::Ready(Some(Err(err.into()))),\n None => Poll::Ready(None),\n }\n }\n}\n\npub(crate) fn handshake_with_timeout(io: T, config: &ServiceConfig) -> HandshakeWithTimeout\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n{\n let mut builder = Builder::new();\n builder\n .initial_window_size(config.h2_initial_window_size())\n .initial_connection_window_size(config.h2_initial_connection_window_size());\n\n HandshakeWithTimeout {\n handshake: builder.handshake(io),\n timer: config\n .client_request_deadline()\n .map(|deadline| Box::pin(sleep_until(deadline.into()))),\n }\n}\n\npub(crate) struct HandshakeWithTimeout {\n handshake: Handshake,\n timer: Option>>,\n}\n\nimpl Future for HandshakeWithTimeout\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n{\n type Output = Result<(Connection, Option>>), DispatchError>;\n\n fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll {\n let this = self.get_mut();\n\n match Pin::new(&mut this.handshake).poll(cx)? {\n // return the timer on success handshake; its slot can be re-used for h2 ping-pong\n Poll::Ready(conn) => Poll::Ready(Ok((conn, this.timer.take()))),\n Poll::Pending => match this.timer.as_mut() {\n Some(timer) => {\n ready!(timer.as_mut().poll(cx));\n Poll::Ready(Err(DispatchError::SlowRequestTimeout))\n }\n None => Poll::Pending,\n },\n }\n }\n}\n\n#[cfg(test)]\nmod tests {\n use static_assertions::assert_impl_all;\n\n use super::*;\n\n assert_impl_all!(Payload: Unpin, Send, Sync);\n}\n" }, { "path": "actix-http/src/h2/service.rs", "content": "use std::{\n future::Future,\n marker::PhantomData,\n mem, net,\n pin::Pin,\n rc::Rc,\n task::{Context, Poll},\n};\n\nuse actix_codec::{AsyncRead, AsyncWrite};\nuse actix_rt::net::TcpStream;\nuse actix_service::{\n fn_factory, fn_service, IntoServiceFactory, Service, ServiceFactory, ServiceFactoryExt as _,\n};\nuse actix_utils::future::ready;\nuse futures_core::{future::LocalBoxFuture, ready};\nuse tracing::{error, trace};\n\nuse super::{dispatcher::Dispatcher, handshake_with_timeout, HandshakeWithTimeout};\nuse crate::{\n body::{BoxBody, MessageBody},\n config::ServiceConfig,\n error::DispatchError,\n service::HttpFlow,\n ConnectCallback, OnConnectData, Request, Response,\n};\n\n#[inline]\nfn desired_nodelay(tcp_nodelay: Option) -> Option {\n tcp_nodelay\n}\n\n#[inline]\nfn set_nodelay(stream: &TcpStream, nodelay: bool) {\n let _ = stream.set_nodelay(nodelay);\n}\n\n/// `ServiceFactory` implementation for HTTP/2 transport\npub struct H2Service {\n srv: S,\n cfg: ServiceConfig,\n on_connect_ext: Option>>,\n _phantom: PhantomData<(T, B)>,\n}\n\nimpl H2Service\nwhere\n S: ServiceFactory,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n{\n /// Create new `H2Service` instance with config.\n pub(crate) fn with_config>(\n cfg: ServiceConfig,\n service: F,\n ) -> Self {\n H2Service {\n cfg,\n on_connect_ext: None,\n srv: service.into_factory(),\n _phantom: PhantomData,\n }\n }\n\n /// Set on connect callback.\n pub(crate) fn on_connect_ext(mut self, f: Option>>) -> Self {\n self.on_connect_ext = f;\n self\n }\n}\n\nimpl H2Service\nwhere\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n{\n /// Create plain TCP based service\n pub fn tcp(\n self,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = DispatchError,\n InitError = S::InitError,\n > {\n let tcp_nodelay = desired_nodelay(self.cfg.tcp_nodelay());\n\n fn_factory(move || {\n ready(Ok::<_, S::InitError>(fn_service(move |io: TcpStream| {\n if let Some(nodelay) = tcp_nodelay {\n set_nodelay(&io, nodelay);\n }\n let peer_addr = io.peer_addr().ok();\n ready(Ok::<_, DispatchError>((io, peer_addr)))\n })))\n })\n .and_then(self)\n }\n}\n\n#[cfg(feature = \"openssl\")]\nmod openssl {\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n openssl::{\n reexports::{Error as SslError, SslAcceptor},\n Acceptor, TlsStream,\n },\n TlsError,\n };\n\n use super::*;\n\n impl H2Service, S, B>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n {\n /// Create OpenSSL based service.\n pub fn openssl(\n self,\n acceptor: SslAcceptor,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = S::InitError,\n > {\n let tcp_nodelay = desired_nodelay(self.cfg.tcp_nodelay());\n\n Acceptor::new(acceptor)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(move |io: TlsStream| {\n if let Some(nodelay) = tcp_nodelay {\n set_nodelay(io.get_ref(), nodelay);\n }\n let peer_addr = io.get_ref().peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_20\")]\nmod rustls_0_20 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H2Service, S, B>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n {\n /// Create Rustls v0.20 based service.\n pub fn rustls(\n self,\n mut config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = S::InitError,\n > {\n let tcp_nodelay = desired_nodelay(self.cfg.tcp_nodelay());\n let mut protos = vec![b\"h2\".to_vec()];\n protos.extend_from_slice(&config.alpn_protocols);\n config.alpn_protocols = protos;\n\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(move |io: TlsStream| {\n if let Some(nodelay) = tcp_nodelay {\n set_nodelay(io.get_ref().0, nodelay);\n }\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_21\")]\nmod rustls_0_21 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_21::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H2Service, S, B>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n {\n /// Create Rustls v0.21 based service.\n pub fn rustls_021(\n self,\n mut config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = S::InitError,\n > {\n let tcp_nodelay = desired_nodelay(self.cfg.tcp_nodelay());\n let mut protos = vec![b\"h2\".to_vec()];\n protos.extend_from_slice(&config.alpn_protocols);\n config.alpn_protocols = protos;\n\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(move |io: TlsStream| {\n if let Some(nodelay) = tcp_nodelay {\n set_nodelay(io.get_ref().0, nodelay);\n }\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_22\")]\nmod rustls_0_22 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_22::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H2Service, S, B>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n {\n /// Create Rustls v0.22 based service.\n pub fn rustls_0_22(\n self,\n mut config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = S::InitError,\n > {\n let tcp_nodelay = desired_nodelay(self.cfg.tcp_nodelay());\n let mut protos = vec![b\"h2\".to_vec()];\n protos.extend_from_slice(&config.alpn_protocols);\n config.alpn_protocols = protos;\n\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(move |io: TlsStream| {\n if let Some(nodelay) = tcp_nodelay {\n set_nodelay(io.get_ref().0, nodelay);\n }\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\n#[cfg(feature = \"rustls-0_23\")]\nmod rustls_0_23 {\n use std::io;\n\n use actix_service::ServiceFactoryExt as _;\n use actix_tls::accept::{\n rustls_0_23::{reexports::ServerConfig, Acceptor, TlsStream},\n TlsError,\n };\n\n use super::*;\n\n impl H2Service, S, B>\n where\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n {\n /// Create Rustls v0.23 based service.\n pub fn rustls_0_23(\n self,\n mut config: ServerConfig,\n ) -> impl ServiceFactory<\n TcpStream,\n Config = (),\n Response = (),\n Error = TlsError,\n InitError = S::InitError,\n > {\n let tcp_nodelay = desired_nodelay(self.cfg.tcp_nodelay());\n let mut protos = vec![b\"h2\".to_vec()];\n protos.extend_from_slice(&config.alpn_protocols);\n config.alpn_protocols = protos;\n\n Acceptor::new(config)\n .map_init_err(|_| {\n unreachable!(\"TLS acceptor service factory does not error on init\")\n })\n .map_err(TlsError::into_service_error)\n .map(move |io: TlsStream| {\n if let Some(nodelay) = tcp_nodelay {\n set_nodelay(io.get_ref().0, nodelay);\n }\n let peer_addr = io.get_ref().0.peer_addr().ok();\n (io, peer_addr)\n })\n .and_then(self.map_err(TlsError::Service))\n }\n }\n}\n\nimpl ServiceFactory<(T, Option)> for H2Service\nwhere\n T: AsyncRead + AsyncWrite + Unpin + 'static,\n\n S: ServiceFactory,\n S::Future: 'static,\n S::Error: Into> + 'static,\n S::Response: Into> + 'static,\n >::Future: 'static,\n\n B: MessageBody + 'static,\n{\n type Response = ();\n type Error = DispatchError;\n type Config = ();\n type Service = H2ServiceHandler;\n type InitError = S::InitError;\n type Future = LocalBoxFuture<'static, Result>;\n\n fn new_service(&self, _: ()) -> Self::Future {\n let service = self.srv.new_service(());\n let cfg = self.cfg.clone();\n let on_connect_ext = self.on_connect_ext.clone();\n\n Box::pin(async move {\n let service = service.await?;\n Ok(H2ServiceHandler::new(cfg, on_connect_ext, service))\n })\n }\n}\n\n/// `Service` implementation for HTTP/2 transport\npub struct H2ServiceHandler\nwhere\n S: Service,\n{\n flow: Rc>,\n cfg: ServiceConfig,\n on_connect_ext: Option>>,\n _phantom: PhantomData,\n}\n\nimpl H2ServiceHandler\nwhere\n S: Service,\n S::Error: Into> + 'static,\n S::Future: 'static,\n S::Response: Into> + 'static,\n B: MessageBody + 'static,\n{\n fn new(\n cfg: ServiceConfig,\n on_connect_ext: Option>>,\n service: S,\n ) -> H2ServiceHandler {\n H2ServiceHandler {\n flow: HttpFlow::new(service, (), None),\n cfg,\n on_connect_ext,\n _phantom: PhantomData,\n }\n }\n}\n\nimpl Service<(T, Option)> for H2ServiceHandler\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n S: Service,\n S::Error: Into> + 'static,\n S::Future: 'static,\n S::Response: Into> + 'static,\n B: MessageBody + 'static,\n{\n type Response = ();\n type Error = DispatchError;\n type Future = H2ServiceHandlerResponse;\n\n fn poll_ready(&self, cx: &mut Context<'_>) -> Poll> {\n self.flow.service.poll_ready(cx).map_err(|err| {\n let err = err.into();\n error!(\"Service readiness error: {:?}\", err);\n DispatchError::Service(err)\n })\n }\n\n fn call(&self, (io, addr): (T, Option)) -> Self::Future {\n let on_connect_data = OnConnectData::from_io(&io, self.on_connect_ext.as_deref());\n\n H2ServiceHandlerResponse {\n state: State::Handshake(\n Some(Rc::clone(&self.flow)),\n Some(self.cfg.clone()),\n addr,\n on_connect_data,\n handshake_with_timeout(io, &self.cfg),\n ),\n }\n }\n}\n\nenum State, B: MessageBody>\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n S::Future: 'static,\n{\n Handshake(\n Option>>,\n Option,\n Option,\n OnConnectData,\n HandshakeWithTimeout,\n ),\n Established(Dispatcher),\n}\n\npub struct H2ServiceHandlerResponse\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n S: Service,\n S::Error: Into> + 'static,\n S::Future: 'static,\n S::Response: Into> + 'static,\n B: MessageBody + 'static,\n{\n state: State,\n}\n\nimpl Future for H2ServiceHandlerResponse\nwhere\n T: AsyncRead + AsyncWrite + Unpin,\n S: Service,\n S::Error: Into> + 'static,\n S::Future: 'static,\n S::Response: Into> + 'static,\n B: MessageBody,\n{\n type Output = Result<(), DispatchError>;\n\n fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll {\n match self.state {\n State::Handshake(\n ref mut srv,\n ref mut config,\n ref peer_addr,\n ref mut conn_data,\n ref mut handshake,\n ) => match ready!(Pin::new(handshake).poll(cx)) {\n Ok((conn, timer)) => {\n let on_connect_data = mem::take(conn_data);\n\n self.state = State::Established(Dispatcher::new(\n conn,\n srv.take().unwrap(),\n config.take().unwrap(),\n *peer_addr,\n on_connect_data,\n timer,\n ));\n\n self.poll(cx)\n }\n\n Err(err) => {\n trace!(\"H2 handshake error: {}\", err);\n Poll::Ready(Err(err))\n }\n },\n\n State::Established(ref mut disp) => Pin::new(disp).poll(cx),\n }\n }\n}\n" }, { "path": "actix-http/src/header/as_name.rs", "content": "//! Sealed [`AsHeaderName`] trait and implementations.\n\nuse std::{borrow::Cow, str::FromStr as _};\n\nuse http::header::{HeaderName, InvalidHeaderName};\n\n/// Sealed trait implemented for types that can be effectively borrowed as a [`HeaderValue`].\n///\n/// [`HeaderValue`]: super::HeaderValue\npub trait AsHeaderName: Sealed {}\n\npub struct Seal;\n\npub trait Sealed {\n fn try_as_name(&self, seal: Seal) -> Result, InvalidHeaderName>;\n}\n\nimpl Sealed for HeaderName {\n #[inline]\n fn try_as_name(&self, _: Seal) -> Result, InvalidHeaderName> {\n Ok(Cow::Borrowed(self))\n }\n}\nimpl AsHeaderName for HeaderName {}\n\nimpl Sealed for &HeaderName {\n #[inline]\n fn try_as_name(&self, _: Seal) -> Result, InvalidHeaderName> {\n Ok(Cow::Borrowed(*self))\n }\n}\nimpl AsHeaderName for &HeaderName {}\n\nimpl Sealed for &str {\n #[inline]\n fn try_as_name(&self, _: Seal) -> Result, InvalidHeaderName> {\n HeaderName::from_str(self).map(Cow::Owned)\n }\n}\nimpl AsHeaderName for &str {}\n\nimpl Sealed for String {\n #[inline]\n fn try_as_name(&self, _: Seal) -> Result, InvalidHeaderName> {\n HeaderName::from_str(self).map(Cow::Owned)\n }\n}\nimpl AsHeaderName for String {}\n\nimpl Sealed for &String {\n #[inline]\n fn try_as_name(&self, _: Seal) -> Result, InvalidHeaderName> {\n HeaderName::from_str(self).map(Cow::Owned)\n }\n}\nimpl AsHeaderName for &String {}\n" }, { "path": "actix-http/src/header/common.rs", "content": "//! Common header names not defined in [`http`].\n//!\n//! Any headers added to this file will need to be re-exported from the list at `crate::headers`.\n\nuse http::header::HeaderName;\n\n/// Response header field that indicates how caches have handled that response and its corresponding\n/// request.\n///\n/// See [RFC 9211](https://www.rfc-editor.org/rfc/rfc9211) for full semantics.\n// TODO(breaking): replace with http's version\npub const CACHE_STATUS: HeaderName = HeaderName::from_static(\"cache-status\");\n\n/// Response header field that allows origin servers to control the behavior of CDN caches\n/// interposed between them and clients separately from other caches that might handle the response.\n///\n/// See [RFC 9213](https://www.rfc-editor.org/rfc/rfc9213) for full semantics.\n// TODO(breaking): replace with http's version\npub const CDN_CACHE_CONTROL: HeaderName = HeaderName::from_static(\"cdn-cache-control\");\n\n/// Response header field that sends a signal to the user agent that it ought to remove all data of\n/// a certain set of types.\n///\n/// See the [W3C Clear-Site-Data spec] for full semantics.\n///\n/// [W3C Clear-Site-Data spec]: https://www.w3.org/TR/clear-site-data/#header\npub const CLEAR_SITE_DATA: HeaderName = HeaderName::from_static(\"clear-site-data\");\n\n/// Response header that prevents a document from loading any cross-origin resources that don't\n/// explicitly grant the document permission (using [CORP] or [CORS]).\n///\n/// [CORP]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cross-Origin_Resource_Policy_(CORP)\n/// [CORS]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\npub const CROSS_ORIGIN_EMBEDDER_POLICY: HeaderName =\n HeaderName::from_static(\"cross-origin-embedder-policy\");\n\n/// Response header that allows you to ensure a top-level document does not share a browsing context\n/// group with cross-origin documents.\npub const CROSS_ORIGIN_OPENER_POLICY: HeaderName =\n HeaderName::from_static(\"cross-origin-opener-policy\");\n\n/// Response header that conveys a desire that the browser blocks no-cors cross-origin/cross-site\n/// requests to the given resource.\npub const CROSS_ORIGIN_RESOURCE_POLICY: HeaderName =\n HeaderName::from_static(\"cross-origin-resource-policy\");\n\n/// Response header that provides a mechanism to allow and deny the use of browser features in a\n/// document or within any `