Skip to content

Commit 6b55ffe

Browse files
authored
Merge pull request #142 from vladdoster/main
docs: fix spelling
2 parents f40fa6a + 27f8d29 commit 6b55ffe

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

ARCHITECTURE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ two services that implement the three APIs defined by the specification:
1313
These two services communicate with each other over D-Bus IPC.
1414

1515
The **Gateway** is the entrypoint for clients to interact with. The Flow
16-
Controler and UI Controller work together to guide the user through the
16+
Controller and UI Controller work together to guide the user through the
1717
process of selecting an appropriate credential based on the request received by
1818
the Gateway.
1919

@@ -140,7 +140,7 @@ few tests there; this should be expanded in the future.
140140

141141
Rust types shared between `credentialsd` and `credentials-ui`.
142142

143-
Most of the types live in `src/model.rs`, and some are duplciated in
143+
Most of the types live in `src/model.rs`, and some are duplicated in
144144
`src/server.rs`. The duplicates in the `server` module have tweaks that make it
145145
easier to serialize over D-Bus, but more difficult to work with in Rust. So
146146
conversion methods are provided between the two modules.
@@ -163,7 +163,7 @@ the fact that it uses async-std, and some frameworks may prefer Tokio or another
163163
async runtime.) This is intended to aid other GUI developers using other
164164
frameworks to set up their projects. For a given framework, it may be more
165165
intuitive not to have this separation or to structure the code differently, but
166-
the separation fo concerns here makes it clear what the developer needs to do.
166+
the separation of concerns here makes it clear what the developer needs to do.
167167

168168
### `credentialsd-ui/src/view_model/gtk/`
169169

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ use super::MyType;
149149

150150
### Commit Messages
151151

152-
The commit message should start with the _area_ that is affected by the change, which is usually the name of the folder withouth the `credentialsd-` prefix. The exception is `credentialsd/` itself, which should use `daemon`.
152+
The commit message should start with the _area_ that is affected by the change, which is usually the name of the folder without the `credentialsd-` prefix. The exception is `credentialsd/` itself, which should use `daemon`.
153153

154154
Write commit messages using the imperative mood, as if completing the sentence:
155155
"If applied, this commit will \_\_\_." For example, use "Fix some bug" instead

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ of this scope, we still want to know about it! We would still like to discuss
4646
the issue privately, but we may decide to address it beyond the response
4747
time described above.
4848

49-
## Definitons
49+
## Definitions
5050

5151
- _privileged client_: A client that is allowed to make requests for credentials
5252
for any origin.

doc/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There are three main API defined by this specification:
77
- [UI Control API](#ui-control-api)
88

99
The **Gateway** is the entrypoint for clients to interact with. The Flow
10-
Controler and UI Controller work together to guide the user through the
10+
Controller and UI Controller work together to guide the user through the
1111
process of selecting an appropriate credential based on the request received by
1212
the Gateway.
1313

@@ -70,7 +70,7 @@ sequenceDiagram
7070
- _credential_: a value that identifies a user to a relying party
7171
- _gateway_: entrypoint for clients
7272
- _privileged_ client: a client that is trusted to set any origin for its requests
73-
- _relying party_: an entity wishing to auhtenticate a user
73+
- _relying party_: an entity wishing to authenticate a user
7474
- _unprivileged client_: a client that is constrained to use a predetermined set of origin(s)
7575

7676
# General Notes
@@ -812,7 +812,7 @@ A method to send a client PIN to an authenticator in response to a `UsbState::NE
812812

813813
### Request
814814

815-
`pin`: Client PIN for the authenticaor.
815+
`pin`: Client PIN for the authenticator.
816816

817817
This should be sent in response to a `UsbState::NEEDS_PIN` event. If this
818818
method is sent when the authenticator is not in a state to receive a client

doc/historical/scenarios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ sequenceDiagram
5959
1. user is shown a list of credentials, filtered by assertion options and ordered by most relevant based on the origin provided
6060
- invalid passkeys should not be shown? (because they won't work at all, and for phishing protection), but irrelevant passwords can be shown
6161
- This may cause issues for some origins if they're not registered properly.
62-
- Technically, it's the responsibilty of the RP to validate the origin. If the origin is wrong, that's part of the authenticator data, and the RP can reject it. So even if a third-party phisher initiated the assertion from another site, the attacker couldn't use the credentials, because the RP wouldn't recognize the origin. So it might be OK to allow other passkeys to sign the assertion.
62+
- Technically, it's the responsibility of the RP to validate the origin. If the origin is wrong, that's part of the authenticator data, and the RP can reject it. So even if a third-party phisher initiated the assertion from another site, the attacker couldn't use the credentials, because the RP wouldn't recognize the origin. So it might be OK to allow other passkeys to sign the assertion.
6363
1. user scrolls and selects the relevant credential
6464
1. backend sends ID back to frontend, which pulls the corresponding credential and sends back to client
6565
1. browser receives credentials,

0 commit comments

Comments
 (0)