feat: prevent sensitive information (key, password, secrets etc.) from being printed in plain

[DevilExileSu]

I hereby agree to the terms of the GreptimeDB CLA

What's changed and what's your intention?

add secret type, SecretString and SecretBytes.

Checklist

• I have written the necessary rustdoc comments.
• I have added the necessary unit tests and integration tests.

Refer to a related PR or issue link (optional)

close #1487

[DevilExileSu]

because Bytes implements Deref, the len() and is_empty() seem to be redundant.

greptimedb/src/common/base/src/bytes.rs

Lines 23 to 31 in 7dbac89

	impl Bytes {
	pub fn len(&self) -> usize {
	self.0.len()
	}
	pub fn is_empty(&self) -> bool {
	self.0.is_empty()
	}
	}

greptimedb/src/common/base/src/bytes.rs

Lines 57 to 63 in 7dbac89

	impl Deref for Bytes {
	type Target = [u8];
	fn deref(&self) -> &[u8] {
	&self.0
	}
	}

And we can also implement Deref for BytesString.

[codecov]

Codecov Report

Merging #1501 (f408a57) into develop (7dbac89) will decrease coverage by 0.46%.
The diff coverage is 69.41%.

@@             Coverage Diff             @@
##           develop    #1501      +/-   ##
===========================================
- Coverage    85.89%   85.44%   -0.46%     
===========================================
  Files          550      550              
  Lines        82545    82600      +55     
===========================================
- Hits         70904    70574     -330     
- Misses       11641    12026     +385     

[evenyag]

I think we could use secstr to do this. @sunng87

[DevilExileSu]

I think we could use secstr to do this. @sunng87

You are right, we can use secstr or secrecy, which is more safe.

[sunng87]

Yes, it will be nice to use existing solutions.

[DevilExileSu]

The inner struct of serstr::SerStr is Vec<u8>, which requires additional processing when deserializing toml string, and needs to convert Vec<u8> into &str when constructing Instance, so I use the more convenient secrecy::SecretString

[evenyag]

The inner struct of serstr::SerStr is Vec<u8>, which requires additional processing when deserializing toml string, and needs to convert Vec<u8> into &str when constructing Instance

secstr provides a SecUtf8. But using secrecy is fine, these two crates are similar.

Bytes implements Deref, the len() and is_empty() seem to be redundant.

Oh, right, you could open a new PR for this.

we can also implement Deref for BytesString.

I'm not sure, as BytesString might hold a non-UTF-8 string in the future. But we can implement Deref first since we only support UTF-8 strings now. Once it really needs to support non-UTF-8 encoding, we must remove the Deref impl and methods that access it as str directly.

[DevilExileSu]

Thx! Got it. I'm ashamed that I didn't check the documentation for secstr carefully earlier.