Files
inbuxa-server/crates/pop3/src/client.rs
T
jcoffey-dev 6a53d47106 Mark the files this fork changed (AGPL section 5(a))
The AGPL asks a modified version to carry prominent notices saying it was
modified, and giving a date. Publishing the source is the conveyance that
asks for it, so it wants doing before the repository is public rather than
at the release.

Every upstream file the fork changed now says so in its header, beneath the
notice it came with: 164 files, found by diffing against the upstream
snapshot branch rather than by guessing, so the list is what actually
differs. Files the fork wrote itself already carry their own copyright and
need nothing. Upstream's notices are untouched, which its licence requires
and which was already true.

The README says the same thing in prose, since the obligation is on the
work as a whole and not only its Rust files.

Builds unchanged: the server and the test binary both compile.
2026-09-19 23:48:35 -07:00

294 lines
12 KiB
Rust

/*
* SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <[email protected]>
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-SEL
*
* Modified by Coffey Labs in 2026 for INBUXA.
*/
use crate::{
Session, State,
protocol::{Command, Mechanism, request::Error},
};
use common::{
KV_RATE_LIMIT_IMAP,
network::{SessionResult, SessionStream},
};
use directory::Credentials;
use trc::{AddContext, SecurityEvent};
impl<T: SessionStream> Session<T> {
pub async fn ingest(&mut self, bytes: &[u8]) -> SessionResult {
trc::event!(
Pop3(trc::Pop3Event::RawInput),
SpanId = self.session_id,
Size = bytes.len(),
Contents = trc::Value::from_maybe_string(bytes),
);
let mut bytes = bytes.iter();
let mut requests = Vec::with_capacity(2);
loop {
match self.receiver.parse(&mut bytes) {
Ok(request) => {
// Group delete requests when possible
match (request, requests.last_mut()) {
(Command::Dele { msg }, Some(Ok(Command::DeleMany { msgs }))) => {
msgs.push(msg);
}
(Command::Dele { msg }, Some(Ok(Command::Dele { msg: other_msg }))) => {
let request = Ok(Command::DeleMany {
msgs: vec![*other_msg, msg],
});
requests.pop();
requests.push(request);
}
(request, _) => {
requests.push(Ok(request));
}
}
}
Err(Error::NeedsMoreData) => {
break;
}
Err(Error::Parse(err)) => {
// Check for port scanners
if matches!(&self.state, State::NotAuthenticated { .. },) {
match self.server.is_scanner_fail2banned(self.remote_addr).await {
Ok(true) => {
trc::event!(
Security(SecurityEvent::ScanBan),
SpanId = self.session_id,
RemoteIp = self.remote_addr,
Reason = "Invalid POP3 command",
);
return SessionResult::Close;
}
Ok(false) => {}
Err(err) => {
trc::error!(
err.span_id(self.session_id)
.details("Failed to check for fail2ban")
);
}
}
}
requests.push(Err(trc::Pop3Event::Error.into_err().details(err)));
}
}
}
for request in requests {
let result = match request {
Ok(command) => match self.validate_request(command).await {
Ok(command) => match command {
Command::User { name } => {
if let State::NotAuthenticated { username, .. } = &mut self.state {
let response = format!("{name} is a valid mailbox");
*username = Some(name);
self.write_ok(response)
.await
.map(|_| SessionResult::Continue)
} else {
unreachable!();
}
}
Command::Pass { string } => {
let username =
if let State::NotAuthenticated { username, .. } = &mut self.state {
username.take().unwrap()
} else {
unreachable!()
};
Box::pin(self.handle_auth(Credentials::Basic {
username,
secret: string,
mfa_token: None,
}))
.await
.map(|_| SessionResult::Continue)
}
Command::Quit => self.handle_quit().await.map(|_| SessionResult::Close),
Command::Stat => self.handle_stat().await.map(|_| SessionResult::Continue),
Command::List { msg } => {
self.handle_list(msg).await.map(|_| SessionResult::Continue)
}
Command::Retr { msg } => {
// inbuxa: ST-6: may be served by a read replica
let accounts = self
.state
.access_token()
.all_ids()
.map(|account_id| (account_id, 0))
.collect::<Vec<_>>();
store::backend::scaleout::replica::replica_read(
accounts,
self.handle_fetch(msg, None),
)
.await
.map(|_| SessionResult::Continue)
}
Command::Dele { msg } => self
.handle_dele(vec![msg])
.await
.map(|_| SessionResult::Continue),
Command::DeleMany { msgs } => self
.handle_dele(msgs)
.await
.map(|_| SessionResult::Continue),
Command::Top { msg, n } => {
// inbuxa: ST-6: may be served by a read replica
let accounts = self
.state
.access_token()
.all_ids()
.map(|account_id| (account_id, 0))
.collect::<Vec<_>>();
store::backend::scaleout::replica::replica_read(
accounts,
self.handle_fetch(msg, n.into()),
)
.await
.map(|_| SessionResult::Continue)
}
Command::Uidl { msg } => {
self.handle_uidl(msg).await.map(|_| SessionResult::Continue)
}
Command::Noop => {
trc::event!(
Pop3(trc::Pop3Event::Noop),
SpanId = self.session_id,
Elapsed = trc::Value::Duration(0)
);
self.write_ok("NOOP").await.map(|_| SessionResult::Continue)
}
Command::Rset => self.handle_rset().await.map(|_| SessionResult::Continue),
Command::Capa => self.handle_capa().await.map(|_| SessionResult::Continue),
Command::Stls => {
self.handle_stls().await.map(|_| SessionResult::UpgradeTls)
}
Command::Utf8 => self.handle_utf8().await.map(|_| SessionResult::Continue),
Command::Auth { mechanism, params } => {
Box::pin(self.handle_sasl(mechanism, params))
.await
.map(|_| SessionResult::Continue)
}
Command::Apop { .. } => Err(trc::Pop3Event::Error
.into_err()
.details("APOP not supported.")),
},
Err(err) => Err(err),
},
Err(err) => Err(err),
};
match result {
Ok(SessionResult::Continue) => (),
Ok(result) => return result,
Err(err) => {
if !self.write_err(err).await {
return SessionResult::Close;
}
}
}
}
SessionResult::Continue
}
async fn validate_request(
&self,
command: Command<String, Mechanism>,
) -> trc::Result<Command<String, Mechanism>> {
match &command {
Command::Capa | Command::Quit | Command::Noop => Ok(command),
Command::Auth {
mechanism: Mechanism::Plain,
..
}
| Command::User { .. }
| Command::Pass { .. }
| Command::Apop { .. } => {
if let State::NotAuthenticated { username, .. } = &self.state {
if self.stream.is_tls() || self.server.core.imap.allow_plain_auth {
if !matches!(command, Command::Pass { .. }) || username.is_some() {
Ok(command)
} else {
Err(trc::Pop3Event::Error
.into_err()
.details("Username was not provided."))
}
} else {
Err(trc::Pop3Event::Error
.into_err()
.details("Cannot authenticate over plain-text."))
}
} else {
Err(trc::Pop3Event::Error
.into_err()
.details("Already authenticated."))
}
}
Command::Auth { .. } => {
if let State::NotAuthenticated { .. } = &self.state {
Ok(command)
} else {
Err(trc::Pop3Event::Error
.into_err()
.details("Already authenticated."))
}
}
Command::Stls => {
if !self.stream.is_tls() {
Ok(command)
} else {
Err(trc::Pop3Event::Error
.into_err()
.details("Already in TLS mode."))
}
}
Command::List { .. }
| Command::Retr { .. }
| Command::Dele { .. }
| Command::DeleMany { .. }
| Command::Top { .. }
| Command::Uidl { .. }
| Command::Utf8
| Command::Stat
| Command::Rset => {
if let State::Authenticated { mailbox, .. } = &self.state {
if let Some(rate) = &self.server.core.imap.rate_requests {
if self
.server
.in_memory_store()
.is_rate_allowed(
KV_RATE_LIMIT_IMAP,
&mailbox.account_id.to_be_bytes(),
rate,
true,
)
.await
.caused_by(trc::location!())?
.is_none()
{
Ok(command)
} else {
Err(trc::LimitEvent::TooManyRequests.into_err())
}
} else {
Ok(command)
}
} else {
Err(trc::Pop3Event::Error
.into_err()
.details("Not authenticated."))
}
}
}
}
}