/*
 * Copyright (c) 2018, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. 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.wso2.carbon.identity.oauth2.client.authentication;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.oltu.oauth2.common.OAuth;
import org.wso2.carbon.identity.oauth.common.exception.InvalidOAuthClientException;
import org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception;
import org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext;
import org.wso2.carbon.identity.oauth2.util.OAuth2Util;

import javax.servlet.http.HttpServletRequest;
import java.util.List;
import java.util.Map;

/**
 * This class is dedicated for authenticating 'Public Clients'. Public clients do not need a client secret to be
 * authenticated. This type of authentication is regularly utilised by native OAuth2 clients.
 */
public class PublicClientAuthenticator extends AbstractOAuthClientAuthenticator {

    private static Log log = LogFactory.getLog(PublicClientAuthenticator.class);

    /**
     * Returns the execution order of this authenticator.
     *
     * @return Execution place within the order.
     */
    @Override
    public int getPriority() {

        return 200;
    }

    /**
     * Authenticates the client.
     *
     * @param request                 HttpServletRequest which is the incoming request.
     * @param bodyParams              Body parameter map of the request.
     * @param oAuthClientAuthnContext OAuth client authentication context.
     * @return Whether the authentication is successful or not.
     * @throws OAuthClientAuthnException
     */
    @Override
    public boolean authenticateClient(HttpServletRequest request, Map<String, List> bodyParams, OAuthClientAuthnContext
            oAuthClientAuthnContext) {

        return true;
    }

    /**
     * Returns whether the incoming request can be authenticated or not using the given inputs.
     *
     * @param request    HttpServletRequest which is the incoming request.
     * @param bodyParams Body parameters present in the request.
     * @param context    OAuth2 client authentication context.
     * @return True if can be authenticated, False otherwise.
     */
    @Override
    public boolean canAuthenticate(HttpServletRequest request, Map<String, List> bodyParams, OAuthClientAuthnContext
            context) {

        String clientId = getClientId(request, bodyParams, context);

        try {
            if (isClientIdExistsAsParams(bodyParams)) {
                if (canBypassClientCredentials(context.getClientId())) {
                    if (clientId != null) {
                        context.setClientId(clientId);
                    }
                    return true;
                } else {
                    log.error("The Application (Service Provider) with client ID : " + clientId +
                            " has not enabled the option \"Allow authentication without the client secret\" " +
                            "and no valid Authorization Header exists in the request.");
                }
            } else {
                log.error("Application with the given client ID " + clientId + "is not found");
            }
        } catch (InvalidOAuthClientException e) {
            if (log.isDebugEnabled()) {
                log.debug("Error in retrieving an Application (Service Provider) with client ID : " + clientId, e);
            }
        } catch (IdentityOAuth2Exception e) {
            if (log.isDebugEnabled()) {
                log.debug("Error in Application (Service Provider) with client ID : " + clientId, e);
            }
        }

        if (log.isDebugEnabled()) {
            log.debug("The Client ID is not present in the request.");
        }

        return false;
    }

    /**
     * Get the name of the OAuth2 client authenticator.
     *
     * @return The name of the OAuth2 client authenticator.
     */
    @Override
    public String getName() {

        return "PublicClientAuthenticator";
    }

    /**
     * Retrieves the client ID which is extracted from incoming request.
     *
     * @param request                 HttpServletRequest.
     * @param bodyParams              Body paarameter map of the incoming request.
     * @param oAuthClientAuthnContext OAuthClientAuthentication context.
     * @return Client ID of the OAuth2 client.
     * @throws OAuthClientAuthnException OAuth client authentication exception.
     */
    @Override
    public String getClientId(HttpServletRequest request, Map<String, List> bodyParams, OAuthClientAuthnContext
            oAuthClientAuthnContext) {

        setClientCredentialsFromParam(bodyParams, oAuthClientAuthnContext);
        return oAuthClientAuthnContext.getClientId();
    }

    /**
     * Checks if the client can bypass credentials.
     *
     * @param clientId Client ID
     * @return True is the client can bypass credentials, False otherwise.
     * @throws IdentityOAuth2Exception OAuth2 exception.
     * @throws InvalidOAuthClientException Invalid OAuth2 client exception.
     */
    private boolean canBypassClientCredentials(String clientId) throws IdentityOAuth2Exception,
            InvalidOAuthClientException {

        return OAuth2Util.getAppInformationByClientId(clientId).isBypassClientCredentials();
    }

    /**
     * Checks for the client ID in body parameters.
     *
     * @param contentParam Request body parameters.
     * @return True if client ID exists as a body parameter, false otherwise.
     */
    private boolean isClientIdExistsAsParams(Map<String, List> contentParam) {

        Map<String, String> stringContent = getBodyParameters(contentParam);
        return (StringUtils.isNotEmpty(stringContent.get(OAuth.OAUTH_CLIENT_ID)));
    }


    /**
     * Sets client id from body parameters to the OAuth client authentication context.
     *
     * @param params Body parameters of the incoming request.
     * @param context      OAuth client authentication context.
     */
    private void setClientCredentialsFromParam(Map<String, List> params, OAuthClientAuthnContext context) {

        Map<String, String> stringContent = getBodyParameters(params);
        context.setClientId(stringContent.get(OAuth.OAUTH_CLIENT_ID));
    }

}

@@ -3894,61 +3894,17 @@
     
-if (log.isDebugEnabled()) %7B%0A                log.debug
+log.error
 (%22Er
@@ -3986,38 +3986,24 @@
 ientId, e);%0A
-            %7D%0A
         %7D ca
@@ -4052,61 +4052,17 @@
     
-if (log.isDebugEnabled()) %7B%0A                log.debug
+log.error
 (%22Er
@@ -4134,30 +4134,16 @@
 Id, e);%0A
-            %7D%0A
         

Refactor log messages