All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jeff Layton <jlayton@kernel.org>
To: idryomov@gmail.com, xiubli@redhat.com
Cc: ceph-devel@vger.kernel.org, linux-fsdevel@vger.kernel.org,
	linux-fscrypt@vger.kernel.org, linux-kernel@vger.kernel.org,
	lhenriques@suse.de, Eric Biggers <ebiggers@google.com>
Subject: [PATCH v13 09/59] fscrypt: export fscrypt_base64url_encode and fscrypt_base64url_decode
Date: Tue,  5 Apr 2022 15:19:40 -0400	[thread overview]
Message-ID: <20220405192030.178326-10-jlayton@kernel.org> (raw)
In-Reply-To: <20220405192030.178326-1-jlayton@kernel.org>

Ceph is going to add fscrypt support, but we still want encrypted
filenames to be composed of printable characters, so we can maintain
compatibility with clients that don't support fscrypt.

We could just adopt fscrypt's current nokey name format, but that is
subject to change in the future, and it also contains dirhash fields
that we don't need for cephfs. Because of this, we're going to concoct
our own scheme for encoding encrypted filenames. It's very similar to
fscrypt's current scheme, but doesn't bother with the dirhash fields.

The ceph encoding scheme will use base64 encoding as well, and we also
want it to avoid characters that are illegal in filenames. Export the
fscrypt base64 encoding/decoding routines so we can use them in ceph's
fscrypt implementation.

Acked-by: Eric Biggers <ebiggers@google.com>
Signed-off-by: Jeff Layton <jlayton@kernel.org>
---
 fs/crypto/fname.c       | 8 ++++----
 include/linux/fscrypt.h | 5 +++++
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/fs/crypto/fname.c b/fs/crypto/fname.c
index a9be4bc74a94..1e4233c95005 100644
--- a/fs/crypto/fname.c
+++ b/fs/crypto/fname.c
@@ -182,8 +182,6 @@ static int fname_decrypt(const struct inode *inode,
 static const char base64url_table[65] =
 	"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
 
-#define FSCRYPT_BASE64URL_CHARS(nbytes)	DIV_ROUND_UP((nbytes) * 4, 3)
-
 /**
  * fscrypt_base64url_encode() - base64url-encode some binary data
  * @src: the binary data to encode
@@ -198,7 +196,7 @@ static const char base64url_table[65] =
  * Return: the length of the resulting base64url-encoded string in bytes.
  *	   This will be equal to FSCRYPT_BASE64URL_CHARS(srclen).
  */
-static int fscrypt_base64url_encode(const u8 *src, int srclen, char *dst)
+int fscrypt_base64url_encode(const u8 *src, int srclen, char *dst)
 {
 	u32 ac = 0;
 	int bits = 0;
@@ -217,6 +215,7 @@ static int fscrypt_base64url_encode(const u8 *src, int srclen, char *dst)
 		*cp++ = base64url_table[(ac << (6 - bits)) & 0x3f];
 	return cp - dst;
 }
+EXPORT_SYMBOL_GPL(fscrypt_base64url_encode);
 
 /**
  * fscrypt_base64url_decode() - base64url-decode a string
@@ -233,7 +232,7 @@ static int fscrypt_base64url_encode(const u8 *src, int srclen, char *dst)
  * Return: the length of the resulting decoded binary data in bytes,
  *	   or -1 if the string isn't a valid base64url string.
  */
-static int fscrypt_base64url_decode(const char *src, int srclen, u8 *dst)
+int fscrypt_base64url_decode(const char *src, int srclen, u8 *dst)
 {
 	u32 ac = 0;
 	int bits = 0;
@@ -256,6 +255,7 @@ static int fscrypt_base64url_decode(const char *src, int srclen, u8 *dst)
 		return -1;
 	return bp - dst;
 }
+EXPORT_SYMBOL_GPL(fscrypt_base64url_decode);
 
 bool fscrypt_fname_encrypted_size(const union fscrypt_policy *policy,
 				  u32 orig_len, u32 max_len,
diff --git a/include/linux/fscrypt.h b/include/linux/fscrypt.h
index 50d92d805bd8..629ccd09e095 100644
--- a/include/linux/fscrypt.h
+++ b/include/linux/fscrypt.h
@@ -46,6 +46,9 @@ struct fscrypt_name {
 /* Maximum value for the third parameter of fscrypt_operations.set_context(). */
 #define FSCRYPT_SET_CONTEXT_MAX_SIZE	40
 
+/* len of resulting string (sans NUL terminator) after base64 encoding nbytes */
+#define FSCRYPT_BASE64URL_CHARS(nbytes)		DIV_ROUND_UP((nbytes) * 4, 3)
+
 #ifdef CONFIG_FS_ENCRYPTION
 
 /*
@@ -305,6 +308,8 @@ void fscrypt_free_inode(struct inode *inode);
 int fscrypt_drop_inode(struct inode *inode);
 
 /* fname.c */
+int fscrypt_base64url_encode(const u8 *src, int len, char *dst);
+int fscrypt_base64url_decode(const char *src, int len, u8 *dst);
 int fscrypt_setup_filename(struct inode *inode, const struct qstr *iname,
 			   int lookup, struct fscrypt_name *fname);
 
-- 
2.35.1


  parent reply	other threads:[~2022-04-06  5:19 UTC|newest]

Thread overview: 60+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-05 19:19 [PATCH v13 00/59] ceph+fscrypt: full support Jeff Layton
2022-04-05 19:19 ` [PATCH v13 01/59] libceph: add spinlock around osd->o_requests Jeff Layton
2022-04-05 19:19 ` [PATCH v13 02/59] libceph: define struct ceph_sparse_extent and add some helpers Jeff Layton
2022-04-05 19:19 ` [PATCH v13 03/59] libceph: add sparse read support to msgr2 crc state machine Jeff Layton
2022-04-05 19:19 ` [PATCH v13 04/59] libceph: add sparse read support to OSD client Jeff Layton
2022-04-05 19:19 ` [PATCH v13 05/59] libceph: support sparse reads on msgr2 secure codepath Jeff Layton
2022-04-05 19:19 ` [PATCH v13 06/59] libceph: add sparse read support to msgr1 Jeff Layton
2022-04-05 19:19 ` [PATCH v13 07/59] ceph: add new mount option to enable sparse reads Jeff Layton
2022-04-05 19:19 ` [PATCH v13 08/59] fs: change test in inode_insert5 for adding to the sb list Jeff Layton
2022-04-05 19:19 ` Jeff Layton [this message]
2022-04-05 19:19 ` [PATCH v13 10/59] fscrypt: export fscrypt_fname_encrypt and fscrypt_fname_encrypted_size Jeff Layton
2022-04-05 19:19 ` [PATCH v13 11/59] fscrypt: add fscrypt_context_for_new_inode Jeff Layton
2022-04-05 19:19 ` [PATCH v13 12/59] ceph: preallocate inode for ops that may create one Jeff Layton
2022-04-05 19:19 ` [PATCH v13 13/59] ceph: fscrypt_auth handling for ceph Jeff Layton
2022-04-05 19:19 ` [PATCH v13 14/59] ceph: ensure that we accept a new context from MDS for new inodes Jeff Layton
2022-04-05 19:19 ` [PATCH v13 15/59] ceph: add support for fscrypt_auth/fscrypt_file to cap messages Jeff Layton
2022-04-05 19:19 ` [PATCH v13 16/59] ceph: implement -o test_dummy_encryption mount option Jeff Layton
2022-04-05 19:19 ` [PATCH v13 17/59] ceph: decode alternate_name in lease info Jeff Layton
2022-04-05 19:19 ` [PATCH v13 18/59] ceph: add fscrypt ioctls Jeff Layton
2022-04-05 19:19 ` [PATCH v13 19/59] ceph: make the ioctl cmd more readable in debug log Jeff Layton
2022-04-05 19:19 ` [PATCH v13 20/59] ceph: make ceph_msdc_build_path use ref-walk Jeff Layton
2022-04-05 19:19 ` [PATCH v13 21/59] ceph: add encrypted fname handling to ceph_mdsc_build_path Jeff Layton
2022-04-05 19:19 ` [PATCH v13 22/59] ceph: send altname in MClientRequest Jeff Layton
2022-04-05 19:19 ` [PATCH v13 23/59] ceph: encode encrypted name in dentry release Jeff Layton
2022-04-05 19:19 ` [PATCH v13 24/59] ceph: properly set DCACHE_NOKEY_NAME flag in lookup Jeff Layton
2022-04-05 19:19 ` [PATCH v13 25/59] ceph: set DCACHE_NOKEY_NAME in atomic open Jeff Layton
2022-04-05 19:19 ` [PATCH v13 26/59] ceph: make d_revalidate call fscrypt revalidator for encrypted dentries Jeff Layton
2022-04-05 19:19 ` [PATCH v13 27/59] ceph: add helpers for converting names for userland presentation Jeff Layton
2022-04-05 19:19 ` [PATCH v13 28/59] ceph: fix base64 encoded name's length check in ceph_fname_to_usr() Jeff Layton
2022-04-05 19:20 ` [PATCH v13 29/59] ceph: add fscrypt support to ceph_fill_trace Jeff Layton
2022-04-05 19:20 ` [PATCH v13 30/59] ceph: pass the request to parse_reply_info_readdir() Jeff Layton
2022-04-05 19:20 ` [PATCH v13 31/59] ceph: add ceph_encode_encrypted_dname() helper Jeff Layton
2022-04-05 19:20 ` [PATCH v13 32/59] ceph: add support to readdir for encrypted filenames Jeff Layton
2022-04-05 19:20 ` [PATCH v13 33/59] ceph: create symlinks with encrypted and base64-encoded targets Jeff Layton
2022-04-05 19:20 ` [PATCH v13 34/59] ceph: make ceph_get_name decrypt filenames Jeff Layton
2022-04-05 19:20 ` [PATCH v13 35/59] ceph: add a new ceph.fscrypt.auth vxattr Jeff Layton
2022-04-05 19:20 ` [PATCH v13 36/59] ceph: add some fscrypt guardrails Jeff Layton
2022-04-05 19:20 ` [PATCH v13 37/59] ceph: don't allow changing layout on encrypted files/directories Jeff Layton
2022-04-05 19:20 ` [PATCH v13 38/59] libceph: add CEPH_OSD_OP_ASSERT_VER support Jeff Layton
2022-04-05 19:20 ` [PATCH v13 39/59] ceph: size handling for encrypted inodes in cap updates Jeff Layton
2022-04-05 19:20 ` [PATCH v13 40/59] ceph: fscrypt_file field handling in MClientRequest messages Jeff Layton
2022-04-05 19:20 ` [PATCH v13 41/59] ceph: get file size from fscrypt_file when present in inode traces Jeff Layton
2022-04-05 19:20 ` [PATCH v13 42/59] ceph: handle fscrypt fields in cap messages from MDS Jeff Layton
2022-04-05 19:20 ` [PATCH v13 43/59] ceph: update WARN_ON message to pr_warn Jeff Layton
2022-04-05 19:20 ` [PATCH v13 44/59] ceph: add __ceph_get_caps helper support Jeff Layton
2022-04-05 19:20 ` [PATCH v13 45/59] ceph: add __ceph_sync_read " Jeff Layton
2022-04-05 19:20 ` [PATCH v13 46/59] ceph: add object version support for sync read Jeff Layton
2022-04-05 19:20 ` [PATCH v13 47/59] ceph: add infrastructure for file encryption and decryption Jeff Layton
2022-04-05 19:20 ` [PATCH v13 48/59] ceph: add truncate size handling support for fscrypt Jeff Layton
2022-04-05 19:20 ` [PATCH v13 49/59] libceph: allow ceph_osdc_new_request to accept a multi-op read Jeff Layton
2022-04-05 19:20 ` [PATCH v13 50/59] ceph: disable fallocate for encrypted inodes Jeff Layton
2022-04-05 19:20 ` [PATCH v13 51/59] ceph: disable copy offload on " Jeff Layton
2022-04-05 19:20 ` [PATCH v13 52/59] ceph: don't use special DIO path for " Jeff Layton
2022-04-05 19:20 ` [PATCH v13 53/59] ceph: align data in pages in ceph_sync_write Jeff Layton
2022-04-05 19:20 ` [PATCH v13 54/59] ceph: add read/modify/write to ceph_sync_write Jeff Layton
2022-04-05 19:20 ` [PATCH v13 55/59] ceph: plumb in decryption during sync reads Jeff Layton
2022-04-05 19:20 ` [PATCH v13 56/59] ceph: add fscrypt decryption support to ceph_netfs_issue_op Jeff Layton
2022-04-05 19:20 ` [PATCH v13 57/59] ceph: set i_blkbits to crypto block size for encrypted inodes Jeff Layton
2022-04-05 19:20 ` [PATCH v13 58/59] ceph: add encryption support to writepage Jeff Layton
2022-04-05 19:20 ` [PATCH v13 59/59] ceph: fscrypt support for writepages Jeff Layton

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220405192030.178326-10-jlayton@kernel.org \
    --to=jlayton@kernel.org \
    --cc=ceph-devel@vger.kernel.org \
    --cc=ebiggers@google.com \
    --cc=idryomov@gmail.com \
    --cc=lhenriques@suse.de \
    --cc=linux-fscrypt@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=xiubli@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.