Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Use https for hyperlinked APIs by replacing the URLs #576

Merged
merged 2 commits into from
Mar 22, 2022
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Mar 18, 2022

Fixes

Fixes #573 by @oskosk

This is a proposed alternative to #574.

Description

This PR configures Django to replace the schemes in the URLs by extending the HyperlinkedIdentityField with a scheme argument (that takes the default from the settings).

Testing Instructions

  1. Remove the API_LINK_SCHEME from the env files.
  2. Run the services using Docker Compose: just up.
  3. Visit the dev server at https://localhost/v1/images and observe that all URLs are https and not http.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Mar 18, 2022
@dhruvkb dhruvkb requested a review from a team as a code owner March 18, 2022 19:06
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

This looks good! It's at least an easy way to address the problem until we have a chance to restructure how we're proxying 😄

api/catalog/api/serializers/base.py Outdated Show resolved Hide resolved
Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Works great! I'd propose we scrap #574 and instead follow this up with a just command, README instructions, and gitignore addition of .pem files while using local certificates generated with mkcert.

I guess we'd also need some code to point django to the local certificate files, but I'll leave that to y'all 😄

@dhruvkb
Copy link
Member Author

dhruvkb commented Mar 22, 2022

Merging this while we come up with a clean permanent solution.

@dhruvkb dhruvkb merged commit a5f8b48 into main Mar 22, 2022
@dhruvkb dhruvkb deleted the http_link_hack branch March 22, 2022 15:29
@dhruvkb dhruvkb mentioned this pull request Apr 8, 2022
7 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Return secure URLs for the fields thumbnail, detail_url and related_url.
3 participants