aerogramme/src/imap/command/authenticated.rs

573 lines
19 KiB
Rust
Raw Normal View History

2022-07-12 11:19:27 +00:00
use std::collections::BTreeMap;
2022-06-30 12:02:57 +00:00
use std::sync::Arc;
2022-07-12 14:35:11 +00:00
use anyhow::{anyhow, bail, Result};
use imap_codec::imap_types::command::{Command, CommandBody};
use imap_codec::imap_types::core::{Atom, Literal, QuotedChar};
use imap_codec::imap_types::datetime::DateTime;
2024-01-01 08:34:13 +00:00
use imap_codec::imap_types::flag::{Flag, FlagNameAttribute};
use imap_codec::imap_types::mailbox::{ListMailbox, Mailbox as MailboxCodec};
use imap_codec::imap_types::response::{Code, CodeOther, Data};
use imap_codec::imap_types::status::{StatusDataItem, StatusDataItemName};
2022-06-20 16:09:20 +00:00
2022-06-22 14:52:38 +00:00
use crate::imap::flow;
use crate::imap::mailbox_view::MailboxView;
use crate::imap::response::Response;
2022-06-29 10:52:58 +00:00
2022-07-12 14:35:11 +00:00
use crate::mail::mailbox::Mailbox;
use crate::mail::uidindex::*;
use crate::mail::user::{User, INBOX, MAILBOX_HIERARCHY_DELIMITER as MBX_HIER_DELIM_RAW};
2022-07-12 14:35:11 +00:00
use crate::mail::IMF;
2022-06-20 16:09:20 +00:00
static MAILBOX_HIERARCHY_DELIMITER: QuotedChar = QuotedChar::unvalidated(MBX_HIER_DELIM_RAW);
2022-06-29 10:50:44 +00:00
pub struct AuthenticatedContext<'a> {
pub req: &'a Command<'static>,
2022-06-30 12:02:57 +00:00
pub user: &'a Arc<User>,
2022-06-29 10:50:44 +00:00
}
2022-06-20 16:09:20 +00:00
2023-05-15 16:23:23 +00:00
pub async fn dispatch(ctx: AuthenticatedContext<'_>) -> Result<(Response, flow::Transition)> {
match &ctx.req.body {
CommandBody::Create { mailbox } => ctx.create(mailbox).await,
CommandBody::Delete { mailbox } => ctx.delete(mailbox).await,
CommandBody::Rename { from, to } => ctx.rename(from, to).await,
2022-06-22 15:26:52 +00:00
CommandBody::Lsub {
reference,
mailbox_wildcard,
2022-07-12 11:19:27 +00:00
} => ctx.list(reference, mailbox_wildcard, true).await,
2022-06-22 15:26:52 +00:00
CommandBody::List {
reference,
mailbox_wildcard,
2022-07-12 11:19:27 +00:00
} => ctx.list(reference, mailbox_wildcard, false).await,
2022-06-30 11:36:21 +00:00
CommandBody::Status {
mailbox,
item_names,
} => ctx.status(mailbox, item_names).await,
2022-07-12 11:19:27 +00:00
CommandBody::Subscribe { mailbox } => ctx.subscribe(mailbox).await,
CommandBody::Unsubscribe { mailbox } => ctx.unsubscribe(mailbox).await,
2022-06-22 15:25:04 +00:00
CommandBody::Select { mailbox } => ctx.select(mailbox).await,
CommandBody::Examine { mailbox } => ctx.examine(mailbox).await,
2022-07-12 14:35:11 +00:00
CommandBody::Append {
mailbox,
flags,
date,
message,
} => ctx.append(mailbox, flags, date, message).await,
cmd => {
tracing::warn!("Unknown command for the authenticated state {:?}", cmd);
Ok((
Response::bad()
.to_req(ctx.req)
.message("Command unavailable")
.build()?,
flow::Transition::None,
))
2022-06-29 10:50:44 +00:00
}
2022-06-20 16:09:20 +00:00
}
2022-06-22 14:52:38 +00:00
}
2022-06-20 16:09:20 +00:00
// --- PRIVATE ---
/// Convert an IMAP mailbox name/identifier representation
/// to an utf-8 string that is used internally in Aerogramme
struct MailboxName<'a>(&'a MailboxCodec<'a>);
impl<'a> TryInto<&'a str> for MailboxName<'a> {
type Error = std::str::Utf8Error;
fn try_into(self) -> Result<&'a str, Self::Error> {
match self.0 {
MailboxCodec::Inbox => Ok(INBOX),
MailboxCodec::Other(aname) => Ok(std::str::from_utf8(aname.as_ref())?),
2022-07-12 11:19:27 +00:00
}
}
}
impl<'a> AuthenticatedContext<'a> {
async fn create(self, mailbox: &MailboxCodec<'a>) -> Result<(Response, flow::Transition)> {
let name = match mailbox {
MailboxCodec::Inbox => {
return Ok((
Response::bad()
.to_req(self.req)
.message("Cannot create INBOX")
.build()?,
flow::Transition::None,
));
}
MailboxCodec::Other(aname) => std::str::from_utf8(aname.as_ref())?,
};
2022-07-12 11:19:27 +00:00
match self.user.create_mailbox(&name).await {
Ok(()) => Ok((
Response::ok()
.to_req(self.req)
.message("CREATE complete")
.build()?,
flow::Transition::None,
)),
Err(e) => Ok((
Response::no()
.to_req(self.req)
.message(&e.to_string())
.build()?,
flow::Transition::None,
)),
2022-07-12 11:19:27 +00:00
}
}
async fn delete(self, mailbox: &MailboxCodec<'a>) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(mailbox).try_into()?;
2022-07-12 11:19:27 +00:00
match self.user.delete_mailbox(&name).await {
Ok(()) => Ok((
Response::ok()
.to_req(self.req)
.message("DELETE complete")
.build()?,
flow::Transition::None,
)),
Err(e) => Ok((
Response::no()
.to_req(self.req)
.message(e.to_string())
.build()?,
flow::Transition::None,
)),
2022-07-12 11:19:27 +00:00
}
}
2022-06-30 11:36:21 +00:00
async fn rename(
self,
from: &MailboxCodec<'a>,
to: &MailboxCodec<'a>,
2022-06-30 11:36:21 +00:00
) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(from).try_into()?;
let new_name: &str = MailboxName(to).try_into()?;
2022-07-12 11:19:27 +00:00
match self.user.rename_mailbox(&name, &new_name).await {
Ok(()) => Ok((
Response::ok()
.to_req(self.req)
.message("RENAME complete")
.build()?,
flow::Transition::None,
)),
Err(e) => Ok((
Response::no()
.to_req(self.req)
.message(e.to_string())
.build()?,
flow::Transition::None,
)),
2022-07-12 11:19:27 +00:00
}
2022-06-17 16:39:36 +00:00
}
2022-06-20 16:09:20 +00:00
async fn list(
2022-06-29 10:50:44 +00:00
self,
reference: &MailboxCodec<'a>,
mailbox_wildcard: &ListMailbox<'a>,
2022-07-12 11:19:27 +00:00
is_lsub: bool,
2022-06-22 15:26:52 +00:00
) -> Result<(Response, flow::Transition)> {
let reference: &str = MailboxName(reference).try_into()?;
2022-07-12 11:19:27 +00:00
if !reference.is_empty() {
return Ok((
Response::bad()
.to_req(self.req)
.message("References not supported")
.build()?,
2022-07-12 11:19:27 +00:00
flow::Transition::None,
));
}
// @FIXME would probably need a rewrite to better use the imap_codec library
let wildcard = match mailbox_wildcard {
ListMailbox::Token(v) => std::str::from_utf8(v.as_ref())?,
ListMailbox::String(v) => std::str::from_utf8(v.as_ref())?,
};
2022-07-13 13:26:00 +00:00
if wildcard.is_empty() {
if is_lsub {
return Ok((
Response::ok()
.to_req(self.req)
.message("LSUB complete")
.data(Data::Lsub {
items: vec![],
delimiter: Some(MAILBOX_HIERARCHY_DELIMITER),
mailbox: "".try_into().unwrap(),
})
.build()?,
2022-07-13 13:26:00 +00:00
flow::Transition::None,
));
} else {
return Ok((
Response::ok()
.to_req(self.req)
.message("LIST complete")
.data(Data::List {
items: vec![],
delimiter: Some(MAILBOX_HIERARCHY_DELIMITER),
mailbox: "".try_into().unwrap(),
})
.build()?,
2022-07-13 13:26:00 +00:00
flow::Transition::None,
));
}
}
2022-07-12 11:19:27 +00:00
let mailboxes = self.user.list_mailboxes().await?;
let mut vmailboxes = BTreeMap::new();
for mb in mailboxes.iter() {
for (i, _) in mb.match_indices(MBX_HIER_DELIM_RAW) {
2022-07-12 11:19:27 +00:00
if i > 0 {
let smb = &mb[..i];
2023-05-15 16:23:23 +00:00
vmailboxes.entry(smb).or_insert(false);
2022-07-12 11:19:27 +00:00
}
}
vmailboxes.insert(mb, true);
}
let mut ret = vec![];
for (mb, is_real) in vmailboxes.iter() {
2023-05-15 16:23:23 +00:00
if matches_wildcard(&wildcard, mb) {
2022-07-12 11:19:27 +00:00
let mailbox = mb
.to_string()
.try_into()
.map_err(|_| anyhow!("invalid mailbox name"))?;
let mut items = vec![FlagNameAttribute::try_from(Atom::unvalidated(
"Subscribed",
))?];
2022-07-12 11:19:27 +00:00
if !*is_real {
items.push(FlagNameAttribute::Noselect);
}
if is_lsub {
ret.push(Data::Lsub {
items,
delimiter: Some(MAILBOX_HIERARCHY_DELIMITER),
mailbox,
});
} else {
ret.push(Data::List {
items,
delimiter: Some(MAILBOX_HIERARCHY_DELIMITER),
mailbox,
});
}
}
}
2022-07-13 09:32:47 +00:00
let msg = if is_lsub {
"LSUB completed"
} else {
"LIST completed"
};
Ok((
Response::ok()
.to_req(self.req)
.message(msg)
.set_data(ret)
.build()?,
flow::Transition::None,
))
2022-06-17 16:39:36 +00:00
}
async fn status(
self,
mailbox: &MailboxCodec<'a>,
attributes: &[StatusDataItemName],
) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(mailbox).try_into()?;
let mb_opt = self.user.open_mailbox(name).await?;
2022-07-12 13:59:13 +00:00
let mb = match mb_opt {
Some(mb) => mb,
None => {
return Ok((
Response::no()
.to_req(self.req)
.message("Mailbox does not exist")
.build()?,
2022-07-12 13:59:13 +00:00
flow::Transition::None,
))
}
};
let (view, _data) = MailboxView::new(mb).await?;
2022-07-12 11:19:27 +00:00
2022-07-12 13:59:13 +00:00
let mut ret_attrs = vec![];
for attr in attributes.iter() {
ret_attrs.push(match attr {
StatusDataItemName::Messages => StatusDataItem::Messages(view.exists()?),
StatusDataItemName::Unseen => StatusDataItem::Unseen(view.unseen_count() as u32),
StatusDataItemName::Recent => StatusDataItem::Recent(view.recent()?),
StatusDataItemName::UidNext => StatusDataItem::UidNext(view.uidnext()),
StatusDataItemName::UidValidity => {
StatusDataItem::UidValidity(view.uidvalidity())
2022-07-12 13:59:13 +00:00
}
StatusDataItemName::Deleted => {
bail!("quota not implemented, can't return deleted elements waiting for EXPUNGE");
},
StatusDataItemName::DeletedStorage => {
bail!("quota not implemented, can't return freed storage after EXPUNGE will be run");
},
2022-07-12 13:59:13 +00:00
});
}
let data = Data::Status {
2022-07-12 13:59:13 +00:00
mailbox: mailbox.clone(),
items: ret_attrs.into(),
};
2022-07-12 13:59:13 +00:00
Ok((
Response::ok()
.to_req(self.req)
.message("STATUS completed")
.data(data)
.build()?,
2022-07-12 13:59:13 +00:00
flow::Transition::None,
))
}
async fn subscribe(self, mailbox: &MailboxCodec<'a>) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(mailbox).try_into()?;
2022-07-12 11:19:27 +00:00
2022-07-12 13:59:13 +00:00
if self.user.has_mailbox(&name).await? {
Ok((
Response::ok()
.to_req(self.req)
.message("SUBSCRIBE complete")
.build()?,
flow::Transition::None,
))
2022-07-12 13:59:13 +00:00
} else {
Ok((
Response::bad()
.to_req(self.req)
.message(format!("Mailbox {} does not exist", name))
.build()?,
2022-07-12 13:59:13 +00:00
flow::Transition::None,
))
}
2022-07-12 11:19:27 +00:00
}
async fn unsubscribe(self, mailbox: &MailboxCodec<'a>) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(mailbox).try_into()?;
2022-07-12 11:19:27 +00:00
2022-07-12 13:59:13 +00:00
if self.user.has_mailbox(&name).await? {
Ok((
Response::bad()
.to_req(self.req)
.message(format!(
"Cannot unsubscribe from mailbox {}: not supported by Aerogramme",
name
))
.build()?,
2022-07-12 13:59:13 +00:00
flow::Transition::None,
))
} else {
Ok((
Response::no()
.to_req(self.req)
.message(format!("Mailbox {} does not exist", name))
.build()?,
2022-07-12 13:59:13 +00:00
flow::Transition::None,
))
}
2022-07-12 11:19:27 +00:00
}
2022-06-17 16:39:36 +00:00
/*
2022-06-22 15:26:52 +00:00
* TRACE BEGIN ---
2022-06-20 16:09:20 +00:00
2022-06-22 15:26:52 +00:00
Example: C: A142 SELECT INBOX
S: * 172 EXISTS
S: * 1 RECENT
S: * OK [UNSEEN 12] Message 12 is first unseen
S: * OK [UIDVALIDITY 3857529045] UIDs valid
S: * OK [UIDNEXT 4392] Predicted next UID
S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
S: * OK [PERMANENTFLAGS (\Deleted \Seen \*)] Limited
S: A142 OK [READ-WRITE] SELECT completed
2022-06-20 16:09:20 +00:00
2022-06-23 12:41:10 +00:00
--- a mailbox with no unseen message -> no unseen entry
NOTES:
RFC3501 (imap4rev1) says if there is no OK [UNSEEN] response, client must make no assumption,
it is therefore correct to not return it even if there are unseen messages
RFC9051 (imap4rev2) says that OK [UNSEEN] responses are deprecated after SELECT and EXAMINE
For Aerogramme, we just don't send the OK [UNSEEN], it's correct to do in both specifications.
2022-06-23 12:41:10 +00:00
20 select "INBOX.achats"
* FLAGS (\Answered \Flagged \Deleted \Seen \Draft $Forwarded JUNK $label1)
* OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft $Forwarded JUNK $label1 \*)] Flags permitted.
* 88 EXISTS
* 0 RECENT
* OK [UIDVALIDITY 1347986788] UIDs valid
* OK [UIDNEXT 91] Predicted next UID
* OK [HIGHESTMODSEQ 72] Highest
20 OK [READ-WRITE] Select completed (0.001 + 0.000 secs).
2022-06-22 15:26:52 +00:00
* TRACE END ---
*/
async fn select(self, mailbox: &MailboxCodec<'a>) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(mailbox).try_into()?;
2022-06-17 16:39:36 +00:00
let mb_opt = self.user.open_mailbox(&name).await?;
let mb = match mb_opt {
Some(mb) => mb,
None => {
return Ok((
Response::no()
.to_req(self.req)
.message("Mailbox does not exist")
.build()?,
flow::Transition::None,
))
}
};
2022-06-29 11:16:58 +00:00
tracing::info!(username=%self.user.username, mailbox=%name, "mailbox.selected");
2022-06-17 16:39:36 +00:00
let (mb, data) = MailboxView::new(mb).await?;
2022-06-24 08:27:26 +00:00
2022-06-28 07:34:24 +00:00
Ok((
Response::ok()
.message("Select completed")
.code(Code::ReadWrite)
.data(data)
.build()?,
2022-06-28 07:34:24 +00:00
flow::Transition::Select(mb),
))
2022-06-17 16:39:36 +00:00
}
async fn examine(self, mailbox: &MailboxCodec<'a>) -> Result<(Response, flow::Transition)> {
let name: &str = MailboxName(mailbox).try_into()?;
let mb_opt = self.user.open_mailbox(&name).await?;
let mb = match mb_opt {
Some(mb) => mb,
None => {
return Ok((
Response::no()
.to_req(self.req)
.message("Mailbox does not exist")
.build()?,
flow::Transition::None,
))
}
};
tracing::info!(username=%self.user.username, mailbox=%name, "mailbox.examined");
let (mb, data) = MailboxView::new(mb).await?;
Ok((
Response::ok()
.to_req(self.req)
.message("Examine completed")
.code(Code::ReadOnly)
.data(data)
.build()?,
flow::Transition::Examine(mb),
))
}
2022-07-12 14:35:11 +00:00
async fn append(
self,
mailbox: &MailboxCodec<'a>,
flags: &[Flag<'a>],
date: &Option<DateTime>,
message: &Literal<'a>,
2022-07-12 14:35:11 +00:00
) -> Result<(Response, flow::Transition)> {
let append_tag = self.req.tag.clone();
2022-07-12 14:35:11 +00:00
match self.append_internal(mailbox, flags, date, message).await {
Ok((_mb, uidvalidity, uid)) => Ok((
Response::ok()
.tag(append_tag)
.message("APPEND completed")
.code(Code::Other(CodeOther::unvalidated(
format!("APPENDUID {} {}", uidvalidity, uid).into_bytes(),
)))
.build()?,
flow::Transition::None,
)),
Err(e) => Ok((
Response::no()
.tag(append_tag)
.message(e.to_string())
.build()?,
2022-07-12 14:35:11 +00:00
flow::Transition::None,
)),
}
}
pub(crate) async fn append_internal(
self,
mailbox: &MailboxCodec<'a>,
flags: &[Flag<'a>],
date: &Option<DateTime>,
message: &Literal<'a>,
2022-07-12 14:35:11 +00:00
) -> Result<(Arc<Mailbox>, ImapUidvalidity, ImapUidvalidity)> {
let name: &str = MailboxName(mailbox).try_into()?;
2022-07-12 14:35:11 +00:00
let mb_opt = self.user.open_mailbox(&name).await?;
let mb = match mb_opt {
Some(mb) => mb,
None => bail!("Mailbox does not exist"),
};
if date.is_some() {
bail!("Cannot set date when appending message");
}
let msg =
IMF::try_from(message.data()).map_err(|_| anyhow!("Could not parse e-mail message"))?;
2022-07-12 14:35:11 +00:00
let flags = flags.iter().map(|x| x.to_string()).collect::<Vec<_>>();
// TODO: filter allowed flags? ping @Quentin
let (uidvalidity, uid) = mb.append(msg, None, &flags[..]).await?;
Ok((mb, uidvalidity, uid))
}
2022-06-20 16:09:20 +00:00
}
2022-07-13 13:26:00 +00:00
fn matches_wildcard(wildcard: &str, name: &str) -> bool {
let wildcard = wildcard.chars().collect::<Vec<char>>();
let name = name.chars().collect::<Vec<char>>();
let mut matches = vec![vec![false; wildcard.len() + 1]; name.len() + 1];
for i in 0..=name.len() {
for j in 0..=wildcard.len() {
matches[i][j] = (i == 0 && j == 0)
|| (j > 0
&& matches[i][j - 1]
&& (wildcard[j - 1] == '%' || wildcard[j - 1] == '*'))
|| (i > 0
&& j > 0
&& matches[i - 1][j - 1]
&& wildcard[j - 1] == name[i - 1]
&& wildcard[j - 1] != '%'
&& wildcard[j - 1] != '*')
|| (i > 0
&& j > 0
&& matches[i - 1][j]
&& (wildcard[j - 1] == '*'
|| (wildcard[j - 1] == '%' && name[i - 1] != MBX_HIER_DELIM_RAW)));
2022-07-13 13:26:00 +00:00
}
}
matches[name.len()][wildcard.len()]
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_wildcard_matches() {
assert!(matches_wildcard("INBOX", "INBOX"));
assert!(matches_wildcard("*", "INBOX"));
assert!(matches_wildcard("%", "INBOX"));
assert!(!matches_wildcard("%", "Test.Azerty"));
assert!(!matches_wildcard("INBOX.*", "INBOX"));
assert!(matches_wildcard("Sent.*", "Sent.A"));
assert!(matches_wildcard("Sent.*", "Sent.A.B"));
assert!(!matches_wildcard("Sent.%", "Sent.A.B"));
}
}