2 * ============LICENSE_START====================================================
4 * ===========================================================================
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6 * Modifications Copyright (C) 2018 IBM.
7 * ===========================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END====================================================
23 package org.onap.aaf.auth.cm.service;
25 import java.io.IOException;
26 import java.net.InetAddress;
27 import java.net.UnknownHostException;
28 import java.nio.ByteBuffer;
29 import java.security.NoSuchAlgorithmException;
30 import java.security.cert.X509Certificate;
31 import java.util.ArrayList;
32 import java.util.Date;
33 import java.util.HashSet;
34 import java.util.List;
37 import org.onap.aaf.auth.cm.AAF_CM;
38 import org.onap.aaf.auth.cm.ca.CA;
39 import org.onap.aaf.auth.cm.ca.X509andChain;
40 import org.onap.aaf.auth.cm.cert.BCFactory;
41 import org.onap.aaf.auth.cm.cert.CSRMeta;
42 import org.onap.aaf.auth.cm.data.CertDrop;
43 import org.onap.aaf.auth.cm.data.CertRenew;
44 import org.onap.aaf.auth.cm.data.CertReq;
45 import org.onap.aaf.auth.cm.data.CertResp;
46 import org.onap.aaf.auth.cm.validation.CertmanValidator;
47 import org.onap.aaf.auth.dao.CassAccess;
48 import org.onap.aaf.auth.dao.cass.ArtiDAO;
49 import org.onap.aaf.auth.dao.cass.CacheInfoDAO;
50 import org.onap.aaf.auth.dao.cass.CertDAO;
51 import org.onap.aaf.auth.dao.cass.CertDAO.Data;
52 import org.onap.aaf.auth.dao.cass.CredDAO;
53 import org.onap.aaf.auth.dao.cass.HistoryDAO;
54 import org.onap.aaf.auth.dao.cass.Status;
55 import org.onap.aaf.auth.dao.hl.Question;
56 import org.onap.aaf.auth.env.AuthzTrans;
57 import org.onap.aaf.auth.layer.Result;
58 import org.onap.aaf.auth.org.Organization;
59 import org.onap.aaf.auth.org.Organization.Identity;
60 import org.onap.aaf.auth.org.OrganizationException;
61 import org.onap.aaf.cadi.Hash;
62 import org.onap.aaf.cadi.Permission;
63 import org.onap.aaf.cadi.aaf.AAFPermission;
64 import org.onap.aaf.cadi.config.Config;
65 import org.onap.aaf.cadi.configure.Factory;
66 import org.onap.aaf.cadi.util.FQI;
67 import org.onap.aaf.misc.env.APIException;
68 import org.onap.aaf.misc.env.util.Chrono;
70 public class CMService {
71 // If we add more CAs, may want to parameterize
72 private static final int STD_RENEWAL = 30;
73 private static final int MAX_RENEWAL = 60;
74 private static final int MIN_RENEWAL = 10;
76 public static final String REQUEST = "request";
77 public static final String IGNORE_IPS = "ignoreIPs";
78 public static final String RENEW = "renew";
79 public static final String DROP = "drop";
80 public static final String DOMAIN = "domain";
82 private static final String CERTMAN = "certman";
83 private static final String ACCESS = "access";
85 private static final String[] NO_NOTES = new String[0];
86 private final Permission root_read_permission;
87 private final CertDAO certDAO;
88 private final CredDAO credDAO;
89 private final ArtiDAO artiDAO;
90 private AAF_CM certManager;
92 // @SuppressWarnings("unchecked")
93 public CMService(final AuthzTrans trans, AAF_CM certman) throws APIException, IOException {
94 // Jonathan 4/2015 SessionFilter unneeded... DataStax already deals with
95 // Multithreading well
97 HistoryDAO hd = new HistoryDAO(trans, certman.cluster, CassAccess.KEYSPACE);
98 CacheInfoDAO cid = new CacheInfoDAO(trans, hd);
99 certDAO = new CertDAO(trans, hd, cid);
100 credDAO = new CredDAO(trans, hd, cid);
101 artiDAO = new ArtiDAO(trans, hd, cid);
103 this.certManager = certman;
105 root_read_permission=new AAFPermission(
106 trans.getProperty(Config.AAF_ROOT_NS, Config.AAF_ROOT_NS_DEF),
113 public Result<CertResp> requestCert(final AuthzTrans trans, final Result<CertReq> req, final CA ca) {
116 if (req.value.fqdns.isEmpty()) {
117 return Result.err(Result.ERR_BadData, "No Machines passed in Request");
120 String key = req.value.fqdns.get(0);
122 // Policy 6: Requester must be granted Change permission in Namespace requested
123 String mechNS = FQI.reverseDomain(req.value.mechid);
124 if (mechNS == null) {
125 return Result.err(Status.ERR_Denied, "%s does not reflect a valid AAF Namespace", req.value.mechid);
128 List<String> notes = null;
129 List<String> fqdns = new ArrayList<>(req.value.fqdns);
134 Organization org = trans.org();
136 boolean ignoreIPs = trans.fish(new AAFPermission(mechNS,CERTMAN, ca.getName(), IGNORE_IPS));
138 InetAddress primary = null;
139 // Organize incoming information to get to appropriate Artifact
140 if (!fqdns.isEmpty()) {
141 // Accept domain wild cards, but turn into real machines
142 // Need *domain.com:real.machine.domain.com:san.machine.domain.com:...
143 if (fqdns.get(0).startsWith("*")) { // Domain set
144 if (!trans.fish(new AAFPermission(null,ca.getPermType(), ca.getName(), DOMAIN))) {
145 return Result.err(Result.ERR_Denied,
146 "Domain based Authorizations (" + fqdns.get(0) + ") requires Exception");
149 // check for Permission in Add Artifact?
150 String domain = fqdns.get(0).substring(1);
152 if (fqdns.isEmpty()) {
153 return Result.err(Result.ERR_Denied, "Requests using domain require machine declaration");
157 InetAddress ia = InetAddress.getByName(fqdns.get(0));
159 return Result.err(Result.ERR_Denied,
160 "Request not made from matching IP matching domain");
161 } else if (ia.getHostName().endsWith(domain)) {
167 for (String cn : req.value.fqdns) {
170 InetAddress[] ias = InetAddress.getAllByName(cn);
171 Set<String> potentialSanNames = new HashSet<>();
172 for (InetAddress ia1 : ias) {
173 InetAddress ia2 = InetAddress.getByAddress(ia1.getAddress());
174 if (primary == null && ias.length == 1 && trans.ip().equals(ia1.getHostAddress())) {
176 } else if (!cn.equals(ia1.getHostName())
177 && !ia2.getHostName().equals(ia2.getHostAddress())) {
178 potentialSanNames.add(ia1.getHostName());
181 } catch (UnknownHostException e1) {
182 trans.debug().log(e1);
183 return Result.err(Result.ERR_BadData, "There is no DNS lookup for %s", cn);
192 host = req.value.fqdns.get(0);
193 } else if (primary == null) {
194 return Result.err(Result.ERR_Denied, "Request not made from matching IP (%s)", trans.ip());
196 host = primary.getHostAddress();
199 ArtiDAO.Data add = null;
200 Result<List<ArtiDAO.Data>> ra = artiDAO.read(trans, req.value.mechid, host);
201 if (ra.isOKhasData()) {
203 add = ra.value.get(0); // single key
206 ra = artiDAO.read(trans, req.value.mechid, key);
207 if (ra.isOKhasData()) { // is the Template available?
208 add = ra.value.get(0);
210 for (String s : fqdns) {
211 if (!s.equals(add.machine)) {
212 add.sans(true).add(s);
215 Result<ArtiDAO.Data> rc = artiDAO.create(trans, add); // Create new Artifact from Template
217 return Result.err(rc);
220 add = ra.value.get(0);
224 // Add Artifact listed FQDNs
225 if (add.sans != null) {
226 for (String s : add.sans) {
227 if (!fqdns.contains(s)) {
233 // Policy 2: If Config marked as Expired, do not create or renew
234 Date now = new Date();
235 if (add.expires != null && now.after(add.expires)) {
236 return Result.err(Result.ERR_Policy, "Configuration for %s %s is expired %s", add.mechid,
237 add.machine, Chrono.dateFmt.format(add.expires));
240 // Policy 3: MechID must be current
241 Identity muser = org.getIdentity(trans, add.mechid);
243 return Result.err(Result.ERR_Policy, "MechID must exist in %s", org.getName());
246 // Policy 4: Sponsor must be current
247 Identity ouser = muser.responsibleTo();
249 return Result.err(Result.ERR_Policy, "%s does not have a current sponsor at %s", add.mechid,
251 } else if (!ouser.isFound() || ouser.mayOwn() != null) {
252 return Result.err(Result.ERR_Policy, "%s reports that %s cannot be responsible for %s",
253 org.getName(), trans.user());
256 // Set Email from most current Sponsor
257 email = ouser.email();
259 // Policy 5: keep Artifact data current
260 if (!ouser.fullID().equals(add.sponsor)) {
261 add.sponsor = ouser.fullID();
262 artiDAO.update(trans, add);
265 // Policy 7: Caller must be the MechID or have specifically delegated
267 if (!(trans.user().equals(req.value.mechid)
268 || trans.fish(new AAFPermission(mechNS,CERTMAN, ca.getName(), REQUEST)))) {
269 return Result.err(Status.ERR_Denied, "%s must have access to modify x509 certs in NS %s",
270 trans.user(), mechNS);
273 // Make sure Primary is the first in fqdns
274 if (fqdns.size() > 1) {
275 for (int i = 0; i < fqdns.size(); ++i) {
277 trans.error().log("CMService var primary is null");
279 String fg = fqdns.get(i);
280 if (fg!=null && fg.equals(primary.getHostName())) {
282 String tmp = fqdns.get(0);
283 fqdns.set(0, primary.getHostName());
290 } catch (Exception e) {
291 trans.debug().log(e);
292 return Result.err(Status.ERR_Denied,
293 "AppID Sponsorship cannot be determined at this time. Try later.");
298 csrMeta = BCFactory.createCSRMeta(ca, req.value.mechid, email, fqdns);
299 X509andChain x509ac = ca.sign(trans, csrMeta);
300 if (x509ac == null) {
301 return Result.err(Result.ERR_ActionNotCompleted, "x509 Certificate not signed by CA");
303 trans.info().printf("X509 Subject: %s", x509ac.getX509().getSubjectDN());
305 X509Certificate x509 = x509ac.getX509();
306 CertDAO.Data cdd = new CertDAO.Data();
307 cdd.ca = ca.getName();
308 cdd.serial = x509.getSerialNumber();
309 cdd.id = req.value.mechid;
310 cdd.x500 = x509.getSubjectDN().getName();
311 cdd.x509 = Factory.toString(trans, x509);
312 certDAO.create(trans, cdd);
314 CredDAO.Data crdd = new CredDAO.Data();
315 crdd.other = Question.random.nextInt();
316 crdd.cred = getChallenge256SaltedHash(csrMeta.challenge(), crdd.other);
317 crdd.expires = x509.getNotAfter();
318 crdd.id = req.value.mechid;
319 crdd.ns = Question.domain2ns(crdd.id);
320 crdd.type = CredDAO.CERT_SHA256_RSA;
321 credDAO.create(trans, crdd);
323 CertResp cr = new CertResp(trans, ca, x509, csrMeta, x509ac.getTrustChain(), compileNotes(notes));
324 return Result.ok(cr);
325 } catch (Exception e) {
326 trans.debug().log(e);
327 return Result.err(Result.ERR_ActionNotCompleted, e.getMessage());
330 return Result.err(req);
334 public Result<CertResp> renewCert(AuthzTrans trans, Result<CertRenew> renew) {
336 return Result.err(Result.ERR_NotImplemented, "Not implemented yet");
338 return Result.err(renew);
342 public Result<Void> dropCert(AuthzTrans trans, Result<CertDrop> drop) {
344 return Result.err(Result.ERR_NotImplemented, "Not implemented yet");
346 return Result.err(drop);
350 public Result<List<Data>> readCertsByMechID(AuthzTrans trans, String mechID) {
351 // Policy 1: To Read, must have NS Read or is Sponsor
352 String ns = Question.domain2ns(mechID);
354 if (trans.user().equals(mechID) || trans.fish(new AAFPermission(ns,ACCESS, "*", "read"))
355 || (trans.org().validate(trans, Organization.Policy.OWNS_MECHID, null, mechID)) == null) {
356 return certDAO.readID(trans, mechID);
358 return Result.err(Result.ERR_Denied, "%s is not the ID, Sponsor or NS Owner/Admin for %s at %s",
359 trans.user(), mechID, trans.org().getName());
361 } catch (OrganizationException e) {
362 return Result.err(e);
366 public Result<CertResp> requestPersonalCert(AuthzTrans trans, CA ca) {
367 if (ca.inPersonalDomains(trans.getUserPrincipal())) {
368 Organization org = trans.org();
370 // Policy 1: MechID must be current
373 ouser = org.getIdentity(trans, trans.user());
374 } catch (OrganizationException e1) {
375 trans.debug().log(e1);
379 return Result.err(Result.ERR_Policy, "Requesting User must exist in %s", org.getName());
382 // Set Email from most current Sponsor
386 csrMeta = BCFactory.createPersonalCSRMeta(ca, trans.user(), ouser.email());
387 X509andChain x509ac = ca.sign(trans, csrMeta);
388 if (x509ac == null) {
389 return Result.err(Result.ERR_ActionNotCompleted, "x509 Certificate not signed by CA");
391 X509Certificate x509 = x509ac.getX509();
392 CertDAO.Data cdd = new CertDAO.Data();
393 cdd.ca = ca.getName();
394 cdd.serial = x509.getSerialNumber();
395 cdd.id = trans.user();
396 cdd.x500 = x509.getSubjectDN().getName();
397 cdd.x509 = Factory.toString(trans, x509);
398 certDAO.create(trans, cdd);
400 CertResp cr = new CertResp(trans, ca, x509, csrMeta, x509ac.getTrustChain(), compileNotes(null));
401 return Result.ok(cr);
402 } catch (Exception e) {
403 trans.debug().log(e);
404 return Result.err(Result.ERR_ActionNotCompleted, e.getMessage());
407 return Result.err(Result.ERR_Denied, trans.user(), " not supported for CA", ca.getName());
414 public Result<Void> createArtifact(AuthzTrans trans, List<ArtiDAO.Data> list) {
415 CertmanValidator v = new CertmanValidator().artisRequired(list, 1);
417 return Result.err(Result.ERR_BadData, v.errs());
419 for (ArtiDAO.Data add : list) {
421 // Policy 1: MechID must exist in Org
422 Identity muser = trans.org().getIdentity(trans, add.mechid);
424 return Result.err(Result.ERR_Denied, "%s is not valid for %s", add.mechid, trans.org().getName());
427 // Policy 2: MechID must have valid Organization Owner
429 if (muser.isPerson()) {
432 Identity ouser = muser.responsibleTo();
434 return Result.err(Result.ERR_Denied, "%s is not a valid Sponsor for %s at %s", trans.user(),
435 add.mechid, trans.org().getName());
438 // Policy 3: Calling ID must be MechID Owner
439 if (!trans.user().startsWith(ouser.id())) {
440 return Result.err(Result.ERR_Denied, "%s is not the Sponsor for %s at %s", trans.user(),
441 add.mechid, trans.org().getName());
446 // Policy 4: Renewal Days are between 10 and 60 (constants, may be
448 if (add.renewDays < MIN_RENEWAL) {
449 add.renewDays = STD_RENEWAL;
450 } else if (add.renewDays > MAX_RENEWAL) {
451 add.renewDays = MAX_RENEWAL;
454 // Policy 5: If Notify is blank, set to Owner's Email
455 if (add.notify == null || add.notify.length() == 0) {
456 add.notify = "mailto:" + emailUser.email();
459 // Policy 6: Only do Domain by Exception
460 if (add.machine.startsWith("*")) { // Domain set
461 CA ca = certManager.getCA(add.ca);
463 if (!trans.fish(new AAFPermission(ca.getPermNS(),ca.getPermType(), add.ca, DOMAIN))) {
464 return Result.err(Result.ERR_Denied, "Domain Artifacts (%s) requires specific Permission",
469 // Set Sponsor from Golden Source
470 add.sponsor = emailUser.fullID();
472 } catch (OrganizationException e) {
473 return Result.err(e);
476 Result<ArtiDAO.Data> rv = artiDAO.create(trans, add);
477 // come up with Partial Reporting Scheme, or allow only one at a time.
479 return Result.err(rv);
485 public Result<List<ArtiDAO.Data>> readArtifacts(AuthzTrans trans, ArtiDAO.Data add) throws OrganizationException {
486 CertmanValidator v = new CertmanValidator().keys(add);
488 return Result.err(Result.ERR_BadData, v.errs());
490 Result<List<ArtiDAO.Data>> data = artiDAO.read(trans, add);
491 if (data.notOKorIsEmpty()) {
494 add = data.value.get(0);
495 if (trans.user().equals(add.mechid)
496 || trans.fish(root_read_permission,
497 new AAFPermission(add.ns,ACCESS, "*", "read"),
498 new AAFPermission(add.ns,CERTMAN, add.ca, "read"),
499 new AAFPermission(add.ns,CERTMAN, add.ca, REQUEST))
500 || (trans.org().validate(trans, Organization.Policy.OWNS_MECHID, null, add.mechid)) == null) {
503 return Result.err(Result.ERR_Denied,
504 "%s is not %s, is not the sponsor, and doesn't have delegated permission.", trans.user(),
505 add.mechid, add.ns + ".certman|" + add.ca + "|read or ...|request"); // note: reason is set by 2nd
506 // case, if 1st case misses
511 public Result<List<ArtiDAO.Data>> readArtifactsByMechID(AuthzTrans trans, String mechid)
512 throws OrganizationException {
513 CertmanValidator v = new CertmanValidator();
514 v.nullOrBlank("mechid", mechid);
516 return Result.err(Result.ERR_BadData, v.errs());
518 String ns = FQI.reverseDomain(mechid);
521 if (trans.fish(new AAFPermission(ns, ACCESS, "*", "read"))
522 || (reason = trans.org().validate(trans, Organization.Policy.OWNS_MECHID, null, mechid)) == null) {
523 return artiDAO.readByMechID(trans, mechid);
525 return Result.err(Result.ERR_Denied, reason); // note: reason is set by 2nd case, if 1st case misses
530 public Result<List<ArtiDAO.Data>> readArtifactsByMachine(AuthzTrans trans, String machine) {
531 CertmanValidator v = new CertmanValidator();
532 v.nullOrBlank("machine", machine);
534 return Result.err(Result.ERR_BadData, v.errs());
539 return artiDAO.readByMachine(trans, machine);
542 public Result<List<ArtiDAO.Data>> readArtifactsByNs(AuthzTrans trans, String ns) {
543 CertmanValidator v = new CertmanValidator();
544 v.nullOrBlank("ns", ns);
546 return Result.err(Result.ERR_BadData, v.errs());
550 return artiDAO.readByNs(trans, ns);
553 public Result<Void> updateArtifact(AuthzTrans trans, List<ArtiDAO.Data> list) throws OrganizationException {
554 CertmanValidator v = new CertmanValidator();
555 v.artisRequired(list, 1);
557 return Result.err(Result.ERR_BadData, v.errs());
560 // Check if requesting User is Sponsor
561 // Shall we do one, or multiples?
562 for (ArtiDAO.Data add : list) {
563 // Policy 1: MechID must exist in Org
564 Identity muser = trans.org().getIdentity(trans, add.mechid);
566 return Result.err(Result.ERR_Denied, "%s is not valid for %s", add.mechid, trans.org().getName());
569 // Policy 2: MechID must have valid Organization Owner
570 Identity ouser = muser.responsibleTo();
572 return Result.err(Result.ERR_Denied, "%s is not a valid Sponsor for %s at %s", trans.user(), add.mechid,
573 trans.org().getName());
576 // Policy 3: Renewal Days are between 10 and 60 (constants, may be
578 if (add.renewDays < MIN_RENEWAL) {
579 add.renewDays = STD_RENEWAL;
580 } else if (add.renewDays > MAX_RENEWAL) {
581 add.renewDays = MAX_RENEWAL;
584 // Policy 4: Data is always updated with the latest Sponsor
585 // Add to Sponsor, to make sure we are always up to date.
586 add.sponsor = ouser.fullID();
588 // Policy 5: If Notify is blank, set to Owner's Email
589 if (add.notify == null || add.notify.length() == 0) {
590 add.notify = "mailto:" + ouser.email();
592 // Policy 6: Only do Domain by Exception
593 if (add.machine.startsWith("*")) { // Domain set
594 CA ca = certManager.getCA(add.ca);
596 return Result.err(Result.ERR_BadData, "CA is required in Artifact");
598 if (!trans.fish(new AAFPermission(null,ca.getPermType(), add.ca, DOMAIN))) {
599 return Result.err(Result.ERR_Denied, "Domain Artifacts (%s) requires specific Permission",
604 // Policy 7: only Owner may update info
605 if (trans.user().startsWith(ouser.id())) {
606 return artiDAO.update(trans, add);
608 return Result.err(Result.ERR_Denied, "%s may not update info for %s", trans.user(), muser.fullID());
611 return Result.err(Result.ERR_BadData, "No Artifacts to update");
614 public Result<Void> deleteArtifact(AuthzTrans trans, String mechid, String machine) throws OrganizationException {
615 CertmanValidator v = new CertmanValidator();
616 v.nullOrBlank("mechid", mechid).nullOrBlank("machine", machine);
618 return Result.err(Result.ERR_BadData, v.errs());
621 Result<List<ArtiDAO.Data>> rlad = artiDAO.read(trans, mechid, machine);
622 if (rlad.notOKorIsEmpty()) {
623 return Result.err(Result.ERR_NotFound, "Artifact for %s %s does not exist.", mechid, machine);
626 return deleteArtifact(trans, rlad.value.get(0));
629 private Result<Void> deleteArtifact(AuthzTrans trans, ArtiDAO.Data add) throws OrganizationException {
630 // Policy 1: Record should be delete able only by Existing Sponsor.
631 String sponsor = null;
632 Identity muser = trans.org().getIdentity(trans, add.mechid);
634 Identity ouser = muser.responsibleTo();
636 sponsor = ouser.fullID();
639 // Policy 1.a: If Sponsorship is deleted in system of Record, then
640 // accept deletion by sponsor in Artifact Table
641 if (sponsor == null) {
642 sponsor = add.sponsor;
645 String ns = FQI.reverseDomain(add.mechid);
647 if (trans.fish(new AAFPermission(ns,ACCESS, "*", "write")) || trans.user().equals(sponsor)) {
648 return artiDAO.delete(trans, add, false);
650 return Result.err(Result.ERR_Denied, "%1 is not allowed to delete this item", trans.user());
653 public Result<Void> deleteArtifact(AuthzTrans trans, List<ArtiDAO.Data> list) {
654 CertmanValidator v = new CertmanValidator().artisRequired(list, 1);
656 return Result.err(Result.ERR_BadData, v.errs());
660 boolean partial = false;
661 Result<Void> result = null;
662 for (ArtiDAO.Data add : list) {
663 result = deleteArtifact(trans, add);
664 if (result.notOK()) {
668 if (result == null) {
669 result = Result.err(Result.ERR_BadData, "No Artifacts to delete");
670 } else if (partial) {
671 result.partialContent(true);
674 } catch (Exception e) {
675 return Result.err(e);
679 private String[] compileNotes(List<String> notes) {
684 rv = new String[notes.size()];
690 private ByteBuffer getChallenge256SaltedHash(String challenge, int salt) throws NoSuchAlgorithmException {
691 ByteBuffer bb = ByteBuffer.allocate(Integer.SIZE + challenge.length());
693 bb.put(challenge.getBytes());
694 byte[] hash = Hash.hashSHA256(bb.array());
695 return ByteBuffer.wrap(hash);