Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DX-1774, TT-13333] Upstream #5746

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

[DX-1774, TT-13333] Upstream #5746

wants to merge 9 commits into from
+497 −56

Conversation

andyo-tyk
Copy link
Contributor

@andyo-tyk andyo-tyk commented Nov 22, 2024 •
edited
Loading

User description

Preview Link

https://deploy-preview-5746--tyk-docs.netlify.app/docs/nightly/basic-config-and-security/security/upstream-authentication/

Description

Upstream authentication

PR Type

Documentation

Description

  • Added a new documentation page on upstream authentication, detailing various methods such as Mutual TLS, Token-based authentication, Basic Authentication, and OAuth 2.0.
  • Provided configuration examples for setting up upstream authentication in Tyk OAS API definitions.
  • Updated the documentation menu to include a new entry for "Upstream Authentication" and made title adjustments for consistency.

Changes walkthrough 📝

Relevant files
Documentation
upstream-authentication.md
Add detailed upstream authentication documentation             

tyk-docs/content/basic-config-and-security/security/upstream-authentication.md

  • Added comprehensive documentation on upstream authentication methods.
  • Included sections on Mutual TLS, Token-based authentication, Basic
    Authentication, and OAuth 2.0.
  • Provided configuration examples for Tyk OAS API definitions.
  • Explained usage of Tyk API Designer for setting up upstream
    authentication.
    		•  +437/-0 
    menu.yaml
    Update menu structure for upstream authentication               

    tyk-docs/data/menu.yaml

  • Updated menu titles for consistency (e.g., "MTLS" to "Mutual TLS").
  • Added new menu entry for "Upstream Authentication".
  • Adjusted capitalization for "Authentication and Authorization".
    		•  +11/-3   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 Security concerns

    OAuth 2.0 Password Grant Usage:
    The use of OAuth 2.0 Password Grant is mentioned as supported for legacy systems, despite being discouraged in security best practices. This could potentially expose sensitive user credentials if not handled with extreme caution.

    ⚡ Recommended focus areas for review

    Documentation Clarity
    The documentation should clarify the use of deprecated or discouraged security practices, such as the OAuth 2.0 Password Grant, and provide clear warnings or alternatives.

    Link Validation
    Ensure all internal and external links are valid and lead to the correct resources. This includes checking for correct URL formatting and verifying that all referenced documents exist and are accessible.

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @netlify Netlify
    Copy link

    netlify bot commented Nov 22, 2024 •
    edited
    Loading

    ✅ PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 3a035d3
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/674067e1f9555200087f047c
    😎 Deploy Preview https://deploy-preview-5746--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @netlify Netlify
    Copy link

    netlify bot commented Nov 22, 2024 •
    edited
    Loading

    ✅ PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit cb00b05
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6745a722c82d3f0008519a50
    😎 Deploy Preview https://deploy-preview-5746--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @andyo-tyk andyo-tyk changed the title [DX-, TT-13333] Upstream [DX-1774, TT-13333] Upstream Nov 22, 2024
    sharadregoti
    sharadregoti approved these changes Nov 26, 2024
    View reviewed changes
    tyk-docs/content/basic-config-and-security/security/upstream-authentication.md Outdated
    Comment on lines 14 to 16
    Tyk Gateway sits between your clients and your services, securely routing requests and responses. For each API proxy that you expose on Tyk, you can configure a range of different methods that clients must use to identify (authenticate) themselves to Tyk Gateway. These are described in detail in the [Client Authentication]({{< ref "basic-config-and-security/security/authentication-&-authorization" >}}) section.

    In the same way as you use Client Authentication to securely confirm the identity of the API clients, your upstream services probably need to securely confirm the identity of their client - namely Tyk. This is where Tyk's flexible **Upstream Authentication** capability comes in.
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Need an image that elaborate this text.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I agree - there are a lot of places where we need images (and can then remove some of my verbosity 😂 ). Given workload at the moment, can we add this later, for when this page is published publicly?

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I'll try to add it by EOD, If not then I'll merge it.

    tyk-docs/content/basic-config-and-security/security/upstream-authentication.md Outdated Show resolved Hide resolved
    tyk-docs/content/basic-config-and-security/security/upstream-authentication.md Outdated Show resolved Hide resolved
    tyk-docs/content/basic-config-and-security/security/upstream-authentication.md Outdated Show resolved Hide resolved
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @sharadregoti sharadregoti sharadregoti approved these changes

    @lghiur lghiur lghiur approved these changes

    @jeffy-mathew jeffy-mathew Awaiting requested review from jeffy-mathew

    @andrei-tyk andrei-tyk Awaiting requested review from andrei-tyk

    Assignees
    No one assigned
    Labels
    5.7.0 Review effort [1-5]: 3
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @andyo-tyk @lghiur @sharadregoti