Skip to content

Updating links now that Rocket 0.5 is released #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updating links now that Rocket 0.5 is released #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A slightly more maintained version of [rocket_csrf](https://github.com/kotovalex

## Usage

Attach [fairing](https://rocket.rs/v0.5-rc/guide/fairings/#fairings) to the Rocket instance:
Attach [fairing](https://rocket.rs/v0.5/guide/fairings/#fairings) to the Rocket instance:

```rust
#![feature(decl_macro)]
Expand All @@ -25,7 +25,7 @@ fn rocket() -> _ {
}
```

You also can configure [fairing](https://rocket.rs/v0.5-rc/guide/fairings/#fairings):
You also can configure [fairing](https://rocket.rs/v0.5/guide/fairings/#fairings):

```rust
#[launch]
Expand All @@ -45,7 +45,7 @@ fn rocket() -> _ {
}
```

Add [guard](https://rocket.rs/v0.5-rc/guide/requests/#request-guards) to any request where you want to have access to session's CSRF token (e.g. to include it in forms) or verify it (e.g. to validate form):
Add [guard](https://rocket.rs/v0.5/guide/requests/#request-guards) to any request where you want to have access to session's CSRF token (e.g. to include it in forms) or verify it (e.g. to validate form):

```rust
use rocket::form::Form;
Expand All @@ -64,7 +64,7 @@ fn create(csrf_token: CsrfToken, form: Form<Comment>) -> Redirect {
}
```

Get CSRF token from [guard](https://rocket.rs/v0.5-rc/guide/requests/#request-guards) to use it in [templates](https://rocket.rs/v0.5-rc/guide/responses/#templates):
Get CSRF token from [guard](https://rocket.rs/v0.5/guide/requests/#request-guards) to use it in [templates](https://rocket.rs/guide/v0.5/responses/#templates):

```rust
#[get("/comments/new")]
Expand All @@ -75,7 +75,7 @@ fn new(csrf_token: CsrfToken) -> Template {
}
```

Add CSRF token to your HTML forms in [templates](https://rocket.rs/v0.5-rc/guide/responses/#templates):
Add CSRF token to your HTML forms in [templates](https://rocket.rs/guide/v0.5/responses/#templates):

```html
<form method="post" action="/comments">
Expand All @@ -88,7 +88,7 @@ Add CSRF token to your HTML forms in [templates](https://rocket.rs/v0.5-rc/guide
</form>
```

Add attribute `authenticity_token` to your [forms](https://rocket.rs/v0.5-rc/guide/requests/#forms):
Add attribute `authenticity_token` to your [forms](https://rocket.rs/v0.5/guide/requests/#forms):

```rust
#[derive(FromForm)]
Expand All @@ -98,7 +98,7 @@ struct Comment {
}
```

Validate [forms](https://rocket.rs/v0.5-rc/guide/requests/#forms) to have valid authenticity token:
Validate [forms](https://rocket.rs/v0.5/guide/requests/#forms) to have valid authenticity token:

```rust
#[post("/comments", data = "<form>")]
Expand All @@ -118,7 +118,7 @@ See the complete code in [minimal example](examples/minimal).
- [X] Add fairing to verify all requests as an option.
- [X] Verify `X-CSRF-Token` header.
- [X] Set cookie to expire with session.
- [ ] Add [data guard](https://api.rocket.rs/v0.5-rc/rocket/data/trait.FromData.html) to verify forms with a guard.
- [ ] Add [data guard](https://api.rocket.rs/v0.5/rocket/data/trait.FromData.html) to verify forms with a guard.
- [ ] Add helpers to render form field.
- [ ] Add helpers to add HTML meta tags for Ajax with `X-CSRF-Token` header (WIP).
- [ ] Use authenticity token encryption from [Ruby on Rails](https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_controller/metal/request_forgery_protection.rb).
Expand Down