org.qi4j.library.shiro.authc.X509CredentialsPKIXPathMatcher.java Source code

Introduction

Here is the source code for org.qi4j.library.shiro.authc.X509CredentialsPKIXPathMatcher.java

Source

/*
 * Copyright (c) 2010, Paul Merlin. All Rights Reserved.
 *
 * 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 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.qi4j.library.shiro.authc;

import java.security.GeneralSecurityException;
import java.security.cert.CertPathBuilder;
import java.security.cert.CertPathBuilderResult;
import java.security.cert.X509Certificate;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.credential.CredentialsMatcher;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.x509.CertPathReviewerException;
import org.bouncycastle.x509.ExtendedPKIXBuilderParameters;
import org.bouncycastle.x509.PKIXCertPathReviewer;
import org.qi4j.library.shiro.Shiro;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * See http://java.sun.com/javase/6/docs/technotes/guides/security/certpath/CertPathProgGuide.html for reference
 * and http://stackoverflow.com/questions/2457795/x-509-certificate-validation-with-java-and-bouncycastle/2458343
 * for a quick example using Sun API.
 * 
 * This implementation use the BouncyCastle PKIX API as it behave much better and will make CRLs support easily
 * implemented when needed.
 */
public class X509CredentialsPKIXPathMatcher implements CredentialsMatcher {

    private static final Logger LOGGER = LoggerFactory.getLogger(Shiro.LOGGER_NAME);

    public boolean doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info) {
        try {

            X509AuthenticationToken x509AuthToken = (X509AuthenticationToken) token;
            X509AuthenticationInfo x509AuthInfo = (X509AuthenticationInfo) info;

            ExtendedPKIXBuilderParameters params = new ExtendedPKIXBuilderParameters(
                    x509AuthInfo.getGrantedTrustAnchors(), x509AuthToken.getClientX509CertSelector());
            params.addStore(x509AuthToken.getClientCertChainStore());
            params.setRevocationEnabled(false);

            CertPathBuilder pathBuilder = CertPathBuilder.getInstance("PKIX", BouncyCastleProvider.PROVIDER_NAME);
            CertPathBuilderResult result = pathBuilder.build(params);

            if (LOGGER.isDebugEnabled()) {
                PKIXCertPathReviewer reviewer = new PKIXCertPathReviewer(result.getCertPath(), params);
                String certPathEnd = ((X509Certificate) reviewer.getCertPath().getCertificates()
                        .get(reviewer.getCertPathSize() - 1)).getSubjectX500Principal().getName();
                LOGGER.debug(
                        "A valid ({}) certification path (length: {}) was found for the following certificate: '{}' ending on: '{}'",
                        new Object[] { reviewer.isValidCertPath(), reviewer.getCertPathSize(),
                                x509AuthToken.getClientX509Certificate().getSubjectX500Principal().getName(),
                                certPathEnd });
            }

            return true;

        } catch (GeneralSecurityException ex) {
            LOGGER.trace("Unable to do credentials matching", ex);
            return false;
        } catch (CertPathReviewerException ex) {
            LOGGER.trace("Unable to do credentials matching", ex);
            return false;
        }
    }

}