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

feat(config): Wrap sensitive urls #1828

Merged
merged 21 commits into from
May 3, 2024
Merged

feat(config): Wrap sensitive urls #1828

merged 21 commits into from
May 3, 2024

Conversation

slowli
Copy link
Contributor

@slowli slowli commented Apr 29, 2024 •
edited
Loading

What ❔

Wraps URLs with potential sensitive parts (username / password) in a newtype. Uses these URLs in configs and elsewhere.

Why ❔

Expresses sensitivity via type system (= easier to track and reason about uses). Makes it safe to derive(Debug) for types containing such URLs.

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.
  • Code has been formatted via zk fmt and zk lint.
  • Spellcheck has been run via zk spellcheck.
  • Linkcheck has been run via zk linkcheck.

slowli
slowli commented Apr 29, 2024
View reviewed changes
core/bin/external_node/src/config/mod.rs Show resolved Hide resolved
core/lib/basic_types/src/url.rs Show resolved Hide resolved
core/lib/eth_client/src/clients/http/query.rs Show resolved Hide resolved
core/lib/eth_client/src/lib.rs Show resolved Hide resolved
@slowli slowli marked this pull request as ready for review April 30, 2024 14:08
popzxc
popzxc previously approved these changes May 1, 2024
View reviewed changes
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

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

Still not fully sold that we need an ad-hoc approach rather than some generic wrapper that "Just Works" (mainly because of adoption potential), but certainly believe that it's an improvement over what we have now.

popzxc
popzxc previously approved these changes May 2, 2024
View reviewed changes
@slowli slowli added this pull request to the merge queue May 2, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 2, 2024
@slowli slowli added this pull request to the merge queue May 2, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 2, 2024
@slowli slowli added this pull request to the merge queue May 2, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 2, 2024
@slowli slowli added this pull request to the merge queue May 2, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 2, 2024
@slowli slowli added this pull request to the merge queue May 2, 2024
@slowli slowli removed this pull request from the merge queue due to a manual request May 2, 2024
popzxc
popzxc previously approved these changes May 2, 2024
View reviewed changes
@slowli slowli added this pull request to the merge queue May 3, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 3, 2024
@slowli slowli added this pull request to the merge queue May 3, 2024
Merged via the queue into main with commit c8ee740 May 3, 2024
43 checks passed
@slowli slowli deleted the aov-pla-915-wrap-sensitive-urls branch May 3, 2024 10:02
This was referenced May 3, 2024
Merged
Merged
github-merge-queue bot pushed a commit that referenced this pull request May 6, 2024
@zksync-era-bot
chore(main): release prover 14.0.0 (#1772)
f6e63e1 
🤖 I have created a release *beep* *boop*
---


##
[14.0.0](prover-v13.0.0...prover-v14.0.0)
(2024-05-06)


### ⚠ BREAKING CHANGES

* **prover:** Protocol Upgrade 1.5.0
([#1699](#1699))
* shared bridge
([#298](#298))

### Features

* **config:** Wrap sensitive urls
([#1828](#1828))
([c8ee740](c8ee740))
* **Prover CLI:** `status batch` command
([#1638](#1638))
([3fd6d65](3fd6d65))
* **prover:** Protocol Upgrade 1.5.0
([#1699](#1699))
([6a557f7](6a557f7))
* **prover:** remove redundant config fields
([#1787](#1787))
([a784ea6](a784ea6))
* shared bridge
([#298](#298))
([8c3478a](8c3478a))
* **vm-runner:** implement VM runner storage layer
([#1651](#1651))
([543f9e9](543f9e9))


### Bug Fixes

* **en:** Remove duplicate reorg detector
([#1783](#1783))
([3417941](3417941))
* **prover:** Use all 1.5.0 groups for nodes
([#1851](#1851))
([70178e5](70178e5))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Deniallugo pushed a commit that referenced this pull request May 7, 2024
@slowli @Deniallugo
feat(config): Wrap sensitive urls (#1828)
c1356f6 
## What ❔

Wraps URLs with potential sensitive parts (username / password) in a
newtype. Uses these URLs in configs and elsewhere.

## Why ❔

Expresses sensitivity via type system (= easier to track and reason
about uses). Makes it safe to `derive(Debug)` for types containing such
URLs.

## Checklist

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
- [x] Code has been formatted via `zk fmt` and `zk lint`.
- [x] Spellcheck has been run via `zk spellcheck`.
- [x] Linkcheck has been run via `zk linkcheck`.
Deniallugo pushed a commit that referenced this pull request May 7, 2024
@zksync-era-bot @Deniallugo
chore(main): release prover 14.0.0 (#1772)
cd912af 
🤖 I have created a release *beep* *boop*
---


##
[14.0.0](prover-v13.0.0...prover-v14.0.0)
(2024-05-06)


### ⚠ BREAKING CHANGES

* **prover:** Protocol Upgrade 1.5.0
([#1699](#1699))
* shared bridge
([#298](#298))

### Features

* **config:** Wrap sensitive urls
([#1828](#1828))
([c8ee740](c8ee740))
* **Prover CLI:** `status batch` command
([#1638](#1638))
([3fd6d65](3fd6d65))
* **prover:** Protocol Upgrade 1.5.0
([#1699](#1699))
([6a557f7](6a557f7))
* **prover:** remove redundant config fields
([#1787](#1787))
([a784ea6](a784ea6))
* shared bridge
([#298](#298))
([8c3478a](8c3478a))
* **vm-runner:** implement VM runner storage layer
([#1651](#1651))
([543f9e9](543f9e9))


### Bug Fixes

* **en:** Remove duplicate reorg detector
([#1783](#1783))
([3417941](3417941))
* **prover:** Use all 1.5.0 groups for nodes
([#1851](#1851))
([70178e5](70178e5))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
RomanBrodetski pushed a commit that referenced this pull request May 8, 2024
@zksync-era-bot @perekopskiy
chore(main): release core 24.1.0 (#1836)
4df5b7f 
🤖 I have created a release *beep* *boop*
---


##
[24.1.0](core-v24.0.0...core-v24.1.0)
(2024-05-08)


### Features

* add `sendRawTransactionWithDetailedOutput` API
([#1806](#1806))
([6a30a31](6a30a31))
* add getGasPerPubdataByte endpoint
([#1778](#1778))
([d62dd08](d62dd08))
* **config:** Wrap sensitive urls
([#1828](#1828))
([c8ee740](c8ee740))
* **db:** Implement weak references to RocksDB
([e0d4daa](e0d4daa))
* **en:** Add pruning health checks and rework pruning config
([#1790](#1790))
([e0d4daa](e0d4daa))
* Extract proof_data_handler into separate crate
([#1677](#1677))
([f4facee](f4facee))
* Extract several crates from zksync_core
([#1859](#1859))
([7dcf796](7dcf796))
* **node:** Extract genesis into separate crate
([#1797](#1797))
([a8c4599](a8c4599))
* **Prover CLI:** `status batch` command
([#1638](#1638))
([3fd6d65](3fd6d65))
* prover components versioning
([#1660](#1660))
([29a4ffc](29a4ffc))
* Update provers current version
([#1872](#1872))
([bb5f129](bb5f129))


### Bug Fixes

* **basic_types:** bincode deserialization for `L2ChainId`
([#1835](#1835))
([fde85f4](fde85f4))
* **contract-verifier:** YUL system-mode verification
([#1863](#1863))
([5aa7d41](5aa7d41))
* **loadtest:** Do not initiate transactions with 0 amount
([#1847](#1847))
([1bbe108](1bbe108))


### Performance Improvements

* **db:** Fine-tune state keeper cache performance / RAM usage
([#1804](#1804))
([82bf40e](82bf40e))
* **state-keeper:** Improve `FilterWrittenSlots` l1 batch seal stage
([#1854](#1854))
([4cf235f](4cf235f))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: perekopskiy <mikeson.dp@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@popzxc popzxc popzxc approved these changes

@RomanBrodetski RomanBrodetski Awaiting requested review from RomanBrodetski

@Deniallugo Deniallugo Awaiting requested review from Deniallugo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@slowli @popzxc