From: Jeff Layton <jlayton@kernel.org>
To: ceph-devel@vger.kernel.org
Cc: xiubli@redhat.com, lhenriques@suse.de, idryomov@gmail.com
Subject: [PATCH v14 62/64] ceph: add support for handling encrypted snapshot names
Date: Wed, 27 Apr 2022 15:13:12 -0400 [thread overview]
Message-ID: <20220427191314.222867-63-jlayton@kernel.org> (raw)
In-Reply-To: <20220427191314.222867-1-jlayton@kernel.org>
From: Luís Henriques <lhenriques@suse.de>
When creating a snapshot, the .snap directories for every subdirectory will
show the snapshot name in the "long format":
# mkdir .snap/my-snap
# ls my-dir/.snap/
_my-snap_1099511627782
Encrypted snapshots will need to be able to handle these snapshot names by
encrypting/decrypting only the snapshot part of the string ('my-snap').
Also, since the MDS prevents snapshot names to be bigger than 240 characters
it is necessary to adapt CEPH_NOHASH_NAME_MAX to accommodate this extra
limitation.
Reviewed-by: Xiubo Li <xiubli@redhat.com>
Signed-off-by: Luís Henriques <lhenriques@suse.de>
Signed-off-by: Jeff Layton <jlayton@kernel.org>
---
fs/ceph/crypto.c | 190 ++++++++++++++++++++++++++++++++++++++++-------
fs/ceph/crypto.h | 4 +-
2 files changed, 165 insertions(+), 29 deletions(-)
diff --git a/fs/ceph/crypto.c b/fs/ceph/crypto.c
index 590477d6e3ef..d23b3d1c59c5 100644
--- a/fs/ceph/crypto.c
+++ b/fs/ceph/crypto.c
@@ -189,16 +189,100 @@ void ceph_fscrypt_as_ctx_to_req(struct ceph_mds_request *req, struct ceph_acl_se
swap(req->r_fscrypt_auth, as->fscrypt_auth);
}
-int ceph_encode_encrypted_dname(const struct inode *parent, struct qstr *d_name, char *buf)
+/*
+ * User-created snapshots can't start with '_'. Snapshots that start with this
+ * character are special (hint: there aren't real snapshots) and use the
+ * following format:
+ *
+ * _<SNAPSHOT-NAME>_<INODE-NUMBER>
+ *
+ * where:
+ * - <SNAPSHOT-NAME> - the real snapshot name that may need to be decrypted,
+ * - <INODE-NUMBER> - the inode number (in decimal) for the actual snapshot
+ *
+ * This function parses these snapshot names and returns the inode
+ * <INODE-NUMBER>. 'name_len' will also bet set with the <SNAPSHOT-NAME>
+ * length.
+ */
+static struct inode *parse_longname(const struct inode *parent, const char *name,
+ int *name_len)
+{
+ struct inode *dir = NULL;
+ struct ceph_vino vino = { .snap = CEPH_NOSNAP };
+ char *inode_number;
+ char *name_end;
+ int orig_len = *name_len;
+ int ret = -EIO;
+
+ /* Skip initial '_' */
+ name++;
+ name_end = strrchr(name, '_');
+ if (!name_end) {
+ dout("Failed to parse long snapshot name: %s\n", name);
+ return ERR_PTR(-EIO);
+ }
+ *name_len = (name_end - name);
+ if (*name_len <= 0) {
+ pr_err("Failed to parse long snapshot name\n");
+ return ERR_PTR(-EIO);
+ }
+
+ /* Get the inode number */
+ inode_number = kmemdup_nul(name_end + 1,
+ orig_len - *name_len - 2,
+ GFP_KERNEL);
+ if (!inode_number)
+ return ERR_PTR(-ENOMEM);
+ ret = kstrtou64(inode_number, 10, &vino.ino);
+ if (ret) {
+ dout("Failed to parse inode number: %s\n", name);
+ dir = ERR_PTR(ret);
+ goto out;
+ }
+
+ /* And finally the inode */
+ dir = ceph_find_inode(parent->i_sb, vino);
+ if (!dir) {
+ /* This can happen if we're not mounting cephfs on the root */
+ dir = ceph_get_inode(parent->i_sb, vino, NULL);
+ if (!dir)
+ dir = ERR_PTR(-ENOENT);
+ }
+ if (IS_ERR(dir))
+ dout("Can't find inode %s (%s)\n", inode_number, name);
+
+out:
+ kfree(inode_number);
+ return dir;
+}
+
+int ceph_encode_encrypted_dname(struct inode *parent, struct qstr *d_name, char *buf)
{
+ struct inode *dir = parent;
+ struct qstr iname;
u32 len;
+ int name_len;
int elen;
int ret;
- u8 *cryptbuf;
+ u8 *cryptbuf = NULL;
+
+ iname.name = d_name->name;
+ name_len = d_name->len;
+
+ /* Handle the special case of snapshot names that start with '_' */
+ if ((ceph_snap(dir) == CEPH_SNAPDIR) && (name_len > 0) &&
+ (iname.name[0] == '_')) {
+ dir = parse_longname(parent, iname.name, &name_len);
+ if (IS_ERR(dir))
+ return PTR_ERR(dir);
+ iname.name++; /* skip initial '_' */
+ }
+ iname.len = name_len;
- if (!fscrypt_has_encryption_key(parent)) {
+ if (!fscrypt_has_encryption_key(dir)) {
memcpy(buf, d_name->name, d_name->len);
- return d_name->len;
+ elen = d_name->len;
+ goto out;
}
/*
@@ -207,18 +291,22 @@ int ceph_encode_encrypted_dname(const struct inode *parent, struct qstr *d_name,
*
* See: fscrypt_setup_filename
*/
- if (!fscrypt_fname_encrypted_size(parent, d_name->len, NAME_MAX, &len))
- return -ENAMETOOLONG;
+ if (!fscrypt_fname_encrypted_size(dir, iname.len, NAME_MAX, &len)) {
+ elen = -ENAMETOOLONG;
+ goto out;
+ }
/* Allocate a buffer appropriate to hold the result */
cryptbuf = kmalloc(len > CEPH_NOHASH_NAME_MAX ? NAME_MAX : len, GFP_KERNEL);
- if (!cryptbuf)
- return -ENOMEM;
+ if (!cryptbuf) {
+ elen = -ENOMEM;
+ goto out;
+ }
- ret = fscrypt_fname_encrypt(parent, d_name, cryptbuf, len);
+ ret = fscrypt_fname_encrypt(dir, &iname, cryptbuf, len);
if (ret) {
- kfree(cryptbuf);
- return ret;
+ elen = ret;
+ goto out;
}
/* hash the end if the name is long enough */
@@ -234,12 +322,30 @@ int ceph_encode_encrypted_dname(const struct inode *parent, struct qstr *d_name,
/* base64 encode the encrypted name */
elen = ceph_base64_encode(cryptbuf, len, buf);
- kfree(cryptbuf);
dout("base64-encoded ciphertext name = %.*s\n", elen, buf);
+
+ /* To understand the 240 limit, see CEPH_NOHASH_NAME_MAX comments */
+ WARN_ON(elen > 240);
+ if ((elen > 0) && (dir != parent)) {
+ char tmp_buf[NAME_MAX];
+
+ elen = snprintf(tmp_buf, sizeof(tmp_buf), "_%.*s_%ld",
+ elen, buf, dir->i_ino);
+ memcpy(buf, tmp_buf, elen);
+ }
+
+out:
+ kfree(cryptbuf);
+ if (dir != parent) {
+ if ((dir->i_state & I_NEW))
+ discard_new_inode(dir);
+ else
+ iput(dir);
+ }
return elen;
}
-int ceph_encode_encrypted_fname(const struct inode *parent, struct dentry *dentry, char *buf)
+int ceph_encode_encrypted_fname(struct inode *parent, struct dentry *dentry, char *buf)
{
WARN_ON_ONCE(!fscrypt_has_encryption_key(parent));
@@ -264,29 +370,42 @@ int ceph_encode_encrypted_fname(const struct inode *parent, struct dentry *dentr
int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
struct fscrypt_str *oname, bool *is_nokey)
{
- int ret;
+ struct inode *dir = fname->dir;
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;
- }
+ char *name = fname->name;
+ int name_len = fname->name_len;
+ int ret;
/* Sanity check that the resulting name will fit in the buffer */
if (fname->name_len > NAME_MAX || fname->ctext_len > NAME_MAX)
return -EIO;
- ret = __fscrypt_prepare_readdir(fname->dir);
+ /* Handle the special case of snapshot names that start with '_' */
+ if ((ceph_snap(dir) == CEPH_SNAPDIR) && (name_len > 0) &&
+ (name[0] == '_')) {
+ dir = parse_longname(dir, name, &name_len);
+ if (IS_ERR(dir))
+ return PTR_ERR(dir);
+ name++; /* skip initial '_' */
+ }
+
+ if (!IS_ENCRYPTED(dir)) {
+ oname->name = fname->name;
+ oname->len = fname->name_len;
+ ret = 0;
+ goto out_inode;
+ }
+
+ ret = __fscrypt_prepare_readdir(dir);
if (ret)
- return ret;
+ goto out_inode;
/*
* 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)) {
+ if (!fscrypt_has_encryption_key(dir)) {
if (fname->no_copy)
oname->name = fname->name;
else
@@ -294,7 +413,8 @@ int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
oname->len = fname->name_len;
if (is_nokey)
*is_nokey = true;
- return 0;
+ ret = 0;
+ goto out_inode;
}
if (fname->ctext_len == 0) {
@@ -303,11 +423,11 @@ int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
if (!tname) {
ret = fscrypt_fname_alloc_buffer(NAME_MAX, &_tname);
if (ret)
- return ret;
+ goto out_inode;
tname = &_tname;
}
- declen = ceph_base64_decode(fname->name, fname->name_len, tname->name);
+ declen = ceph_base64_decode(name, name_len, tname->name);
if (declen <= 0) {
ret = -EIO;
goto out;
@@ -319,9 +439,25 @@ int ceph_fname_to_usr(const struct ceph_fname *fname, struct fscrypt_str *tname,
iname.len = fname->ctext_len;
}
- ret = fscrypt_fname_disk_to_usr(fname->dir, 0, 0, &iname, oname);
+ ret = fscrypt_fname_disk_to_usr(dir, 0, 0, &iname, oname);
+ if (!ret && (dir != fname->dir)) {
+ char tmp_buf[CEPH_BASE64_CHARS(NAME_MAX)];
+
+ name_len = snprintf(tmp_buf, sizeof(tmp_buf), "_%.*s_%ld",
+ oname->len, oname->name, dir->i_ino);
+ memcpy(oname->name, tmp_buf, name_len);
+ oname->len = name_len;
+ }
+
out:
fscrypt_fname_free_buffer(&_tname);
+out_inode:
+ if ((dir != fname->dir) && !IS_ERR(dir)) {
+ if ((dir->i_state & I_NEW))
+ discard_new_inode(dir);
+ else
+ iput(dir);
+ }
return ret;
}
diff --git a/fs/ceph/crypto.h b/fs/ceph/crypto.h
index d1726307bdb8..c6ee993f4ec8 100644
--- a/fs/ceph/crypto.h
+++ b/fs/ceph/crypto.h
@@ -101,8 +101,8 @@ void ceph_fscrypt_free_dummy_policy(struct ceph_fs_client *fsc);
int ceph_fscrypt_prepare_context(struct inode *dir, struct inode *inode,
struct ceph_acl_sec_ctx *as);
void ceph_fscrypt_as_ctx_to_req(struct ceph_mds_request *req, struct ceph_acl_sec_ctx *as);
-int ceph_encode_encrypted_dname(const struct inode *parent, struct qstr *d_name, char *buf);
-int ceph_encode_encrypted_fname(const struct inode *parent, struct dentry *dentry, char *buf);
+int ceph_encode_encrypted_dname(struct inode *parent, struct qstr *d_name, char *buf);
+int ceph_encode_encrypted_fname(struct inode *parent, struct dentry *dentry, char *buf);
static inline int ceph_fname_alloc_buffer(struct inode *parent, struct fscrypt_str *fname)
{
--
2.35.1
next prev parent reply other threads:[~2022-04-27 19:18 UTC|newest]
Thread overview: 76+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-27 19:12 [PATCH v14 00/64] ceph+fscrypt: full support Jeff Layton
2022-04-27 19:12 ` [PATCH v14 01/64] libceph: add spinlock around osd->o_requests Jeff Layton
2022-04-27 19:12 ` [PATCH v14 02/64] libceph: define struct ceph_sparse_extent and add some helpers Jeff Layton
2022-04-27 19:12 ` [PATCH v14 03/64] libceph: add sparse read support to msgr2 crc state machine Jeff Layton
2022-04-27 19:12 ` [PATCH v14 04/64] libceph: add sparse read support to OSD client Jeff Layton
2022-04-27 19:12 ` [PATCH v14 05/64] libceph: support sparse reads on msgr2 secure codepath Jeff Layton
2022-04-27 19:12 ` [PATCH v14 06/64] libceph: add sparse read support to msgr1 Jeff Layton
2022-04-27 19:12 ` [PATCH v14 07/64] ceph: add new mount option to enable sparse reads Jeff Layton
2022-04-27 19:12 ` [PATCH v14 08/64] fs: change test in inode_insert5 for adding to the sb list Jeff Layton
2022-04-27 19:12 ` [PATCH v14 09/64] fscrypt: export fscrypt_fname_encrypt and fscrypt_fname_encrypted_size Jeff Layton
2022-04-27 19:12 ` [PATCH v14 10/64] fscrypt: add fscrypt_context_for_new_inode Jeff Layton
2022-04-27 19:12 ` [PATCH v14 11/64] ceph: preallocate inode for ops that may create one Jeff Layton
2022-04-27 19:12 ` [PATCH v14 12/64] ceph: fscrypt_auth handling for ceph Jeff Layton
2022-04-27 19:12 ` [PATCH v14 13/64] ceph: ensure that we accept a new context from MDS for new inodes Jeff Layton
2022-04-27 19:12 ` [PATCH v14 14/64] ceph: add support for fscrypt_auth/fscrypt_file to cap messages Jeff Layton
2022-04-27 19:12 ` [PATCH v14 15/64] ceph: implement -o test_dummy_encryption mount option Jeff Layton
2022-04-27 19:12 ` [PATCH v14 16/64] ceph: decode alternate_name in lease info Jeff Layton
2022-04-27 19:12 ` [PATCH v14 17/64] ceph: add fscrypt ioctls Jeff Layton
2022-04-27 19:12 ` [PATCH v14 18/64] ceph: make the ioctl cmd more readable in debug log Jeff Layton
2022-04-27 19:12 ` [PATCH v14 19/64] ceph: make ceph_msdc_build_path use ref-walk Jeff Layton
2022-04-27 19:12 ` [PATCH v14 20/64] ceph: add base64 endcoding routines for encrypted names Jeff Layton
2022-04-27 19:12 ` [PATCH v14 21/64] ceph: add encrypted fname handling to ceph_mdsc_build_path Jeff Layton
2022-04-27 19:12 ` [PATCH v14 22/64] ceph: send altname in MClientRequest Jeff Layton
2022-04-27 19:12 ` [PATCH v14 23/64] ceph: encode encrypted name in dentry release Jeff Layton
2022-04-27 19:12 ` [PATCH v14 24/64] ceph: properly set DCACHE_NOKEY_NAME flag in lookup Jeff Layton
2022-04-27 19:12 ` [PATCH v14 25/64] ceph: set DCACHE_NOKEY_NAME in atomic open Jeff Layton
2022-04-27 19:12 ` [PATCH v14 26/64] ceph: make d_revalidate call fscrypt revalidator for encrypted dentries Jeff Layton
2022-04-27 19:12 ` [PATCH v14 27/64] ceph: add helpers for converting names for userland presentation Jeff Layton
2022-04-27 19:12 ` [PATCH v14 28/64] ceph: fix base64 encoded name's length check in ceph_fname_to_usr() Jeff Layton
2022-04-27 19:12 ` [PATCH v14 29/64] ceph: add fscrypt support to ceph_fill_trace Jeff Layton
2022-04-27 19:12 ` [PATCH v14 30/64] ceph: pass the request to parse_reply_info_readdir() Jeff Layton
2022-04-27 19:12 ` [PATCH v14 31/64] ceph: add ceph_encode_encrypted_dname() helper Jeff Layton
2022-04-27 19:12 ` [PATCH v14 32/64] ceph: add support to readdir for encrypted filenames Jeff Layton
2022-04-27 19:12 ` [PATCH v14 33/64] ceph: create symlinks with encrypted and base64-encoded targets Jeff Layton
2022-04-27 19:12 ` [PATCH v14 34/64] ceph: make ceph_get_name decrypt filenames Jeff Layton
2022-04-27 19:12 ` [PATCH v14 35/64] ceph: add a new ceph.fscrypt.auth vxattr Jeff Layton
2022-04-27 19:12 ` [PATCH v14 36/64] ceph: add some fscrypt guardrails Jeff Layton
2022-04-27 19:12 ` [PATCH v14 37/64] ceph: don't allow changing layout on encrypted files/directories Jeff Layton
2022-04-27 19:12 ` [PATCH v14 38/64] libceph: add CEPH_OSD_OP_ASSERT_VER support Jeff Layton
2022-04-27 19:12 ` [PATCH v14 39/64] ceph: size handling for encrypted inodes in cap updates Jeff Layton
2022-04-27 19:12 ` [PATCH v14 40/64] ceph: fscrypt_file field handling in MClientRequest messages Jeff Layton
2022-04-27 19:12 ` [PATCH v14 41/64] ceph: get file size from fscrypt_file when present in inode traces Jeff Layton
2022-04-27 19:12 ` [PATCH v14 42/64] ceph: handle fscrypt fields in cap messages from MDS Jeff Layton
2022-04-27 19:12 ` [PATCH v14 43/64] ceph: update WARN_ON message to pr_warn Jeff Layton
2022-04-27 19:12 ` [PATCH v14 44/64] ceph: add __ceph_get_caps helper support Jeff Layton
2022-04-27 19:12 ` [PATCH v14 45/64] ceph: add __ceph_sync_read " Jeff Layton
2022-04-27 19:12 ` [PATCH v14 46/64] ceph: add object version support for sync read Jeff Layton
2022-04-27 19:12 ` [PATCH v14 47/64] ceph: add infrastructure for file encryption and decryption Jeff Layton
2022-04-27 19:12 ` [PATCH v14 48/64] ceph: add truncate size handling support for fscrypt Jeff Layton
2022-04-27 19:12 ` [PATCH v14 49/64] libceph: allow ceph_osdc_new_request to accept a multi-op read Jeff Layton
2022-04-27 19:13 ` [PATCH v14 50/64] ceph: disable fallocate for encrypted inodes Jeff Layton
2022-04-27 19:13 ` [PATCH v14 51/64] ceph: disable copy offload on " Jeff Layton
2022-04-27 19:13 ` [PATCH v14 52/64] ceph: don't use special DIO path for " Jeff Layton
2022-04-27 19:13 ` [PATCH v14 53/64] ceph: align data in pages in ceph_sync_write Jeff Layton
2022-04-27 19:13 ` [PATCH v14 54/64] ceph: add read/modify/write to ceph_sync_write Jeff Layton
2022-04-27 19:13 ` [PATCH v14 55/64] ceph: plumb in decryption during sync reads Jeff Layton
2022-04-27 19:13 ` [PATCH v14 56/64] ceph: add fscrypt decryption support to ceph_netfs_issue_op Jeff Layton
2022-04-27 19:13 ` [PATCH v14 57/64] ceph: set i_blkbits to crypto block size for encrypted inodes Jeff Layton
2022-04-27 19:13 ` [PATCH v14 58/64] ceph: add encryption support to writepage Jeff Layton
2022-05-05 9:34 ` Xiubo Li
2022-05-05 10:53 ` Jeff Layton
2022-05-05 11:05 ` Xiubo Li
2022-05-05 11:12 ` Jeff Layton
2022-05-05 11:27 ` Xiubo Li
2022-06-02 16:08 ` Jeff Layton
2022-06-03 9:17 ` Luís Henriques
2022-06-03 12:24 ` Jeff Layton
2022-06-03 12:48 ` Xiubo Li
2022-06-03 11:33 ` Xiubo Li
2022-04-27 19:13 ` [PATCH v14 59/64] ceph: fscrypt support for writepages Jeff Layton
2022-04-27 19:13 ` [PATCH v14 60/64] ceph: invalidate pages when doing direct/sync writes Jeff Layton
2022-04-27 19:13 ` [PATCH v14 61/64] ceph: add support for encrypted snapshot names Jeff Layton
2022-04-27 19:13 ` Jeff Layton [this message]
2022-04-27 19:13 ` [PATCH v14 63/64] ceph: update documentation regarding snapshot naming limitations Jeff Layton
2022-04-27 19:13 ` [PATCH v14 64/64] ceph: prevent snapshots to be created in encrypted locked directories Jeff Layton
2022-05-09 11:53 ` [PATCH v14 00/64] ceph+fscrypt: full support Xiubo Li
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=20220427191314.222867-63-jlayton@kernel.org \
--to=jlayton@kernel.org \
--cc=ceph-devel@vger.kernel.org \
--cc=idryomov@gmail.com \
--cc=lhenriques@suse.de \
--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.