This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
The following commit(s) were added to refs/heads/master by this push:
new 9b8dc4d JAMES-3680 Provide a XUserAuthenticationStrategy (#784)
9b8dc4d is described below
commit 9b8dc4d75a009e710984e85046d7514b92a69cc5
Author: Benoit TELLIER <[email protected]>
AuthorDate: Fri Dec 10 09:44:45 2021 +0700
JAMES-3680 Provide a XUserAuthenticationStrategy (#784)
This could be used by API gateways to be
responsible of authentication and propagate it
to the James server.
We plan on relying on such mechanism to
integrate James JMAP endpoints with OIDC.
---
.../jmap/http/XUserAuthenticationStrategyTest.java | 104 +++++++++++++++++++++
.../jmap/http/XUserAuthenticationStrategy.java | 78 ++++++++++++++++
2 files changed, 182 insertions(+)
diff --git
a/server/protocols/jmap-draft/src/test/java/org/apache/james/jmap/http/XUserAuthenticationStrategyTest.java
b/server/protocols/jmap-draft/src/test/java/org/apache/james/jmap/http/XUserAuthenticationStrategyTest.java
new file mode 100644
index 0000000..65ce5ed
--- /dev/null
+++
b/server/protocols/jmap-draft/src/test/java/org/apache/james/jmap/http/XUserAuthenticationStrategyTest.java
@@ -0,0 +1,104 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ ****************************************************************/
+package org.apache.james.jmap.http;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import org.apache.james.dnsservice.api.DNSService;
+import org.apache.james.domainlist.lib.DomainListConfiguration;
+import org.apache.james.domainlist.memory.MemoryDomainList;
+import org.apache.james.jmap.exceptions.UnauthorizedException;
+import org.apache.james.mailbox.MailboxManager;
+import org.apache.james.mailbox.MailboxSession;
+import org.apache.james.user.memory.MemoryUsersRepository;
+import org.junit.Before;
+import org.junit.Test;
+
+import io.netty.handler.codec.http.HttpHeaders;
+import reactor.netty.http.server.HttpServerRequest;
+
+public class XUserAuthenticationStrategyTest {
+ private XUserAuthenticationStrategy testee;
+ private HttpServerRequest mockedRequest;
+ private HttpHeaders mockedHeaders;
+
+ @Before
+ public void setup() throws Exception {
+ MailboxManager mockedMailboxManager = mock(MailboxManager.class);
+ mockedRequest = mock(HttpServerRequest.class);
+ mockedHeaders = mock(HttpHeaders.class);
+
+ DNSService dnsService = mock(DNSService.class);
+ MemoryDomainList domainList = new MemoryDomainList(dnsService);
+ domainList.configure(DomainListConfiguration.DEFAULT);
+ MemoryUsersRepository usersRepository =
MemoryUsersRepository.withVirtualHosting(domainList);
+
+ MailboxSession fakeMailboxSession = mock(MailboxSession.class);
+ when(mockedMailboxManager.createSystemSession(any()))
+ .thenReturn(fakeMailboxSession);
+
+ when(mockedRequest.requestHeaders())
+ .thenReturn(mockedHeaders);
+
+ testee = new XUserAuthenticationStrategy(usersRepository,
mockedMailboxManager);
+ }
+
+ @Test
+ public void createMailboxSessionShouldReturnEmptyWhenHeaderIsEmpty() {
+ when(mockedHeaders.get("X-User"))
+ .thenReturn("");
+
+ assertThat(testee.createMailboxSession(mockedRequest).blockOptional())
+ .isEmpty();
+ }
+
+ @Test
+ public void createMailboxSessionShouldReturnEmptyWhenHeaderIsNull() {
+ when(mockedHeaders.get("X-User"))
+ .thenReturn(null);
+
+ assertThat(testee.createMailboxSession(mockedRequest).blockOptional())
+ .isEmpty();
+ }
+
+
+ @Test
+ public void createMailboxSessionShouldFailWhenInvalidUser() {
+ when(mockedHeaders.get("X-User"))
+ .thenReturn("btellier"); // invalid because virtual hosting is
turned on
+
+ assertThatThrownBy(() ->
testee.createMailboxSession(mockedRequest).blockOptional())
+ .isInstanceOf(UnauthorizedException.class);
+ }
+
+
+ @Test
+ public void createMailboxSessionShouldReturnSessionWhenValid() {
+ when(mockedHeaders.get("X-User"))
+ .thenReturn("btellier@localhost");
+
+ assertThat(testee.createMailboxSession(mockedRequest).blockOptional())
+ .get()
+ .isInstanceOf(MailboxSession.class);
+ }
+}
diff --git
a/server/protocols/jmap/src/main/java/org/apache/james/jmap/http/XUserAuthenticationStrategy.java
b/server/protocols/jmap/src/main/java/org/apache/james/jmap/http/XUserAuthenticationStrategy.java
new file mode 100644
index 0000000..0847a0f
--- /dev/null
+++
b/server/protocols/jmap/src/main/java/org/apache/james/jmap/http/XUserAuthenticationStrategy.java
@@ -0,0 +1,78 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ ****************************************************************/
+
+package org.apache.james.jmap.http;
+
+import java.util.Optional;
+
+import javax.inject.Inject;
+
+import org.apache.james.core.Username;
+import org.apache.james.jmap.exceptions.UnauthorizedException;
+import org.apache.james.mailbox.MailboxManager;
+import org.apache.james.mailbox.MailboxSession;
+import org.apache.james.user.api.UsersRepository;
+import org.apache.james.user.api.UsersRepositoryException;
+
+import com.google.common.collect.ImmutableMap;
+
+import reactor.core.publisher.Mono;
+import reactor.netty.http.server.HttpServerRequest;
+
+public class XUserAuthenticationStrategy implements AuthenticationStrategy {
+ private static final String X_USER_HEADER_NAME = "X-User";
+ private static final AuthenticationChallenge X_USER_CHALLENGE =
AuthenticationChallenge.of(
+ AuthenticationScheme.of("XUserHeader"),
+ ImmutableMap.of());
+
+ private final UsersRepository usersRepository;
+ private final MailboxManager mailboxManager;
+
+ @Inject
+ public XUserAuthenticationStrategy(UsersRepository usersRepository,
MailboxManager mailboxManager) {
+ this.usersRepository = usersRepository;
+ this.mailboxManager = mailboxManager;
+ }
+
+ @Override
+ public Mono<MailboxSession> createMailboxSession(HttpServerRequest
httpRequest) {
+ return
Optional.ofNullable(httpRequest.requestHeaders().get(X_USER_HEADER_NAME))
+ .map(String::trim)
+ .filter(s -> !s.isEmpty())
+ .map(Username::of)
+ .map(this::createMailboxSession)
+ .orElse(Mono.empty());
+ }
+
+ private Mono<MailboxSession> createMailboxSession(Username username) {
+ return Mono.fromCallable(() -> {
+ try {
+ usersRepository.assertValid(username);
+ } catch (UsersRepositoryException e) {
+ throw new UnauthorizedException("Invalid username", e);
+ }
+ return mailboxManager.createSystemSession(username);
+ });
+ }
+
+ @Override
+ public AuthenticationChallenge correspondingChallenge() {
+ return X_USER_CHALLENGE;
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
