Skip to content

Commit 08b7f42

Browse files
committed
Added a README section about Security
1 parent 1090e10 commit 08b7f42

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ Please check the table below on what the values mean and what their value should
8383
|`STACKKIT_CLOUD_TASKS_LOCATION`|The region where the AppEngine is hosted|`europe-west6`
8484
|`STACKKIT_CLOUD_TASKS_HANDLER`|The URL that Cloud Tasks will call to process a job. This should be the URL to your Laravel app with the `handle-task` path added|`https://<your website>.com/handle-task`
8585
|`STACKKIT_CLOUD_TASKS_QUEUE`|The queue a job will be added to|`emails`
86-
|`STACKKIT_CLOUD_TASKS_SERVICE_EMAIL`|The emailaddress of the AppEngine service account. Important, it should have the *Cloud Tasks Enqueuer* role|`[email protected]`
86+
|`STACKKIT_CLOUD_TASKS_SERVICE_EMAIL`|The email address of the AppEngine service account. Important, it should have the *Cloud Tasks Enqueuer* role. This is used for securing the handler.|`[email protected]`
87+
8788
# Configuring the queue
8889

8990
When you first create a queue using `gcloud tasks queues create`, the default settings will look something like this:
@@ -141,3 +142,13 @@ gcloud tasks queues update [QUEUE_ID] --max-concurrent-dispatches=1
141142
More information on configuring queues:
142143

143144
https://cloud.google.com/tasks/docs/configuring-queues
145+
146+
# Security
147+
148+
The job handler requires each request to have an OpenID token. In the installation step we set the service account email, and with that service account, Cloud Tasks will generate an OpenID token and send it along with the job payload to the handler.
149+
150+
This package verifies that the token is digitally signed by Google. Only Google Tasks will be able to call your handler.
151+
152+
More information about OpenID Connect:
153+
154+
https://developers.google.com/identity/protocols/oauth2/openid-connect

0 commit comments

Comments
 (0)