Skip to content

Commit bd8883a

Browse files
authored
Updated master branch references to main (#256)
* Updated master branch references to main. * Update LICENSE.txt for branch name change
1 parent d7d64a8 commit bd8883a

File tree

21 files changed

+106
-108
lines changed

21 files changed

+106
-108
lines changed

LICENSE.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Source code in this repository is covered by one of two licenses: (i) the GNU Ge
22
(GPL) v3.0 (ii) the Creative Commons BY-NC-ND v4.0. Creative Commons licensed documents are found in
33
the docs directory. Other files are GPL licensed.
44

5-
GPL v3.0: https://github.com/bitwarden/contributing-docs/blob/master/LICENSE_GPL.txt
5+
GPL v3.0: https://github.com/bitwarden/contributing-docs/blob/main/LICENSE_GPL.txt
66

7-
CC BY-NC-ND v4.0: https://github.com/bitwarden/contributing-docs/blob/master/LICENSE_CC.txt
7+
CC BY-NC-ND v4.0: https://github.com/bitwarden/contributing-docs/blob/main/LICENSE_CC.txt
88

99
No grant of any rights in the trademarks, service marks, or logos of Bitwarden is made (except as
1010
may be necessary to comply with the notice requirements as applicable), and use of any Bitwarden
1111
trademarks must comply with Bitwarden Trademark Guidelines
12-
<https://github.com/bitwarden/server/blob/master/TRADEMARK_GUIDELINES.md>.
12+
<https://github.com/bitwarden/server/blob/main/TRADEMARK_GUIDELINES.md>.

docs/architecture/adr/0019-adopt-web-push.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ be considered while migrating compatible clients to the new provider to provide
120120
potentially-sensitive payload contents.
121121

122122
[signalr]: https://dotnet.microsoft.com/en-us/apps/aspnet/signalr
123-
[notifications]: https://github.com/bitwarden/server/tree/master/src/Notifications
123+
[notifications]: https://github.com/bitwarden/server/tree/main/src/Notifications
124124
[podlife]: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/
125125
[mv3]: https://developer.chrome.com/docs/extensions/mv3/intro/
126126
[hubspricing]: https://azure.microsoft.com/en-us/pricing/details/notification-hubs/

docs/architecture/deep-dives/authentication/index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ factors, but the most important is the login strategy.
1717
## Client requests a token
1818

1919
For each of these strategies, the client forms a
20-
[`TokenRequest`](https://github.com/bitwarden/clients/blob/master/libs/common/src/auth/models/request/identity-token/token.request.ts)
20+
[`TokenRequest`](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/models/request/identity-token/token.request.ts)
2121
though one of its subclasses:
2222

23-
- [`PasswordTokenRequest`](https://github.com/bitwarden/clients/blob/master/libs/common/src/auth/models/request/identity-token/password-token.request.ts) -
23+
- [`PasswordTokenRequest`](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/models/request/identity-token/password-token.request.ts) -
2424
used by Password and Passwordless Login Strategy
25-
- [`UserApiTokenRequest`](https://github.com/bitwarden/clients/blob/master/libs/common/src/auth/models/request/identity-token/user-api-token.request.ts) -
25+
- [`UserApiTokenRequest`](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/models/request/identity-token/user-api-token.request.ts) -
2626
used by API Login Strategy
27-
- [`SSOTokenRequest`](https://github.com/bitwarden/clients/blob/master/libs/common/src/auth/models/request/identity-token/user-api-token.request.ts) -
27+
- [`SSOTokenRequest`](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/models/request/identity-token/user-api-token.request.ts) -
2828
used by SSO Login Strategy
2929

3030
Each of these requests overrides the `toIdentityToken()` method, which is responsible for
@@ -39,8 +39,8 @@ strategies.
3939
<!-- prettier-ignore -->
4040
| Property | Purpose |
4141
| --- | --- |
42-
| `deviceType` | The [`DeviceType`](https://github.com/bitwarden/clients/blob/master/libs/common/src/enums/device-type.enum.ts) for the requesting device. |
43-
| `deviceName` | The string representation of the [`DeviceType`](https://github.com/bitwarden/clients/blob/master/libs/common/src/enums/device-type.enum.ts) for the requesting device. |
42+
| `deviceType` | The [`DeviceType`](https://github.com/bitwarden/clients/blob/main/libs/common/src/enums/device-type.enum.ts) for the requesting device. |
43+
| `deviceName` | The string representation of the [`DeviceType`](https://github.com/bitwarden/clients/blob/main/libs/common/src/enums/device-type.enum.ts) for the requesting device. |
4444
| `deviceIdentifier` | The unique identifier for the device, generated on the device when the application is installed.
4545
| `twoFactorToken` | For users who have two-factor authentication enabled, contains the token generated by the 2FA provider. Empty otherwise. See [Two-Factor Authentication](./two-factor-auth.md) for details. |
4646
| `twoFactorTokenProvider` | The 2FA provider that generated the token in `twoFactorToken`. Empty otherwise. |
@@ -138,7 +138,7 @@ There are different types of clients that can request access with the client_cre
138138

139139
The different API client types all have different validation. The key to `client_credentials` grant
140140
type validation is the `ClientStore` that is built in to IdentityServer (and
141-
[overridden](https://github.com/bitwarden/server/blob/master/src/Identity/IdentityServer/ClientStore.cs)
141+
[overridden](https://github.com/bitwarden/server/blob/main/src/Identity/IdentityServer/ClientStore.cs)
142142
in our code). The `ClientStore` is queried on each request in the .NET request middleware pipeline
143143
to find the client for a given `client_id` from the request.
144144

@@ -244,7 +244,7 @@ decrypted.
244244

245245
The core logic for handling the token responses is in the `processTokenResponse()` method in our
246246
base
247-
[`LoginStrategy`](https://github.com/bitwarden/clients/blob/master/libs/common/src/auth/login-strategies/login.strategy.ts)
247+
[`LoginStrategy`](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/login-strategies/login.strategy.ts)
248248
where we do the following:
249249

250250
### Use the Authentication information to set up the user’s account

docs/architecture/deep-dives/authentication/two-factor-auth.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ JSON data:
2727
## Handling 2FA response on the client
2828

2929
If the client detects a
30-
[`IdentityTwoFactorResponse`](https://github.com/bitwarden/clients/blob/master/libs/common/src/auth/models/response/identity-two-factor.response.ts)
30+
[`IdentityTwoFactorResponse`](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/models/response/identity-two-factor.response.ts)
3131
when attempting to log in, it extracts the available 2FA providers from the `CustomResponse` and
3232
presents those to the user.
3333

3434
Each 2FA method has its own UI, but in all cases the user will generate a "token" of some sort to
3535
capture the user's response. This token is captured on the
36-
[`TwoFactorComponent`](https://github.com/bitwarden/clients/blob/master/apps/desktop/src/auth/two-factor.component.ts)
36+
[`TwoFactorComponent`](https://github.com/bitwarden/clients/blob/main/apps/desktop/src/auth/two-factor.component.ts)
3737
when the user completes the 2FA process.
3838

3939
Once the user has entered their 2FA, a new authentication request is `POST`ed to the

docs/architecture/deep-dives/autofill/collecting-page-details.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ by a content script. The Bitwarden browser extension performs this in the `colle
1515
:::info Page Details
1616

1717
For in-depth knowledge of what is contained in the Page Details, the
18-
[`AutofillPageDetails`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/models/autofill-page-details.ts)
18+
[`AutofillPageDetails`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/models/autofill-page-details.ts)
1919
TypeScript class is documented to explain the properties and their purposes.
2020

2121
:::
@@ -249,13 +249,13 @@ details. When this occurs, the collection of the page details takes place throug
249249
method in the script.
250250

251251
The `collect()` method parses the page DOM and creates an instance of the
252-
[`AutofillPageDetails`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/models/autofill-page-details.ts)
252+
[`AutofillPageDetails`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/models/autofill-page-details.ts)
253253
class.
254254

255255
This class contains arrays of
256-
[`AutofillField`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/models/autofill-field.ts)
256+
[`AutofillField`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/models/autofill-field.ts)
257257
and
258-
[`AutofillForm`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/models/autofill-form.ts)
258+
[`AutofillForm`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/models/autofill-form.ts)
259259
objects, each of which represents a potentially fillable field on the page source. The properties on
260260
the objects are used in the next step of the Autofill process,
261261
['Generating the Fill Scripts'](./generating-fill-scripts.md).

docs/architecture/deep-dives/autofill/generating-fill-scripts.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ instructions that tell the `autofill.js` content script what fields to fill and
1414
should fill each field.
1515

1616
The generation of fill scripts is the responsibility of the
17-
[`AutofillService`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/services/autofill.service.ts).
17+
[`AutofillService`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/services/autofill.service.ts).
1818
There are three method used to perform fill script generation:
1919

2020
- `doAutoFill()`
@@ -98,7 +98,7 @@ done by looking at all fields in the Page Details **prior** to the password in t
9898
either:
9999

100100
- An exact match from the
101-
[`UsernameFieldNames`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/services/autofill-constants.ts)
101+
[`UsernameFieldNames`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/services/autofill-constants.ts)
102102
list, or
103103
- The text, email, or telephone field closest to the password field in the DOM
104104

@@ -148,7 +148,7 @@ For that field, we then loop through all of the field's attributes from the `Car
148148
- `data-recurly`
149149

150150
In the
151-
[`CreditCardAutoFillConstants`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/services/autofill-constants.ts),
151+
[`CreditCardAutoFillConstants`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/services/autofill-constants.ts),
152152
we define a static list of possible matching values for each of the fields on the Card Cipher type.
153153
For example, we define a `CardHolderFieldNames` array, which has all of the attribute values that we
154154
look for to find the likely "Cardholder Name" field in the DOM - and thus the field we want to fill
@@ -196,7 +196,7 @@ array. For that field, we then loop through all of the field's attributes from t
196196
- `data-recurly`
197197

198198
In the
199-
[`IdentityAutoFillConstants`](https://github.com/bitwarden/clients/blob/master/apps/browser/src/autofill/services/autofill-constants.ts),
199+
[`IdentityAutoFillConstants`](https://github.com/bitwarden/clients/blob/main/apps/browser/src/autofill/services/autofill-constants.ts),
200200
we define a static list of possible matching values for each of the fields on the Identity Cipher
201201
type. For example, we define a `FirstnameFieldNames` array, which has all of the attribute values
202202
that we look for to find the likely "First Name" field in the DOM - and thus the field we want to

docs/architecture/deep-dives/event-logs/index.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ cannot be circumvented by modifying the client.
2121
## Writing Events
2222

2323
Events are handled on our clients through the
24-
[`EventCollectionService`](https://github.com/bitwarden/clients/blob/master/libs/common/src/services/event/event-collection.service.ts)
24+
[`EventCollectionService`](https://github.com/bitwarden/clients/blob/main/libs/common/src/services/event/event-collection.service.ts)
2525
and
26-
[`EventUploadService`](https://github.com/bitwarden/clients/blob/master/libs/common/src/services/event/event-upload.service.ts)
26+
[`EventUploadService`](https://github.com/bitwarden/clients/blob/main/libs/common/src/services/event/event-upload.service.ts)
2727
for our JavaScript clients and the
28-
[`EventService`](https://github.com/bitwarden/mobile/blob/master/src/Core/Services/EventService.cs)
28+
[`EventService`](https://github.com/bitwarden/mobile/blob/main/src/Core/Services/EventService.cs)
2929
for our mobile clients. These services enqueue the events into a collection stored client-side which
3030
is periodically uploaded to the server, currently at 60 seconds intervals. Logs are also uploaded on
3131
logout, so there are no events orphaned in the collection.
@@ -42,42 +42,42 @@ by the `IEventWriteService`.
4242
### Cloud-Hosted
4343

4444
For cloud-hosted instances, we use the
45-
[`AzureQueueEventWriteService`](https://github.com/bitwarden/server/blob/master/src/Core/Services/Implementations/AzureQueueEventWriteService.cs)
45+
[`AzureQueueEventWriteService`](https://github.com/bitwarden/server/blob/main/src/Core/Services/Implementations/AzureQueueEventWriteService.cs)
4646
implementation, which writes the events to an Azure Queue that is specified in the
4747
`globalSettings.Events.ConnectionString` configuration setting.
4848

4949
The events in the Azure Queue are then processed by the `EventsProcessor` service that runs in the
5050
Bitwarden cloud-hosted instance. The `EventsProcessor` is running the
51-
[`AzureQueueHostedService`](https://github.com/bitwarden/server/blob/master/src/EventsProcessor/AzureQueueHostedService.cs),
51+
[`AzureQueueHostedService`](https://github.com/bitwarden/server/blob/main/src/EventsProcessor/AzureQueueHostedService.cs),
5252
which dequeues the event logs from the Azure Queue and writes them to Azure Table storage using the
53-
[`EventRepository`](https://github.com/bitwarden/server/blob/master/src/Core/Repositories/TableStorage/EventRepository.cs).
53+
[`EventRepository`](https://github.com/bitwarden/server/blob/main/src/Core/Repositories/TableStorage/EventRepository.cs).
5454

5555
### Self-Hosted
5656

5757
On self-hosted instances, the
58-
[`RepositoryEventWriteService`](https://github.com/bitwarden/server/blob/master/src/Core/Services/Implementations/RepositoryEventWriteService.cs)
58+
[`RepositoryEventWriteService`](https://github.com/bitwarden/server/blob/main/src/Core/Services/Implementations/RepositoryEventWriteService.cs)
5959
writes the event logs to the `Events` database table directly using the `EventRepository`.
6060

6161
## Querying Events
6262

6363
Event logs are queried through the
64-
[`EventsController`](https://github.com/bitwarden/server/blob/master/src/Api/Public/Controllers/EventsController.cs)
64+
[`EventsController`](https://github.com/bitwarden/server/blob/main/src/Api/Public/Controllers/EventsController.cs)
6565
on the Bitwarden API.
6666

6767
As with writing events, the querying of events differs based on the hosting method used for your
6868
Bitwarden instance. Since the events are logged to different places (Azure Table storage vs. the
6969
Bitwarden SQL database), the querying of these events must be different as well.
7070

7171
We do this with Dependency Injection in the `Api` project. The
72-
[`IEventRepository`](https://github.com/bitwarden/server/blob/master/src/Core/Repositories/IEventRepository.cs)
72+
[`IEventRepository`](https://github.com/bitwarden/server/blob/main/src/Core/Repositories/IEventRepository.cs)
7373
will have different implementations based on the hosting environment and the database provider in
7474
use.
7575

7676
### Cloud-Hosted
7777

7878
For cloud-hosted Bitwarden instances, the `EventsController` will query the Azure Table storage to
7979
look for the event logs, through the
80-
[`Bit.Core.Repositories.TableStorage.EventRepository`](https://github.com/bitwarden/server/blob/master/src/Core/Repositories/TableStorage/EventRepository.cs)
80+
[`Bit.Core.Repositories.TableStorage.EventRepository`](https://github.com/bitwarden/server/blob/main/src/Core/Repositories/TableStorage/EventRepository.cs)
8181
class, which implements `IEventRepository`.
8282

8383
### Self-Hosted

0 commit comments

Comments
 (0)