public inbox for linux-fscrypt@vger.kernel.org
 help / color / mirror / Atom feed
From: Jeff Layton <jlayton@kernel.org>
To: ceph-devel@vger.kernel.org
Cc: linux-fscrypt@vger.kernel.org, linux-fsdevel@vger.kernel.org
Subject: [PATCH 03/36] fscrypt: export fscrypt_fname_encrypt and fscrypt_fname_encrypted_size
Date: Thu,  9 Dec 2021 10:36:14 -0500	[thread overview]
Message-ID: <20211209153647.58953-4-jlayton@kernel.org> (raw)
In-Reply-To: <20211209153647.58953-1-jlayton@kernel.org>

For ceph, we want to use our own scheme for handling filenames that are
are longer than NAME_MAX after encryption and base64 encoding. This
allows us to have a consistent view of the encrypted filenames for
clients that don't support fscrypt and clients that do but that don't
have the key.

Currently, fs/crypto only supports encrypting filenames using
fscrypt_setup_filename, but that also handles encoding nokey names. Ceph
can't use that because it handles nokey names in a different way.

Export fscrypt_fname_encrypt. Rename fscrypt_fname_encrypted_size to
__fscrypt_fname_encrypted_size and add a new wrapper called
fscrypt_fname_encrypted_size that takes an inode argument rather than a
pointer to a fscrypt_policy union.

Signed-off-by: Jeff Layton <jlayton@kernel.org>
---
 fs/crypto/fname.c           | 32 +++++++++++++++++++++++++++-----
 fs/crypto/fscrypt_private.h |  9 +++------
 fs/crypto/hooks.c           |  6 +++---
 include/linux/fscrypt.h     |  4 ++++
 4 files changed, 37 insertions(+), 14 deletions(-)

diff --git a/fs/crypto/fname.c b/fs/crypto/fname.c
index 8fa23d525b5c..3be04b5aa570 100644
--- a/fs/crypto/fname.c
+++ b/fs/crypto/fname.c
@@ -130,6 +130,7 @@ int fscrypt_fname_encrypt(const struct inode *inode, const struct qstr *iname,
 
 	return 0;
 }
+EXPORT_SYMBOL(fscrypt_fname_encrypt);
 
 /**
  * fname_decrypt() - decrypt a filename
@@ -257,9 +258,9 @@ int fscrypt_base64url_decode(const char *src, int srclen, u8 *dst)
 }
 EXPORT_SYMBOL(fscrypt_base64url_decode);
 
-bool fscrypt_fname_encrypted_size(const union fscrypt_policy *policy,
-				  u32 orig_len, u32 max_len,
-				  u32 *encrypted_len_ret)
+bool __fscrypt_fname_encrypted_size(const union fscrypt_policy *policy,
+				    u32 orig_len, u32 max_len,
+				    u32 *encrypted_len_ret)
 {
 	int padding = 4 << (fscrypt_policy_flags(policy) &
 			    FSCRYPT_POLICY_FLAGS_PAD_MASK);
@@ -273,6 +274,28 @@ bool fscrypt_fname_encrypted_size(const union fscrypt_policy *policy,
 	return true;
 }
 
+/**
+ * fscrypt_fname_encrypted_size() - calculate length of encrypted filename
+ * @inode: 		parent inode of dentry name being encrypted
+ * @orig_len:		length of the original filename
+ * @max_len:		maximum length to return
+ * @encrypted_len_ret:	where calculated length should be returned (on success)
+ *
+ * Filenames must be padded out to at least the end of an fscrypt block before
+ * encrypting them. This calculates the length of an encrypted filename.
+ *
+ * Return: false if the orig_len is shorter than max_len. Otherwise, true and
+ * 	   fill out encrypted_len_ret with the length (up to max_len).
+ */
+bool fscrypt_fname_encrypted_size(const struct inode *inode, u32 orig_len,
+				  u32 max_len, u32 *encrypted_len_ret)
+{
+	return __fscrypt_fname_encrypted_size(&inode->i_crypt_info->ci_policy,
+					      orig_len, max_len,
+					      encrypted_len_ret);
+}
+EXPORT_SYMBOL(fscrypt_fname_encrypted_size);
+
 /**
  * fscrypt_fname_alloc_buffer() - allocate a buffer for presented filenames
  * @max_encrypted_len: maximum length of encrypted filenames the buffer will be
@@ -428,8 +451,7 @@ int fscrypt_setup_filename(struct inode *dir, const struct qstr *iname,
 		return ret;
 
 	if (fscrypt_has_encryption_key(dir)) {
-		if (!fscrypt_fname_encrypted_size(&dir->i_crypt_info->ci_policy,
-						  iname->len, NAME_MAX,
+		if (!fscrypt_fname_encrypted_size(dir, iname->len, NAME_MAX,
 						  &fname->crypto_buf.len))
 			return -ENAMETOOLONG;
 		fname->crypto_buf.name = kmalloc(fname->crypto_buf.len,
diff --git a/fs/crypto/fscrypt_private.h b/fs/crypto/fscrypt_private.h
index 5b0a9e6478b5..51e42767dbd6 100644
--- a/fs/crypto/fscrypt_private.h
+++ b/fs/crypto/fscrypt_private.h
@@ -297,14 +297,11 @@ void fscrypt_generate_iv(union fscrypt_iv *iv, u64 lblk_num,
 			 const struct fscrypt_info *ci);
 
 /* fname.c */
-int fscrypt_fname_encrypt(const struct inode *inode, const struct qstr *iname,
-			  u8 *out, unsigned int olen);
-bool fscrypt_fname_encrypted_size(const union fscrypt_policy *policy,
-				  u32 orig_len, u32 max_len,
-				  u32 *encrypted_len_ret);
+bool __fscrypt_fname_encrypted_size(const union fscrypt_policy *policy,
+				    u32 orig_len, u32 max_len,
+                                    u32 *encrypted_len_ret);
 
 /* hkdf.c */
-
 struct fscrypt_hkdf {
 	struct crypto_shash *hmac_tfm;
 };
diff --git a/fs/crypto/hooks.c b/fs/crypto/hooks.c
index af74599ae1cf..7c01025879b3 100644
--- a/fs/crypto/hooks.c
+++ b/fs/crypto/hooks.c
@@ -228,9 +228,9 @@ int fscrypt_prepare_symlink(struct inode *dir, const char *target,
 	 * counting it (even though it is meaningless for ciphertext) is simpler
 	 * for now since filesystems will assume it is there and subtract it.
 	 */
-	if (!fscrypt_fname_encrypted_size(policy, len,
-					  max_len - sizeof(struct fscrypt_symlink_data),
-					  &disk_link->len))
+	if (!__fscrypt_fname_encrypted_size(policy, len,
+					    max_len - sizeof(struct fscrypt_symlink_data),
+					    &disk_link->len))
 		return -ENAMETOOLONG;
 	disk_link->len += sizeof(struct fscrypt_symlink_data);
 
diff --git a/include/linux/fscrypt.h b/include/linux/fscrypt.h
index 671181d196a8..c90e176b5843 100644
--- a/include/linux/fscrypt.h
+++ b/include/linux/fscrypt.h
@@ -308,8 +308,12 @@ void fscrypt_free_inode(struct inode *inode);
 int fscrypt_drop_inode(struct inode *inode);
 
 /* fname.c */
+int fscrypt_fname_encrypt(const struct inode *inode, const struct qstr *iname,
+			  u8 *out, unsigned int olen);
 int fscrypt_base64url_encode(const u8 *src, int len, char *dst);
 int fscrypt_base64url_decode(const char *src, int len, u8 *dst);
+bool fscrypt_fname_encrypted_size(const struct inode *inode, u32 orig_len,
+				  u32 max_len, u32 *encrypted_len_ret);
 int fscrypt_setup_filename(struct inode *inode, const struct qstr *iname,
 			   int lookup, struct fscrypt_name *fname);
 
-- 
2.33.1


  parent reply	other threads:[~2021-12-09 15:36 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-09 15:36 [PATCH 00/36] ceph+fscrypt: context, filename, symlink and size handling support Jeff Layton
2021-12-09 15:36 ` [PATCH 01/36] vfs: export new_inode_pseudo Jeff Layton
2021-12-09 15:36 ` [PATCH 02/36] fscrypt: export fscrypt_base64url_encode and fscrypt_base64url_decode Jeff Layton
2021-12-10 19:10   ` Eric Biggers
2021-12-13  8:17   ` Christoph Hellwig
2021-12-09 15:36 ` Jeff Layton [this message]
2021-12-10 19:32   ` [PATCH 03/36] fscrypt: export fscrypt_fname_encrypt and fscrypt_fname_encrypted_size Eric Biggers
2021-12-09 15:36 ` [PATCH 04/36] fscrypt: add fscrypt_context_for_new_inode Jeff Layton
2021-12-10 19:40   ` Eric Biggers
2021-12-09 15:36 ` [PATCH 05/36] fscrypt: uninline and export fscrypt_require_key Jeff Layton
2021-12-10 19:46   ` Eric Biggers
2021-12-10 20:40     ` Jeff Layton
2021-12-12 19:56       ` Eric Biggers
2021-12-12 20:38         ` Jeff Layton
2021-12-12 21:03           ` Eric Biggers
2021-12-15 12:10             ` Jeff Layton
2021-12-09 15:36 ` [PATCH 06/36] ceph: preallocate inode for ops that may create one Jeff Layton
2021-12-09 15:36 ` [PATCH 07/36] ceph: crypto context handling for ceph Jeff Layton
2021-12-09 15:36 ` [PATCH 08/36] ceph: parse new fscrypt_auth and fscrypt_file fields in inode traces Jeff Layton
2021-12-09 15:36 ` [PATCH 09/36] ceph: add fscrypt_* handling to caps.c Jeff Layton
2021-12-09 15:36 ` [PATCH 10/36] ceph: add ability to set fscrypt_auth via setattr Jeff Layton
2021-12-09 15:36 ` [PATCH 11/36] ceph: implement -o test_dummy_encryption mount option Jeff Layton
2021-12-09 15:36 ` [PATCH 12/36] ceph: decode alternate_name in lease info Jeff Layton
2021-12-09 15:36 ` [PATCH 13/36] ceph: add fscrypt ioctls Jeff Layton
2021-12-09 15:36 ` [PATCH 14/36] ceph: make ceph_msdc_build_path use ref-walk Jeff Layton
2021-12-09 15:36 ` [PATCH 15/36] ceph: add encrypted fname handling to ceph_mdsc_build_path Jeff Layton
2021-12-09 15:36 ` [PATCH 16/36] ceph: send altname in MClientRequest Jeff Layton
2021-12-09 15:36 ` [PATCH 17/36] ceph: encode encrypted name in dentry release Jeff Layton
2021-12-09 15:36 ` [PATCH 18/36] ceph: properly set DCACHE_NOKEY_NAME flag in lookup Jeff Layton
2021-12-09 15:36 ` [PATCH 19/36] ceph: make d_revalidate call fscrypt revalidator for encrypted dentries Jeff Layton
2021-12-09 15:36 ` [PATCH 20/36] ceph: add helpers for converting names for userland presentation Jeff Layton
2021-12-09 15:36 ` [PATCH 21/36] ceph: add fscrypt support to ceph_fill_trace Jeff Layton
2021-12-09 15:36 ` [PATCH 22/36] ceph: add support to readdir for encrypted filenames Jeff Layton
2021-12-09 15:36 ` [PATCH 23/36] ceph: create symlinks with encrypted and base64-encoded targets Jeff Layton
2021-12-09 15:36 ` [PATCH 24/36] ceph: make ceph_get_name decrypt filenames Jeff Layton
2021-12-09 15:36 ` [PATCH 25/36] ceph: add a new ceph.fscrypt.auth vxattr Jeff Layton
2021-12-09 15:36 ` [PATCH 26/36] ceph: add some fscrypt guardrails Jeff Layton
2021-12-09 15:36 ` [PATCH 27/36] ceph: don't allow changing layout on encrypted files/directories Jeff Layton
2021-12-09 15:36 ` [PATCH 28/36] libceph: add CEPH_OSD_OP_ASSERT_VER support Jeff Layton
2021-12-09 15:36 ` [PATCH 29/36] ceph: size handling for encrypted inodes in cap updates Jeff Layton
2021-12-09 15:36 ` [PATCH 30/36] ceph: fscrypt_file field handling in MClientRequest messages Jeff Layton
2021-12-09 15:36 ` [PATCH 31/36] ceph: get file size from fscrypt_file when present in inode traces Jeff Layton
2021-12-09 15:36 ` [PATCH 32/36] ceph: handle fscrypt fields in cap messages from MDS Jeff Layton
2021-12-09 15:36 ` [PATCH 33/36] ceph: add __ceph_get_caps helper support Jeff Layton
2021-12-09 15:36 ` [PATCH 34/36] ceph: add __ceph_sync_read " Jeff Layton
2021-12-09 15:36 ` [PATCH 35/36] ceph: add object version support for sync read Jeff Layton
2021-12-09 15:36 ` [PATCH 36/36] ceph: add truncate size handling support for fscrypt Jeff Layton
2021-12-10  2:47 ` [PATCH 00/36] ceph+fscrypt: context, filename, symlink and size handling support Xiubo Li
2021-12-10 19:33 ` Eric Biggers
2021-12-10 20:09   ` 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=20211209153647.58953-4-jlayton@kernel.org \
    --to=jlayton@kernel.org \
    --cc=ceph-devel@vger.kernel.org \
    --cc=linux-fscrypt@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox