X509CertificateKeyIdentifierQuery.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.crypto.store.wiki.internal.query;

import org.xwiki.crypto.BinaryStringEncoder;
import org.xwiki.crypto.pkix.CertificateFactory;
import org.xwiki.crypto.pkix.params.CertifiedPublicKey;
import org.xwiki.crypto.store.CertificateStoreException;
import org.xwiki.crypto.store.wiki.internal.X509CertificateWikiStore;
import org.xwiki.model.reference.EntityReference;
import org.xwiki.model.reference.EntityReferenceSerializer;
import org.xwiki.query.QueryManager;

/**
 * Query certificates in a certificate store based on subject key identifier.
 *
 * @version $Id: 953186e882d73c0dc364fa086298f6d659aa24a6 $
 * @since 6.1M2
 */
public class X509CertificateKeyIdentifierQuery extends AbstractX509KeyIdentifierQuery
{
    private static final String SELECT_STATEMENT =
        "select obj." + X509CertificateWikiStore.CERTIFICATECLASS_PROP_CERTIFICATE;

    private static final String FROM_STATEMENT = ", doc.object("
        + X509CertificateWikiStore.CERTIFICATECLASS_FULLNAME + ") obj";

    private final CertificateFactory factory;

    /**
     * Create a query selecting a certificate matching a given subject key identifier in a given store.
     *
     * @param store the reference of a document or a space where the certificate should be stored.
     * @param factory a certificate factory used to convert byte arrays to certificate.
     * @param encoder a string encoder/decoder used to convert byte arrays to/from String.
     * @param queryManager the query manager used to build queries.
     * @param serializer the entity reference serializer to serialize the store reference for query
     * @throws CertificateStoreException on error creating required queries.
     */
    public X509CertificateKeyIdentifierQuery(EntityReference store, CertificateFactory factory,
        BinaryStringEncoder encoder, QueryManager queryManager, EntityReferenceSerializer<String> serializer)
        throws CertificateStoreException
    {
        super(store, SELECT_STATEMENT, FROM_STATEMENT, "", encoder, queryManager, serializer);
        this.factory = factory;
    }

    /**
     * Get matching certificate.
     *
     * @param keyIdentifier the subject key identifier to match.
     * @return a matching certificate, or null if none were found.
     */
    public CertifiedPublicKey getCertificate(byte[] keyIdentifier)
    {
        try {
            return this.factory.decode(getEncoder().decode(this.<String>execute(keyIdentifier).get(0)));
        } catch (Exception e) {
            return null;
        }
    }

}