Add Ory Kratos Integration. #198

Shaktizala · 2024-01-16T07:35:39Z

Closes #193

Changes proposed

Kratos Integration
Endpoint for Kratos redirecting and storing user details in the database.
Kratos service in docker compose and kratos database in the same PostgreSQL server.

Check List (Check all the applicable boxes)

My code follows the code style of this project.
My change requires changes to the documentation.
I have updated the documentation accordingly.
All new and existing tests passed.
This PR does not contain plagiarized content.
The title of my pull request is a short description of the requested changes.

- kratos database in same postgres server with backend database configuration is in the docker-compose.yaml - add auth controller for the kratos only if the kratos required flag is set to true - change in the user table schema, password and roles are nullable now - kratos_id addition and model for the same for databae insertion

README.md

munir131 · 2024-01-16T08:11:30Z

config/kratos.go

+	BaseURL    string `envconfig:"SERVE_PUBLIC_BASE_URL"`
+	UIUrl      string `envconfig:"SELF_SERVICE_DEFAULT_BROWSER_RETURN_URL"`
+	AdminUrl   string `envconfig:"SERVE_ADMIN_BASE_URL"`
+	PublicUrl  string `envconfig:"SERVE_PUBLIC_BASE_URL"`


@Shaktizala What is different between BaseURL and PublicURL? Also keep consistency in naming. In BaseURL, URL is in uppercase when in PublicUrl and AdminUrl it is in CamelCase

Both are same, it's the kratos base url, but as kratos requires envs to be in specific format it is kept like, "SERVE_PUBLIC_BASE_URL".

@Shaktizala If both are same then why are you using two variables for same env?

My bad, it was there for previous env configuration, will remove it.

constants/constant.go

munir131 · 2024-01-16T08:31:13Z

controllers/api/v1/auth_controller.go

+//		      400: GenericResFailBadRequest
+//			  500: GenericResError
+func (ctrl *AuthController) DoKratosAuth(c *fiber.Ctx) error {
+	kratosID := c.Locals(constants.KratosID)


@Shaktizala What is the purpose of using c.Locals?

It's used to fetch kratosID into the next handle. It means we can add it to locals from here and fetch it from the next handler.

@Shaktizala Is it middleware? Middleware shouldn't be in controller

No, it's not middleware. used to pass an ID from middleware to next handler.

I mean, is DoKratosAuth middleware?

No, it's not middleware. It's an endpoint on which kratos will redirect after successful login/registration.

controllers/api/v1/auth_controller.go

config/kratos.go

munir131 · 2024-01-16T09:05:19Z

pkg/kratos/readme.md

+route.Get("/\<end-point\>", middlewares.Authenticated, authController.DoKratosAuth)
+
+## How Kratos Integration Works?
+You have to provide Kratos with your UI endpoint URLs, Kratos will redirect to those endpoints by initializing the flow. 


@Shaktizala What frontend has to sent? Should it work with ajax request? Does it need to follow any xml/json format? Or it is form?

Yes, it is in form.

Then please document that or add link of external doc

okay will update it.

Co-authored-by: Munir Khakhi <6319375+munir131@users.noreply.github.com> Signed-off-by: Shaktiraj Zala <123356347+Shaktizala@users.noreply.github.com>

munir131 · 2024-01-16T12:28:51Z

controllers/api/v1/auth_controller.go

+	c.Redirect(ctrl.config.Kratos.UIUrl)
+
+	c.Locals(constants.KratosUserDetails, user)
+	c.Next()


@Shaktizala What is purpose of it? L154 will already redirect on UI

sorry, forgot to remove it, it was there when I was not doing redirection. will update it.

pratikbgit

Define step pkg/kratos/oidc then run base64 -w 0 google.schema.jsonnet
Mention the steps for OAuth 2.0 client IDs and redirect URLs set.
Start service in on go, like Kratos up command then migrate up then api run etc.
Info: If the password field is not required, then please remove it.

Shaktizala · 2024-01-23T12:31:06Z

Define step pkg/kratos/oidc than run base64 -w 0 google.schema.jsonnet

Mention steps of OAuth 2.0 Client IDs and redirect url set.

Start service in on go like Kratos up command then migrate up then api run etc.

info : If password filed is not required then please remove it.

@pratikbgit Password field is required, when kratos is not enabled We have to use authentication using password so at that time we need to store password.

I am not getting the 3rd statement, can you please elaborate.

CC: @munir131

pratikbgit · 2024-01-23T12:40:59Z

Define step pkg/kratos/oidc than run base64 -w 0 google.schema.jsonnet

Mention steps of OAuth 2.0 Client IDs and redirect url set.

Start service in on go like Kratos up command then migrate up then api run etc.

info : If password filed is not required then please remove it.

@pratikbgit Password field is required, when kratos is not enabled We have to use authentication using password so at that time we need to store password.

I am not getting the 3rd statement, can you please elaborate.

CC: @munir131

While kratos service start before that migrate and api service should start not manually.

Shaktizala · 2024-01-30T07:17:28Z

Define step pkg/kratos/oidc than run base64 -w 0 google.schema.jsonnet

Mention steps of OAuth 2.0 Client IDs and redirect url set.

Start service in on go like Kratos up command then migrate up then api run etc.

info : If password filed is not required then please remove it.

@pratikbgit Password field is required, when kratos is not enabled We have to use authentication using password so at that time we need to store password.
I am not getting the 3rd statement, can you please elaborate.
CC: @munir131

While kratos service start before that migrate and api service should start not manually.

@pratikbgit
I discussed this with @munir131.

We will have to make one script file for starting all three services.
There is no need to remove the password field, as it is required when we are not using Kratos.
I will add a link to the steps of creating a client ID, secrets, and different details of it.

… the backend server all together. - update docs accordingly

munir131 · 2024-02-05T07:19:16Z

@Shaktizala Please resolve conflicts

Signed-off-by: Shaktiraj Zala <123356347+Shaktizala@users.noreply.github.com>

Shaktizala added 3 commits January 11, 2024 10:37

feat: WIP kratos integration

7b8727b

fix: readme documentation and swagger documentation

2965204

Shaktizala requested review from munir131 and Bhautik0110 January 16, 2024 07:35

Shaktizala self-assigned this Jan 16, 2024

munir131 requested changes Jan 16, 2024

View reviewed changes

Shaktizala and others added 3 commits January 16, 2024 15:08

Update README.md

ad9eae1

Co-authored-by: Munir Khakhi <6319375+munir131@users.noreply.github.com> Signed-off-by: Shaktiraj Zala <123356347+Shaktizala@users.noreply.github.com>

Update constants/constant.go

e69b0f2

Co-authored-by: Munir Khakhi <6319375+munir131@users.noreply.github.com> Signed-off-by: Shaktiraj Zala <123356347+Shaktizala@users.noreply.github.com>

fix: cookie expiration time form envs, naming conventions, doc updation

b751b30

Shaktizala requested a review from munir131 January 16, 2024 12:12

munir131 reviewed Jan 16, 2024

View reviewed changes

fix: remove unnecessary code and update documentation

9efcfec

Shaktizala requested a review from munir131 January 16, 2024 12:41

fix: docs

7212778

Shaktizala requested a review from pratikbgit January 18, 2024 06:25

munir131 previously approved these changes Jan 23, 2024

View reviewed changes

pratikbgit suggested changes Jan 23, 2024

View reviewed changes

fix: docs update

c7777db

Shaktizala dismissed munir131’s stale review via c7777db January 30, 2024 05:29

Shaktizala added 2 commits January 30, 2024 19:50

fix: docs for creating OAUth client

3e43356

feat: script to start all service, database migration and starting up…

55039ca

… the backend server all together. - update docs accordingly

Shaktizala requested review from munir131 and pratikbgit January 31, 2024 04:06

pratikbgit assigned pratikbgit and unassigned Shaktizala Feb 4, 2024

munir131 previously approved these changes Feb 5, 2024

View reviewed changes

Merge branch 'main' into feat/kratos-integration

7fee31b

Signed-off-by: Shaktiraj Zala <123356347+Shaktizala@users.noreply.github.com>

Shaktizala dismissed munir131’s stale review via 7fee31b February 5, 2024 07:24

Shaktizala requested a review from munir131 February 5, 2024 07:25

munir131 approved these changes Feb 5, 2024

View reviewed changes

munir131 merged commit 3e560c1 into main Feb 5, 2024
2 checks passed

munir131 deleted the feat/kratos-integration branch February 5, 2024 08:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Ory Kratos Integration. #198

Add Ory Kratos Integration. #198

Shaktizala commented Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

munir131 Jan 16, 2024

Shaktizala Jan 16, 2024

pratikbgit left a comment •

edited by Shaktizala

Loading

Shaktizala commented Jan 23, 2024 •

edited

Loading

pratikbgit commented Jan 23, 2024 •

edited by Shaktizala

Loading

Shaktizala commented Jan 30, 2024 •

edited

Loading

munir131 commented Feb 5, 2024

Add Ory Kratos Integration. #198

Add Ory Kratos Integration. #198

Conversation

Shaktizala commented Jan 16, 2024

Changes proposed

Check List (Check all the applicable boxes)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pratikbgit left a comment • edited by Shaktizala Loading

Choose a reason for hiding this comment

Shaktizala commented Jan 23, 2024 • edited Loading

pratikbgit commented Jan 23, 2024 • edited by Shaktizala Loading

Shaktizala commented Jan 30, 2024 • edited Loading

munir131 commented Feb 5, 2024

pratikbgit left a comment •

edited by Shaktizala

Loading

Shaktizala commented Jan 23, 2024 •

edited

Loading

pratikbgit commented Jan 23, 2024 •

edited by Shaktizala

Loading

Shaktizala commented Jan 30, 2024 •

edited

Loading