All of lore.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 20/36] ceph: add helpers for converting names for userland presentation
Date: Thu,  9 Dec 2021 10:36:31 -0500	[thread overview]
Message-ID: <20211209153647.58953-21-jlayton@kernel.org> (raw)
In-Reply-To: <20211209153647.58953-1-jlayton@kernel.org>

Signed-off-by: Jeff Layton <jlayton@kernel.org>
---
 fs/ceph/crypto.c | 76 ++++++++++++++++++++++++++++++++++++++++++++++++
 fs/ceph/crypto.h | 41 ++++++++++++++++++++++++++
 2 files changed, 117 insertions(+)

diff --git a/fs/ceph/crypto.c b/fs/ceph/crypto.c
index 1f54e948b656..35137beb027b 100644
--- a/fs/ceph/crypto.c
+++ b/fs/ceph/crypto.c
@@ -175,3 +175,79 @@ int ceph_encode_encrypted_fname(const struct inode *parent, struct dentry *dentr
 	dout("base64-encoded ciphertext name = %.*s\n", elen, buf);
 	return elen;
 }
+
+/**
+ * ceph_fname_to_usr - convert a filename for userland presentation
+ * @fname: ceph_fname to be converted
+ * @tname: temporary name buffer to use for conversion (may be NULL)
+ * @oname: where converted name should be placed
+ * @is_nokey: set to true if key wasn't available during conversion (may be NULL)
+ *
+ * Given a filename (usually from the MDS), format it for presentation to
+ * userland. If @parent is not encrypted, just pass it back as-is.
+ *
+ * Otherwise, base64 decode the string, and then ask fscrypt to format it
+ * for userland presentation.
+ *
+ * Returns 0 on success or negative error code on error.
+ */
+int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
+		      struct fscrypt_str *oname, bool *is_nokey)
+{
+	int ret;
+	struct fscrypt_str _tname = FSTR_INIT(NULL, 0);
+	struct fscrypt_str iname;
+
+	if (!IS_ENCRYPTED(fname->dir)) {
+		oname->name = fname->name;
+		oname->len = fname->name_len;
+		return 0;
+	}
+
+	/* Sanity check that the resulting name will fit in the buffer */
+	if (fname->name_len > FSCRYPT_BASE64URL_CHARS(NAME_MAX))
+		return -EIO;
+
+	ret = __fscrypt_prepare_readdir(fname->dir);
+	if (ret)
+		return ret;
+
+	/*
+	 * Use the raw dentry name as sent by the MDS instead of
+	 * generating a nokey name via fscrypt.
+	 */
+	if (!fscrypt_has_encryption_key(fname->dir)) {
+		memcpy(oname->name, fname->name, fname->name_len);
+		oname->len = fname->name_len;
+		if (is_nokey)
+			*is_nokey = true;
+		return 0;
+	}
+
+	if (fname->ctext_len == 0) {
+		int declen;
+
+		if (!tname) {
+			ret = fscrypt_fname_alloc_buffer(NAME_MAX, &_tname);
+			if (ret)
+				return ret;
+			tname = &_tname;
+		}
+
+		declen = fscrypt_base64url_decode(fname->name, fname->name_len, tname->name);
+		if (declen <= 0) {
+			ret = -EIO;
+			goto out;
+		}
+		iname.name = tname->name;
+		iname.len = declen;
+	} else {
+		iname.name = fname->ctext;
+		iname.len = fname->ctext_len;
+	}
+
+	ret = fscrypt_fname_disk_to_usr(fname->dir, 0, 0, &iname, oname);
+out:
+	fscrypt_fname_free_buffer(&_tname);
+	return ret;
+}
diff --git a/fs/ceph/crypto.h b/fs/ceph/crypto.h
index d5e298383b3e..c2e0cbb5667b 100644
--- a/fs/ceph/crypto.h
+++ b/fs/ceph/crypto.h
@@ -13,6 +13,14 @@ struct ceph_fs_client;
 struct ceph_acl_sec_ctx;
 struct ceph_mds_request;
 
+struct ceph_fname {
+	struct inode	*dir;
+	char 		*name;		// b64 encoded, possibly hashed
+	unsigned char	*ctext;		// binary crypttext (if any)
+	u32		name_len;	// length of name buffer
+	u32		ctext_len;	// length of crypttext
+};
+
 struct ceph_fscrypt_auth {
 	__le32	cfa_version;
 	__le32	cfa_blob_len;
@@ -55,6 +63,22 @@ int ceph_fscrypt_prepare_context(struct inode *dir, struct inode *inode,
 void ceph_fscrypt_as_ctx_to_req(struct ceph_mds_request *req, struct ceph_acl_sec_ctx *as);
 int ceph_encode_encrypted_fname(const struct inode *parent, struct dentry *dentry, char *buf);
 
+static inline int ceph_fname_alloc_buffer(struct inode *parent, struct fscrypt_str *fname)
+{
+	if (!IS_ENCRYPTED(parent))
+		return 0;
+	return fscrypt_fname_alloc_buffer(NAME_MAX, fname);
+}
+
+static inline void ceph_fname_free_buffer(struct inode *parent, struct fscrypt_str *fname)
+{
+	if (IS_ENCRYPTED(parent))
+		fscrypt_fname_free_buffer(fname);
+}
+
+int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
+			struct fscrypt_str *oname, bool *is_nokey);
+
 #else /* CONFIG_FS_ENCRYPTION */
 
 static inline void ceph_fscrypt_set_ops(struct super_block *sb)
@@ -83,6 +107,23 @@ static inline int ceph_encode_encrypted_fname(const struct inode *parent,
 {
 	return -EOPNOTSUPP;
 }
+
+static inline int ceph_fname_alloc_buffer(struct inode *parent, struct fscrypt_str *fname)
+{
+	return 0;
+}
+
+static inline void ceph_fname_free_buffer(struct inode *parent, struct fscrypt_str *fname)
+{
+}
+
+static inline int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
+				    struct fscrypt_str *oname, bool *is_nokey)
+{
+	oname->name = fname->name;
+	oname->len = fname->name_len;
+	return 0;
+}
 #endif /* CONFIG_FS_ENCRYPTION */
 
 #endif
-- 
2.33.1


  parent reply	other threads:[~2021-12-09 15:37 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 ` [PATCH 03/36] fscrypt: export fscrypt_fname_encrypt and fscrypt_fname_encrypted_size Jeff Layton
2021-12-10 19:32   ` 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 ` Jeff Layton [this message]
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-21-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 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.