Skip to content

Commit 185e42c

Browse files
authored
authorization warnings and config naming (#3162)
1 parent 8281e68 commit 185e42c

File tree

7 files changed

+26
-22
lines changed

7 files changed

+26
-22
lines changed

reports/llms-report.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
{
2-
"startedAt": "2025-11-11T18:30:56.374Z",
2+
"startedAt": "2025-11-11T23:46:50.901Z",
33
"siteBase": "https://docs.chain.link",
44
"sections": [
55
{
66
"section": "cre-go",
77
"pagesProcessed": 84,
88
"outputPath": "src/content/cre/llms-full-go.txt",
9-
"bytes": 631069,
10-
"prevBytes": 631094,
11-
"deltaBytes": -25
9+
"bytes": 631240,
10+
"prevBytes": 631069,
11+
"deltaBytes": 171
1212
},
1313
{
1414
"section": "cre-ts",
1515
"pagesProcessed": 79,
1616
"outputPath": "src/content/cre/llms-full-ts.txt",
17-
"bytes": 586483,
18-
"prevBytes": 586508,
19-
"deltaBytes": -25
17+
"bytes": 586661,
18+
"prevBytes": 586483,
19+
"deltaBytes": 178
2020
},
2121
{
2222
"section": "vrf",
@@ -123,5 +123,5 @@
123123
"deltaBytes": 0
124124
}
125125
],
126-
"finishedAt": "2025-11-11T18:31:00.312Z"
126+
"finishedAt": "2025-11-11T23:46:54.854Z"
127127
}

src/content/cre/guides/workflow/using-triggers/http-trigger/configuration-go.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func InitWorkflow(config *Config, logger *slog.Logger, secretsProvider cre.Secre
5858
authorizedKeys := []*http.AuthorizedKey{
5959
{
6060
Type: http.KeyType_KEY_TYPE_ECDSA_EVM,
61-
PublicKey: config.HTTPPublicKey,
61+
PublicKey: config.AuthorizedEVMAddress,
6262
},
6363
}
6464

src/content/cre/guides/workflow/using-triggers/http-trigger/configuration-ts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You create an HTTP trigger by calling the `HTTPCapability.trigger()` method. Its
3333
import { cre, type Runtime, type HTTPPayload, Runner } from "@chainlink/cre-sdk"
3434

3535
type Config = {
36-
httpPublicKey: string
36+
authorizedEVMAddress: string
3737
}
3838

3939
// Callback function that runs when an HTTP request is received
@@ -52,7 +52,7 @@ const initWorkflow = (config: Config) => {
5252
authorizedKeys: [
5353
{
5454
type: "KEY_TYPE_ECDSA_EVM",
55-
publicKey: config.httpPublicKey,
55+
publicKey: config.authorizedEVMAddress,
5656
},
5757
],
5858
}),

src/content/cre/guides/workflow/using-triggers/http-trigger/overview-go.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ When you deploy a workflow with an HTTP trigger:
2424
1. **CRE validates the signature** against your configured `authorizedKeys`
2525
1. **If authorized**, your workflow callback executes with the request payload
2626

27-
<Aside type="note" title="Security by design">
27+
<Aside type="caution" title="Authorization required for deployed workflows">
2828
For **deployed workflows**, HTTP triggers use cryptographic signatures to ensure only authorized addresses can execute
2929
your workflow. During **local simulation**, you can use empty authorization configs to simplify testing—just remember
30-
to add `authorizedKeys` before deploying.
30+
to add `authorizedKeys` before deploying. Learn more: [Configuration &
31+
Handler](/cre/guides/workflow/using-triggers/http-trigger/configuration-go#configuration-and-handler).
3132
</Aside>
3233

3334
## When to use HTTP triggers

src/content/cre/guides/workflow/using-triggers/http-trigger/overview-ts.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ When you deploy a workflow with an HTTP trigger:
2424
1. **CRE validates the signature** against your configured `authorizedKeys`
2525
1. **If authorized**, your workflow callback executes with the request payload
2626

27-
<Aside type="note" title="Security by design">
27+
<Aside type="caution" title="Authorization required for deployed workflows">
2828
For **deployed workflows**, HTTP triggers use cryptographic signatures to ensure only authorized addresses can execute
2929
your workflow. During **local simulation**, you can use empty authorization configs to simplify testing—just remember
30-
to add `authorizedKeys` before deploying.
30+
to add `authorizedKeys` before deploying. Learn more: [Configuration &
31+
Handler](/cre/guides/workflow/using-triggers/http-trigger/configuration-ts#configuration-and-handler).
3132
</Aside>
3233

3334
## When to use HTTP triggers

src/content/cre/llms-full-go.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12071,7 +12071,7 @@ func InitWorkflow(config *Config, logger *slog.Logger, secretsProvider cre.Secre
1207112071
authorizedKeys := []*http.AuthorizedKey{
1207212072
{
1207312073
Type: http.KeyType_KEY_TYPE_ECDSA_EVM,
12074-
PublicKey: config.HTTPPublicKey,
12074+
PublicKey: config.AuthorizedEVMAddress,
1207512075
},
1207612076
}
1207712077

@@ -12143,10 +12143,11 @@ When you deploy a workflow with an HTTP trigger:
1214312143
4. **CRE validates the signature** against your configured `authorizedKeys`
1214412144
5. **If authorized**, your workflow callback executes with the request payload
1214512145

12146-
<Aside type="note" title="Security by design">
12146+
<Aside type="caution" title="Authorization required for deployed workflows">
1214712147
For **deployed workflows**, HTTP triggers use cryptographic signatures to ensure only authorized addresses can execute
1214812148
your workflow. During **local simulation**, you can use empty authorization configs to simplify testing—just remember
12149-
to add `authorizedKeys` before deploying.
12149+
to add `authorizedKeys` before deploying. Learn more: [Configuration &
12150+
Handler](/cre/guides/workflow/using-triggers/http-trigger/configuration-go#configuration-and-handler).
1215012151
</Aside>
1215112152

1215212153
## When to use HTTP triggers

src/content/cre/llms-full-ts.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10966,7 +10966,7 @@ You create an HTTP trigger by calling the `HTTPCapability.trigger()` method. Its
1096610966
import { cre, type Runtime, type HTTPPayload, Runner } from "@chainlink/cre-sdk"
1096710967

1096810968
type Config = {
10969-
httpPublicKey: string
10969+
authorizedEVMAddress: string
1097010970
}
1097110971

1097210972
// Callback function that runs when an HTTP request is received
@@ -10985,7 +10985,7 @@ const initWorkflow = (config: Config) => {
1098510985
authorizedKeys: [
1098610986
{
1098710987
type: "KEY_TYPE_ECDSA_EVM",
10988-
publicKey: config.httpPublicKey,
10988+
publicKey: config.authorizedEVMAddress,
1098910989
},
1099010990
],
1099110991
}),
@@ -11059,10 +11059,11 @@ When you deploy a workflow with an HTTP trigger:
1105911059
4. **CRE validates the signature** against your configured `authorizedKeys`
1106011060
5. **If authorized**, your workflow callback executes with the request payload
1106111061

11062-
<Aside type="note" title="Security by design">
11062+
<Aside type="caution" title="Authorization required for deployed workflows">
1106311063
For **deployed workflows**, HTTP triggers use cryptographic signatures to ensure only authorized addresses can execute
1106411064
your workflow. During **local simulation**, you can use empty authorization configs to simplify testing—just remember
11065-
to add `authorizedKeys` before deploying.
11065+
to add `authorizedKeys` before deploying. Learn more: [Configuration &
11066+
Handler](/cre/guides/workflow/using-triggers/http-trigger/configuration-ts#configuration-and-handler).
1106611067
</Aside>
1106711068

1106811069
## When to use HTTP triggers

0 commit comments

Comments
 (0)