All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.enterprise.security.webservices.CommonServerSecurityPipe Maven / Gradle / Ivy

There is a newer version: 8.0.0-JDK17-M9
Show newest version
/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.enterprise.security.webservices;

import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.Map;

import java.security.PrivilegedExceptionAction;
import java.security.PrivilegedActionException;
import javax.security.auth.Subject;
import jakarta.security.auth.message.config.*;
import jakarta.security.auth.message.AuthException;
import jakarta.security.auth.message.AuthStatus;

import jakarta.xml.ws.WebServiceException;

import com.sun.enterprise.security.jmac.provider.PacketMapMessageInfo;
import com.sun.enterprise.security.jmac.provider.PacketMessageInfo;
import com.sun.enterprise.security.jmac.provider.config.PipeHelper;
import com.sun.enterprise.util.LocalStringManagerImpl;

import com.sun.xml.ws.api.pipe.Pipe;
import com.sun.xml.ws.api.pipe.PipeCloner;
import com.sun.xml.ws.api.pipe.helper.AbstractFilterPipeImpl;
import com.sun.xml.ws.api.message.Packet;


/**
 * This pipe is used to do 196 security
 */
public class CommonServerSecurityPipe extends AbstractFilterPipeImpl {

    protected static final Logger _logger = LogUtils.getLogger();

    protected static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(
        CommonServerSecurityPipe.class);

    private final boolean isHttpBinding;

    private PipeHelper helper;

    private static final String WSIT_SERVER_AUTH_CONTEXT ="com.sun.xml.wss.provider.wsit.WSITServerAuthContext";

    public CommonServerSecurityPipe(Map props, final Pipe next, boolean isHttpBinding) {
        super(next);
        props.put(PipeConstants.SECURITY_PIPE, this);
        this.helper = new PipeHelper(PipeConstants.SOAP_LAYER, props, null);
        this.isHttpBinding = isHttpBinding;
    }


    protected CommonServerSecurityPipe(CommonServerSecurityPipe that, PipeCloner cloner) {
        super(that, cloner);
        // we can share the helper for all pipes so that the remove
        // registration (in server side) can be done properly
        this.helper = that.helper;
        this.isHttpBinding = that.isHttpBinding;
    }

    /**
     * This method is called once in server side and at most one in client side.
     */
    @Override
    public void preDestroy() {
        helper.disable();
        try {
            Packet request = new Packet();
            PacketMessageInfo info = new PacketMapMessageInfo(request, new Packet());
            Subject subj = new Subject();
            ServerAuthContext sAC = helper.getServerAuthContext(info, subj);
            if (sAC != null && WSIT_SERVER_AUTH_CONTEXT.equals(sAC.getClass().getName())) {
                sAC.cleanSubject(info, subj);
            }
        } catch (Exception ex) {
            //ignore exceptions
        }
        /**
         Fix for bug 3932/4052
         */
        next.preDestroy();
    }

    /**
     * This is used in creating subsequent pipes.
     */
    @Override
    public Pipe copy(PipeCloner cloner) {
        return new CommonServerSecurityPipe(this, cloner);
    }

    @Override
    public Packet process(Packet request) {
        if (isHttpBinding) {
            return next.process(request);
        }

        Packet response;
        try {
            response = processRequest(request);
        } catch(Exception e) {
            if (_logger.isLoggable(Level.FINE)) {
                _logger.log(Level.FINE, "Failure in security pipe process", e);
            }
            response = helper.makeFaultResponse(null, e);
        }

        return response;
    }

    private Packet processRequest(Packet request) throws Exception {

        AuthStatus status = AuthStatus.SUCCESS;
        PacketMessageInfo info= new PacketMapMessageInfo(request,new Packet());
        // XXX at this time, we expect the server subject to be null
        Subject serverSubject = (Subject)
            request.invocationProperties.get(PipeConstants.SERVER_SUBJECT);

        //could change the request packet
        ServerAuthContext sAC =
            helper.getServerAuthContext(info,serverSubject);
        Subject clientSubject = getClientSubject(request);
        final Packet validatedRequest;
        try {
            if (sAC != null) {
                // client subject must not be null
                // and when return status is SUCCESS, module
                // must have called handler.handle(CallerPrincipalCallback)
                status = sAC.validateRequest(info,clientSubject,serverSubject);
            }
        } catch(Exception e) {
            _logger.log(Level.SEVERE,LogUtils.ERROR_REQUEST_VALIDATION, e);
            WebServiceException wse = new WebServiceException
                (localStrings.getLocalString
                    ("enterprise.webservice.cantValidateRequest",
                        "Cannot validate request for {0}",
                        new Object[] { helper.getModelName() }),e);

            //set status for audit
            status = AuthStatus.SEND_FAILURE;
            // if unable to determine if two-way will return empty response
            return helper.getFaultResponse
                (info.getRequestPacket(),info.getResponsePacket(),wse);

        } finally {
            validatedRequest = info.getRequestPacket();
            helper.auditInvocation(validatedRequest,status);
        }

        Packet response = null;
        if (status == AuthStatus.SUCCESS) {
            boolean authorized = false;
            try {
                helper.authorize(validatedRequest);
                authorized = true;

            } catch (Exception e) {
                // not authorized, construct fault and proceded
                response = helper.getFaultResponse
                    (validatedRequest,info.getResponsePacket(),e);
            }
            if (authorized) {

                // only do doAdPriv if SecurityManager is in effect
                if (System.getSecurityManager() == null) {
                    try {
                        // proceed to invoke the endpoint
                        response = next.process(validatedRequest);
                    } catch (Exception e) {
                        _logger.log(Level.SEVERE, LogUtils.NEXT_PIPE, e);
                        response = helper.getFaultResponse(validatedRequest, info.getResponsePacket(), e);
                    }
                } else {
                    try {
                        response = (Packet)Subject.doAsPrivileged
                            (clientSubject,new PrivilegedExceptionAction() {
                                @Override
                                public Object run() throws Exception {
                                    // proceed to invoke the endpoint
                                    return next.process(validatedRequest);
                                }
                            }, null);
                    } catch (PrivilegedActionException pae) {
                        Throwable cause = pae.getCause();
                        _logger.log(Level.SEVERE, LogUtils.NEXT_PIPE, cause);
                        response = helper.getFaultResponse
                            (validatedRequest,info.getResponsePacket(),cause);
                    }
                }
            }

            //pipes are not supposed to return a null response packet
            if (response == null) {
                WebServiceException wse = new WebServiceException
                    (localStrings.getLocalString
                        ("enterprise.webservice.nullResponsePacket",
                            "Invocation of Service {0} returned null response packet",
                            new Object[] { helper.getModelName() }));
                response = helper.getFaultResponse
                    (validatedRequest,info.getResponsePacket(),wse);
                _logger.log(Level.SEVERE, LogUtils.EXCEPTION_THROWN, wse);

            }

            // secure response, including if it is a fault
            if (sAC != null && response.getMessage() != null) {
                info.setResponsePacket(response);
                response = processResponse(info, sAC, serverSubject);
            }

        } else {
            // validateRequest did not return success
            if (_logger.isLoggable(Level.FINE)) {
                _logger.log(Level.FINE,"ws.status_validate_request", status);
            }
            // even for one-way mep, may return response with non-empty message
            response = info.getResponsePacket();
        }

        return response;
    }

    // called when secureResponse is to be called
    private Packet processResponse(PacketMessageInfo info, ServerAuthContext sAC, Subject serverSubject)
        throws Exception {

        AuthStatus status;

        try {
            status = sAC.secureResponse(info, serverSubject);
        } catch (Exception e) {
            if (e instanceof AuthException) {
                if (_logger.isLoggable(Level.INFO)) {
                    _logger.log(Level.INFO, LogUtils.ERROR_RESPONSE_SECURING, e);
                }
            } else {
                _logger.log(Level.SEVERE, LogUtils.ERROR_RESPONSE_SECURING, e);
            }

            return helper.makeFaultResponse(info.getResponsePacket(),e);
        }
        if (_logger.isLoggable(Level.FINE)) {
            _logger.log(Level.FINE,"ws.status_secure_response", status);
        }
        return info.getResponsePacket();

    }

    private static Subject getClientSubject(Packet p) {

        Subject s = null;

        if (p != null) {
            s =(Subject)
                p.invocationProperties.get(PipeConstants.CLIENT_SUBJECT);
        }
        if (s == null) {
            s = PipeHelper.getClientSubject();
            if (p != null) {
                p.invocationProperties.put(PipeConstants.CLIENT_SUBJECT,s);
            }
        }
        return s;
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy