CertificatePrincipal.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */

  21. package org.openspcoop2.utils.certificate;

  23. import java.util.ArrayList;
  24. import java.util.List;
  25. import java.util.Map;

  27. import javax.security.auth.x500.X500Principal;

  29. import org.bouncycastle.asn1.x500.RDN;
  30. import org.bouncycastle.asn1.x500.X500Name;
  31. import org.bouncycastle.asn1.x500.style.BCStyle;
  32. import org.bouncycastle.cert.selector.jcajce.JcaX509CertificateHolderSelector;
  33. import org.openspcoop2.utils.UtilsException;
  34. import org.openspcoop2.utils.regexp.RegExpNotFoundException;
  35. import org.openspcoop2.utils.regexp.RegularExpressionEngine;

  37. /**
  38.  * CertificatePrincipal
  39.  *
  40.  * @author Poli Andrea (apoli@link.it)
  41.  * @author $Author$
  42.  * @version $Rev$, $Date$
  43.  */
  44. public class CertificatePrincipal {

  46.     private X500Principal principal;
  47.     private PrincipalType type;
  48.     private X500Name x500name;

  50.     public CertificatePrincipal(X500Principal principal, PrincipalType type) {
  51.         this.principal = principal;
  52.         this.type = type;
  53.     }

  55.     @Override
  56.     public String toString() {
  57.         return this.principal.toString();
  58.     }
  59.     public String toString(String regexp) throws UtilsException {
  60.         String dn = this.toString();
  61.         return getRegexpValue(dn, regexp);
  62.     }
  63.     
  64.     public String getName() {
  65.         return this.principal.getName();
  66.     }
  67.     public String getNameByRegExp(String regexp) throws UtilsException {
  68.         String dn = this.getName();
  69.         return getRegexpValue(dn, regexp);
  70.     }
  71.     
  72.     public String getName(String format) {
  73.         return this.principal.getName(format);
  74.     }
  75.     public String getName(String format, String regexp) throws UtilsException {
  76.         String dn = this.getName(format);
  77.         return getRegexpValue(dn, regexp);
  78.     }
  79.     
  80.     public String getCanonicalName() {
  81.         return this.principal.getName(X500Principal.CANONICAL);
  82.     }
  83.     public String getCanonicalName(String regexp) throws UtilsException {
  84.         String dn = this.getCanonicalName();
  85.         return getRegexpValue(dn, regexp);
  86.     }
  87.     
  88.     public String getRFC1779Name() {
  89.         return this.principal.getName(X500Principal.RFC1779);
  90.     }
  91.     public String getRFC1779Name(String regexp) throws UtilsException {
  92.         String dn = this.getRFC1779Name();
  93.         return getRegexpValue(dn, regexp);
  94.     }
  95.     
  96.     public String getRFC2253Name() {
  97.         return this.principal.getName(X500Principal.RFC2253);
  98.     }
  99.     public String getRFC2253Name(String regexp) throws UtilsException {
  100.         String dn = this.getRFC2253Name();
  101.         return getRegexpValue(dn, regexp);
  102.     }
  103.     
  104.     public String getNameNormalized() throws UtilsException {
  105.         return CertificateUtils.formatPrincipal(this.toString(), this.type);
  106.     }
  107.     public Map<String, List<String>> toMap() throws UtilsException {
  108.         return CertificateUtils.getPrincipalIntoMap(this.toString(), this.type);
  109.     }
  110.     public Map<String, String> toSimpleMap() throws UtilsException {
  111.         return CertificateUtils.formatPrincipalToMap(this.toString(), this.type);
  112.     }
  113.     public String getNameNormalized(String regexp) throws UtilsException {
  114.         String dn = this.getNameNormalized();
  115.         return getRegexpValue(dn, regexp);
  116.     }
  117.     
  118.     
  119.     private synchronized void initX500Name() {
  120.         if(this.x500name==null) {
  121.             this.x500name=new JcaX509CertificateHolderSelector(this.principal,null).getIssuer();
  122.         }
  123.     }
  124.     
  125.     public static final String CN_EMPTY = "__undefined__";
  126.     public String getCN() {
  127.         return getInfoByOID(BCStyle.CN, CN_EMPTY);
  128.     }
  129.     public String getCN(String regexp) throws UtilsException {
  130.         String cn = this.getCN();
  131.         return getRegexpValue(cn, regexp);
  132.     }
  133.     
  134.     
  135.     private String getRegexpValue(String value, String regexp) throws UtilsException {
  136.         try {
  137.             return RegularExpressionEngine.getStringMatchPattern(value, regexp);
  138.         }catch(RegExpNotFoundException notFound) {
  139.             return null;
  140.         }catch(Exception e) {
  141.             throw new UtilsException(e.getMessage(),e);
  142.         }
  143.     }
  144.     
  145.     
  146.     
  147.     // ******* OID **********
  148.     
  149.     public List<OID> getOID(){
  150.         List<OID> l = new ArrayList<OID>();
  151.         if(this.x500name==null) {
  152.             this.initX500Name();
  153.         }
  154.         RDN [] rdnArray = this.x500name.getRDNs();
  155.         if(rdnArray!=null && rdnArray.length>0) {
  156.             for (RDN rdn : rdnArray) {
  157.                 if(rdn!=null) {
  158.                     OID oid = OID.toOID(rdn.getFirst().getType());
  159. //                  if(oid==null) {
  160. //                      System.out.println("NULLLL ["+rdn.getFirst().getType()+"]: "+rdn.getFirst().getType().getId());
  161. //                  }
  162.                     if(oid!=null) { // custom
  163.                         l.add(oid);
  164.                     }
  165.                 }
  166.             }
  167.         }
  168.         return l;
  169.     }
  170.         
  171.     public String getInfo(String oid) {
  172.         return getInfoByOID(OID.valueOf(oid.toUpperCase()));
  173.     }
  174.     public String getInfo(String oid, String defaultEmptyValue) {
  175.         return getInfoByOID(OID.valueOf(oid.toUpperCase()),defaultEmptyValue);
  176.     }
  177.     
  178.     public String getInfoByOID(String oid) {
  179.         return getInfoByOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid));
  180.     }
  181.     public String getInfoByOID(String oid, String defaultEmptyValue) {
  182.         return getInfoByOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid),defaultEmptyValue);
  183.     }
  184.     public String getInfoByOID(OID oid) {
  185.         return getInfoByOID(oid.getOID());
  186.     }
  187.     public String getInfoByOID(OID oid, String defaultEmptyValue) {
  188.         return getInfoByOID(oid.getOID(),defaultEmptyValue);
  189.     }
  190.     public String getInfoByOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid) {
  191.         return getInfoByOID(oid, null);
  192.     }
  193.     public String getInfoByOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, String defaultEmptyValue) {
  194.         if(this.x500name==null) {
  195.             this.initX500Name();
  196.         }
  197.         RDN [] rdnArray = this.x500name.getRDNs(oid);
  198.         if(rdnArray!=null && rdnArray.length>0 && rdnArray[0]!=null) {
  199.             RDN rdn = rdnArray[0];
  200.             if(rdn.getFirst()!=null && rdn.getFirst().getValue()!=null) {
  201.                 return rdn.getFirst().getValue().toString();
  202.             }
  203.             else {
  204.                 return defaultEmptyValue;
  205.             }
  206.         }
  207.         else {
  208.             return defaultEmptyValue;
  209.         }
  210.     }
  211.     
  212.     public String getInfo(String oid, int position) {
  213.         return getInfoByOID(OID.valueOf(oid.toUpperCase()), position);
  214.     }
  215.     public String getInfo(String oid, String defaultEmptyValue, int position) {
  216.         return getInfoByOID(OID.valueOf(oid.toUpperCase()),defaultEmptyValue, position);
  217.     }
  218.     
  219.     public String getInfoByOID(String oid, int position) {
  220.         return getInfoByOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid), position);
  221.     }
  222.     public String getInfoByOID(String oid, String defaultEmptyValue, int position) {
  223.         return getInfoByOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid),defaultEmptyValue, position);
  224.     }
  225.     public String getInfoByOID(OID oid, int position) {
  226.         return getInfoByOID(oid.getOID(), position);
  227.     }
  228.     public String getInfoByOID(OID oid, String defaultEmptyValue, int position) {
  229.         return getInfoByOID(oid.getOID(),defaultEmptyValue, position);
  230.     }
  231.     public String getInfoByOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, int position) {
  232.         return getInfoByOID(oid, null, position);
  233.     }
  234.     public String getInfoByOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, String defaultEmptyValue, int position) {
  235.         List<String> l = getInfosByOID(oid, defaultEmptyValue);
  236.         if(l!=null && l.size()>position) {
  237.             return l.get(position);
  238.         }
  239.         return defaultEmptyValue;
  240.     }
  241.     
  242.     public List<String> getInfos(String oid) {
  243.         return getInfosByOID(OID.valueOf(oid.toUpperCase()));
  244.     }
  245.     public List<String> getInfos(String oid, String defaultEmptyValue) {
  246.         return getInfosByOID(OID.valueOf(oid.toUpperCase()),defaultEmptyValue);
  247.     }
  248.     
  249.     public List<String> getInfosByOID(String oid) {
  250.         return getInfosByOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid));
  251.     }
  252.     public List<String> getInfosByOID(String oid, String defaultEmptyValue) {
  253.         return getInfosByOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid),defaultEmptyValue);
  254.     }
  255.     public List<String> getInfosByOID(OID oid) {
  256.         return getInfosByOID(oid.getOID());
  257.     }
  258.     public List<String> getInfosByOID(OID oid, String defaultEmptyValue) {
  259.         return getInfosByOID(oid.getOID(),defaultEmptyValue);
  260.     }
  261.     public List<String> getInfosByOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid) {
  262.         return getInfosByOID(oid, null);
  263.     }
  264.     public List<String> getInfosByOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, String defaultEmptyValue) {
  265.         if(this.x500name==null) {
  266.             this.initX500Name();
  267.         }
  268.         RDN [] rdnArray = this.x500name.getRDNs(oid);
  269.         List<String> l = null;
  270.         if(rdnArray!=null && rdnArray.length>0) {
  271.             for (RDN rdn : rdnArray) {
  272.                 if(rdn!=null && rdn.getFirst()!=null && rdn.getFirst().getValue()!=null) {
  273.                     if(l==null) {
  274.                         l = new ArrayList<>();
  275.                     }
  276.                     l.add(rdn.getFirst().getValue().toString());
  277.                 }
  278.             }
  279.         }
  280.         
  281.         if(l==null && defaultEmptyValue!=null) {
  282.             l = new ArrayList<>();
  283.             l.add(defaultEmptyValue);
  284.         }
  285.         return l;
  286.     }
  287.     
  288.     
  289.     // ******* ID OID **********
  290.     
  291.     public List<String> getIdOID(){
  292.         List<String> l = new ArrayList<>();
  293.         if(this.x500name==null) {
  294.             this.initX500Name();
  295.         }
  296.         RDN [] rdnArray = this.x500name.getRDNs();
  297.         if(rdnArray!=null && rdnArray.length>0) {
  298.             for (RDN rdn : rdnArray) {
  299.                 if(rdn!=null) {
  300.                     l.add(rdn.getFirst().getType().getId());
  301.                 }
  302.             }
  303.         }
  304.         return l;
  305.     }
  306.     
  307.     public String getInfoByIdOID(String oid) {
  308.         return getInfoByIdOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid));
  309.     }
  310.     public String getInfoByIdOID(String oid, String defaultEmptyValue) {
  311.         return getInfoByIdOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid),defaultEmptyValue);
  312.     }
  313.     public String getInfoByIdOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid) {
  314.         return getInfoByIdOID(oid, null);
  315.     }
  316.     public String getInfoByIdOID(org.bouncycastle.asn1.ASN1ObjectIdentifier idOID, String defaultEmptyValue) {
  317.         if(this.x500name==null) {
  318.             this.initX500Name();
  319.         }
  320.         RDN [] rdnArray = this.x500name.getRDNs(idOID);
  321.         if(rdnArray!=null && rdnArray.length>0 && rdnArray[0]!=null) {
  322.             RDN rdn = rdnArray[0];
  323.             if(rdn.getFirst()!=null && rdn.getFirst().getValue()!=null) {
  324.                 return rdn.getFirst().getValue().toString();
  325.             }
  326.             else {
  327.                 return defaultEmptyValue;
  328.             }
  329.         }
  330.         else {
  331.             return defaultEmptyValue;
  332.         }
  333.     }
  334.     
  335.     public String getInfoByIdOID(String oid, int position) {
  336.         return getInfoByIdOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid), position);
  337.     }
  338.     public String getInfoByIdOID(String oid, String defaultEmptyValue, int position) {
  339.         return getInfoByIdOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid),defaultEmptyValue, position);
  340.     }
  341.     public String getInfoByIdOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, int position) {
  342.         return getInfoByIdOID(oid, null, position);
  343.     }
  344.     public String getInfoByIdOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, String defaultEmptyValue, int position) {
  345.         List<String> l = getInfosByIdOID(oid, defaultEmptyValue);
  346.         if(l!=null && l.size()>position) {
  347.             return l.get(position);
  348.         }
  349.         return defaultEmptyValue;
  350.     }
  351.     
  352.     public List<String> getInfosByIdOID(String oid) {
  353.         return getInfosByIdOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid));
  354.     }
  355.     public List<String> getInfosByIdOID(String oid, String defaultEmptyValue) {
  356.         return getInfosByIdOID(new org.bouncycastle.asn1.ASN1ObjectIdentifier(oid),defaultEmptyValue);
  357.     }
  358.     public List<String> getInfosByIdOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid) {
  359.         return getInfosByIdOID(oid, null);
  360.     }
  361.     public List<String> getInfosByIdOID(org.bouncycastle.asn1.ASN1ObjectIdentifier oid, String defaultEmptyValue) {
  362.         return getInfosByOID(oid, defaultEmptyValue);
  363.         /**if(this.x500name==null) {
  364.             this.initX500Name();
  365.         }
  366.         RDN [] rdnArray = this.x500name.getRDNs(oid);
  367.         List<String> l = null;
  368.         if(rdnArray!=null && rdnArray.length>0) {
  369.             for (RDN rdn : rdnArray) {
  370.                 if(rdn!=null && rdn.getFirst()!=null && rdn.getFirst().getValue()!=null) {
  371.                     if(l==null) {
  372.                         l = new ArrayList<>();
  373.                     }
  374.                     l.add(rdn.getFirst().getValue().toString());
  375.                 }
  376.             }
  377.         }
  378.         
  379.         if(l==null && defaultEmptyValue!=null) {
  380.             l = new ArrayList<>();
  381.             l.add(defaultEmptyValue);
  382.         }
  383.         return l;*/
  384.     }
  385. }
Created with JaCoCo 0.8.8.202204050719