OneTimeTokenAuthenticationConverter.java

/*
 * Copyright 2004-present the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.security.web.authentication.ott;

import jakarta.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jspecify.annotations.Nullable;

import org.springframework.security.authentication.ott.OneTimeTokenAuthenticationToken;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.AuthenticationConverter;
import org.springframework.util.StringUtils;

/**
 * An implementation of {@link AuthenticationConverter} that detects if the request
 * contains a {@code token} parameter and constructs a
 * {@link OneTimeTokenAuthenticationToken} with it.
 *
 * @author Marcus da Coregio
 * @since 6.4
 * @see GenerateOneTimeTokenFilter
 */
public class OneTimeTokenAuthenticationConverter implements AuthenticationConverter {

	private final Log logger = LogFactory.getLog(getClass());

	@Override
	public @Nullable Authentication convert(HttpServletRequest request) {
		String token = request.getParameter("token");
		if (!StringUtils.hasText(token)) {
			this.logger.debug("No token found in request");
			return null;
		}
		return OneTimeTokenAuthenticationToken.unauthenticated(token);
	}

}