Skip to content

Commit caa4bca

Browse files
committed
docs(links): point Connector repo references at WordPress.org
`getting-started.md` installation step now links to the WordPress.org plugin page + the WP.org direct ZIP download instead of a pinned GitHub releases URL. The pinned-version URL had drifted to a 1.1.1.0 build; the WP.org ZIP always serves the latest stable. `flows.md` deep-link references replace `github.com/.../blob/<sha>/...` URLs with `plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/...` equivalents. Line anchors re-derived against current trunk — several symbols moved (notably `Encryption::createIdentityNonce` from L399 to L863) and `TrustedLoginService::envelopeToUrl()` was renamed to `envelope_to_url()`.
1 parent eb01b07 commit caa4bca

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎docs/flows.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The public key is fetched by default from the [URL defined in the `vendor/websit
4141

4242
### Step 3: Public Key is Generated {#step-3-public-key-is-generated}
4343

44-
The public key request is handled by [`\TrustedLogin\Vendor\Endpoints\PublicKey::get()`](https://github.com/trustedlogin/trustedlogin-connector/blob/aac75e18d21728155b76537f908031fc17cd562a/php/Endpoints/PublicKey.php#L20), which uses [`\TrustedLogin\Vendor\Encryption::generateKeys()`](https://github.com/trustedlogin/trustedlogin-connector/blob/aac75e18d21728155b76537f908031fc17cd562a/php/Encryption.php#L100) to generate two sets of encryption keys (`crypto_sign` and `crypto_box` key pairs) but only returns the `crypto_box` public key.
44+
The public key request is handled by [`\TrustedLogin\Vendor\Endpoints\PublicKey::get()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/Endpoints/PublicKey.php#L19), which uses [`\TrustedLogin\Vendor\Encryption::generateKeys()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/Encryption.php#L222) to generate two sets of encryption keys (`crypto_sign` and `crypto_box` key pairs) but only returns the `crypto_box` public key.
4545

4646
### Step 4: Envelope Created & Encrypted {#step-4-envelope-created--encrypted}
4747

@@ -81,11 +81,11 @@ The **unsuccessful** response is:
8181

8282
![Site Access Key login form](/img/flows/login/step-01.png)
8383

84-
The form submits a `POST` HTTP request via AJAX that is received by the [`TrustedLogin\Vendor\AccessKeyLogin::handle()`](https://github.com/trustedlogin/trustedlogin-connector/blob/main/php/AccessKeyLogin.php#L106) method.
84+
The form submits a `POST` HTTP request via AJAX that is received by the [`TrustedLogin\Vendor\AccessKeyLogin::handle()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/AccessKeyLogin.php#L171) method.
8585

86-
Receiving that request, [`TrustedLogin\Vendor\AccessKeyLogin::verifyGrantAccessRequest()`](https://github.com/trustedlogin/trustedlogin-connector/blob/main/php/AccessKeyLogin.php#L200) verifies that the nonce is valid and that the request is coming from inside the site.
86+
Receiving that request, [`TrustedLogin\Vendor\AccessKeyLogin::verifyGrantAccessRequest()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/AccessKeyLogin.php#L305) verifies that the nonce is valid and that the request is coming from inside the site.
8787

88-
In addition, [`TrustedLogin\Vendor\Traits\VerifyUser::verifyUserRole()`](https://github.com/trustedlogin/trustedlogin-connector/blob/develop/php/Traits/VerifyUser.php#L17) checks to make sure the user is logged-in and has one or more of the roles that are required to access the site.
88+
In addition, [`TrustedLogin\Vendor\Traits\VerifyUser::verifyUserRole()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/Traits/VerifyUser.php#L17) checks to make sure the user is logged-in and has one or more of the roles that are required to access the site.
8989

9090
### Step 2: Vendor Requests List of Matching Site IDs {#step-2-vendor-requests-list-of-matching-site-ids}
9191

@@ -129,10 +129,10 @@ An array of Secret IDs is returned. These are not the envelope itself; Secret ID
129129

130130
The Connector plugin uses the Secret IDs to retrieve the envelopes from the Vault.
131131

132-
In addition to the Bearer token, the request generates a signed nonce in [`TrustedLogin\Vendor\Encryption::createIdentityNonce()`](https://github.com/trustedlogin/trustedlogin-connector/blob/develop/php/Encryption.php#L399). The method:
132+
In addition to the Bearer token, the request generates a signed nonce in [`TrustedLogin\Vendor\Encryption::createIdentityNonce()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/Encryption.php#L863). The method:
133133

134-
- Generates a cryptographic nonce (in [`TrustedLogin\Vendor\Encryption::generateNonce()`](https://github.com/trustedlogin/trustedlogin-connector/blob/develop/php/Encryption.php#L485) using `random_bytes()`),
135-
- Signs the nonce with the `sign_private_key` pair (in [`TrustedLogin\Vendor\Encryption::sign()`](https://github.com/trustedlogin/trustedlogin-connector/blob/develop/php/Encryption.php#L512), using `sodium_crypto_sign_detached()`), and
134+
- Generates a cryptographic nonce (in [`TrustedLogin\Vendor\Encryption::generateNonce()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/Encryption.php#L953) using `random_bytes()`),
135+
- Signs the nonce with the `sign_private_key` pair (in [`TrustedLogin\Vendor\Encryption::sign()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/Encryption.php#L979), using `sodium_crypto_sign_detached()`), and
136136
- Verifies that the signed nonce has been properly generated (using `sodium_crypto_sign_verify_detached()`)
137137

138138
The nonce and signed nonce are both sent in the request, helping to verify that this site is indeed the sender of the data.
@@ -155,13 +155,13 @@ The envelope with encrypted credentials is returned to the Vendor.
155155

156156
The Connector plugin receives the envelope. It includes the Site URL associated with the Site Access Key but not the endpoint, which is required to log in.
157157

158-
The Connector plugin decrypts the envelope and extracts the credentials, then cryptographically generates the URL to access Client site (using [`TrustedLogin\Vendor\TrustedLoginService::envelopeToUrl()`](https://github.com/trustedlogin/trustedlogin-connector/blob/a62ec370bb5e715eed3524bf92c77482e785d273/php/TrustedLoginService.php#L395)).
158+
The Connector plugin decrypts the envelope and extracts the credentials, then cryptographically generates the URL to access Client site (using [`TrustedLogin\Vendor\TrustedLoginService::envelope_to_url()`](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/php/TrustedLoginService.php#L808)).
159159

160160
The site URL and the access parts are returned as an AJAX response, completing the request started in Step 1.
161161

162162
### Step 7: Connector Plugin `POST`s to Client Site {#step-7-connector-plugin-posts-to-client-site}
163163

164-
A temporary form [is created using JavaScript](https://github.com/trustedlogin/trustedlogin-connector/blob/a62ec370bb5e715eed3524bf92c77482e785d273/src/components/AccessKeyForm.js#L259-L281) with the Client Site URL set as the form `action` property. A `POST` request is submitted, preventing the submitted data from being logged.
164+
A temporary form [is created using JavaScript](https://plugins.trac.wordpress.org/browser/trustedlogin-connector/trunk/src/components/AccessKeyForm.js#L253) with the Client Site URL set as the form `action` property. A `POST` request is submitted, preventing the submitted data from being logged.
165165

166166
The form submits the following to the Client Site URL:
167167

‎docs/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Don't close the tab! We'll be coming back here to grab the Account ID, Public Ke
6767

6868
The TrustedLogin Connector plugin is a WordPress plugin that you host on your own site. The Connector plugin is what makes TrustedLogin so secure: secrets are encrypted and decrypted using keys that are generated by the Connector plugin.
6969

70-
1. [Download the Connector plugin](https://github.com/trustedlogin/trustedlogin-connector/releases/download/v1.1.1.0/trustedlogin-connector-1.1.1.zip)
70+
1. Get the plugin from the [WordPress.org plugin page](https://wordpress.org/plugins/trustedlogin-connector/) — or [download the latest ZIP directly](https://downloads.wordpress.org/plugin/trustedlogin-connector.zip)
7171
2. Upload the plugin to your WordPress installation
7272
3. Click the new "TrustedLogin" menu item in the sidebar menu
7373

0 commit comments

Comments
 (0)