Added pub key caching

cadc-gms/src/main/java/org/opencadc/auth/OIDCProviderPubKey.java

@@ -0,0 +1,135 @@
+/*
+ ************************************************************************
+ *******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
+ **************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
+ *
+ *  (c) 2024.                            (c) 2024.
+ *  Government of Canada                 Gouvernement du Canada
+ *  National Research Council            Conseil national de recherches
+ *  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
+ *  All rights reserved                  Tous droits réservés
+ *
+ *  NRC disclaims any warranties,        Le CNRC dénie toute garantie
+ *  expressed, implied, or               énoncée, implicite ou légale,
+ *  statutory, of any kind with          de quelque nature que ce
+ *  respect to the software,             soit, concernant le logiciel,
+ *  including without limitation         y compris sans restriction
+ *  any warranty of merchantability      toute garantie de valeur
+ *  or fitness for a particular          marchande ou de pertinence
+ *  purpose. NRC shall not be            pour un usage particulier.
+ *  liable in any event for any          Le CNRC ne pourra en aucun cas
+ *  damages, whether direct or           être tenu responsable de tout
+ *  indirect, special or general,        dommage, direct ou indirect,
+ *  consequential or incidental,         particulier ou général,
+ *  arising from the use of the          accessoire ou fortuit, résultant
+ *  software.  Neither the name          de l'utilisation du logiciel. Ni
+ *  of the National Research             le nom du Conseil National de
+ *  Council of Canada nor the            Recherches du Canada ni les noms
+ *  names of its contributors may        de ses  participants ne peuvent
+ *  be used to endorse or promote        être utilisés pour approuver ou
+ *  products derived from this           promouvoir les produits dérivés
+ *  software without specific prior      de ce logiciel sans autorisation
+ *  written permission.                  préalable et particulière
+ *                                       par écrit.
+ *
+ *  This file is part of the             Ce fichier fait partie du projet
+ *  OpenCADC project.                    OpenCADC.
+ *
+ *  OpenCADC is free software:           OpenCADC est un logiciel libre ;
+ *  you can redistribute it and/or       vous pouvez le redistribuer ou le
+ *  modify it under the terms of         modifier suivant les termes de
+ *  the GNU Affero General Public        la “GNU Affero General Public
+ *  License as published by the          License” telle que publiée
+ *  Free Software Foundation,            par la Free Software Foundation
+ *  either version 3 of the              : soit la version 3 de cette
+ *  License, or (at your option)         licence, soit (à votre gré)
+ *  any later version.                   toute version ultérieure.
+ *
+ *  OpenCADC is distributed in the       OpenCADC est distribué
+ *  hope that it will be useful,         dans l’espoir qu’il vous
+ *  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
+ *  without even the implied             GARANTIE : sans même la garantie
+ *  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
+ *  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
+ *  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
+ *  General Public License for           Générale Publique GNU Affero
+ *  more details.                        pour plus de détails.
+ *
+ *  You should have received             Vous devriez avoir reçu une
+ *  a copy of the GNU Affero             copie de la Licence Générale
+ *  General Public License along         Publique GNU Affero avec
+ *  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
+ *  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
+ *                                       <http://www.gnu.org/licenses/>.
+ *
+ ************************************************************************
+ */
+
+package org.opencadc.auth;
+
+import ca.nrc.cadc.reg.client.CachingFile;
+import java.io.File;
+import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URL;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import org.apache.log4j.Logger;
+
+
+/**
+ * Cache object that manages the cache file for the public keys of the OIDC Provider.
+ */
+public class OIDCProviderPubKey {
+    private static final Logger log = Logger.getLogger(OIDCProviderPubKey.class);
+    private static final String CACHE_DIRECTORY_NAME = "cadc-gms-1.0";
+    private URL jwksUrl;
+
+    final URI issuer;
+
+    public OIDCProviderPubKey(URI issuer, URL jwksUrl) {
+        if (issuer == null) {
+            throw new IllegalStateException("OIDC Issuer URI is required.");
+        }
+        if (jwksUrl == null) {
+            throw new IllegalStateException("JWKS URI is required.");
+        }
+        this.issuer = issuer;
+        this.jwksUrl = jwksUrl;
+    }
+
+    public CachingFile getCachingFile() {
+        return new CachingFile(getCachedFile(), jwksUrl);
+    }
+
+    private File getCachedFile() {
+        final Path baseCacheDir = getBaseCacheDirectory();
+        final String issuerAuthority = this.issuer.getAuthority();
+        final Path resourceCacheDir = Paths.get(baseCacheDir.toString(), issuerAuthority);
+
+        // Create a path to the cache file itself
+        final Path path = Paths.get(resourceCacheDir.toString(), this.issuer.getPath(), "jwks.json");
+        log.debug("Caching file [" + path + "] in dir [" + resourceCacheDir + "]");
+
+        return path.toFile();
+    }
+
+    private Path getBaseCacheDirectory() {
+        final String tmpDir = System.getProperty("java.io.tmpdir");
+        final String userName = System.getProperty("user.name");
+
+        if (tmpDir == null) {
+            throw new RuntimeException("No tmp system dir defined.");
+        }
+
+        final Path baseCacheDir;
+        if (userName == null) {
+            baseCacheDir = Paths.get(tmpDir, OIDCProviderPubKey.CACHE_DIRECTORY_NAME);
+        } else {
+            baseCacheDir = Paths.get(tmpDir, userName, OIDCProviderPubKey.CACHE_DIRECTORY_NAME);
+        }
+
+        log.debug("Base cache dir: " + baseCacheDir);
+        return baseCacheDir;
+    }
+}