2 * ============LICENSE_START====================================================
4 * ===========================================================================
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6 * ===========================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END====================================================
22 package org.onap.aaf.auth.dao.cass;
24 import java.io.ByteArrayOutputStream;
25 import java.io.DataInputStream;
26 import java.io.DataOutputStream;
27 import java.io.IOException;
28 import java.nio.ByteBuffer;
29 import java.util.Date;
30 import java.util.List;
32 import org.onap.aaf.auth.dao.Bytification;
33 import org.onap.aaf.auth.dao.CIDAO;
34 import org.onap.aaf.auth.dao.Cached;
35 import org.onap.aaf.auth.dao.CassDAOImpl;
36 import org.onap.aaf.auth.dao.Loader;
37 import org.onap.aaf.auth.dao.Streamer;
38 import org.onap.aaf.auth.env.AuthzTrans;
39 import org.onap.aaf.auth.layer.Result;
40 import org.onap.aaf.misc.env.APIException;
41 import org.onap.aaf.misc.env.util.Chrono;
43 import com.datastax.driver.core.Cluster;
44 import com.datastax.driver.core.Row;
47 * CredDAO manages credentials.
51 public class CredDAO extends CassDAOImpl<AuthzTrans,CredDAO.Data> {
52 public static final String TABLE = "cred";
53 public static final int CACHE_SEG = 0x40; // yields segment 0x0-0x3F
54 public static final int RAW = -1;
55 public static final int BASIC_AUTH = 1;
56 public static final int BASIC_AUTH_SHA256 = 2;
57 public static final int CERT_SHA256_RSA =200;
59 private HistoryDAO historyDAO;
60 private CIDAO<AuthzTrans> infoDAO;
64 public CredDAO(AuthzTrans trans, Cluster cluster, String keyspace) throws APIException, IOException {
65 super(trans, CredDAO.class.getSimpleName(),cluster, keyspace, Data.class,TABLE, readConsistency(trans,TABLE), writeConsistency(trans,TABLE));
69 public CredDAO(AuthzTrans trans, HistoryDAO hDao, CacheInfoDAO ciDao) throws APIException, IOException {
70 super(trans, CredDAO.class.getSimpleName(),hDao, Data.class,TABLE, readConsistency(trans,TABLE), writeConsistency(trans,TABLE));
76 public static final int KEYLIMIT = 3;
77 public static class Data extends CacheableData implements Bytification {
85 public ByteBuffer cred; // this is a blob in cassandra
89 public int[] invalidate(Cached<?,?> cache) {
91 seg(cache,id) // cache is for all entities
96 public ByteBuffer bytify() throws IOException {
97 ByteArrayOutputStream baos = new ByteArrayOutputStream();
98 CredLoader.deflt.marshal(this,new DataOutputStream(baos));
99 return ByteBuffer.wrap(baos.toByteArray());
103 public void reconstitute(ByteBuffer bb) throws IOException {
104 CredLoader.deflt.unmarshal(this, toDIS(bb));
107 public String toString() {
108 return id + ' ' + type + ' ' + Chrono.dateTime(expires);
112 private static class CredLoader extends Loader<Data> implements Streamer<Data>{
113 public static final int MAGIC=153323443;
114 public static final int VERSION=1;
115 public static final int BUFF_SIZE=48; // Note:
117 public static final CredLoader deflt = new CredLoader(KEYLIMIT);
118 public CredLoader(int keylimit) {
123 public Data load(Data data, Row row) {
124 data.id = row.getString(0);
125 data.type = row.getInt(1); // NOTE: in datastax driver, If the int value is NULL, 0 is returned!
126 data.expires = row.getTimestamp(2);
127 data.other = row.getInt(3);
128 data.ns = row.getString(4);
129 data.notes = row.getString(5);
130 data.cred = row.getBytesUnsafe(6);
135 protected void key(Data data, int _idx, Object[] obj) {
139 obj[++idx] = data.type;
140 obj[++idx] = data.expires;
144 protected void body(Data data, int idx, Object[] obj) {
146 obj[i=idx] = data.other;
148 obj[++i] = data.notes;
149 obj[++i] = data.cred;
153 public void marshal(Data data, DataOutputStream os) throws IOException {
154 writeHeader(os,MAGIC,VERSION);
155 writeString(os, data.id);
156 os.writeInt(data.type);
157 os.writeLong(data.expires==null?-1:data.expires.getTime());
158 os.writeInt(data.other==null?0:data.other);
159 writeString(os, data.ns);
160 writeString(os, data.notes);
161 if(data.cred==null) {
164 int l = data.cred.limit()-data.cred.position();
166 os.write(data.cred.array(),data.cred.position(),l);
171 public void unmarshal(Data data, DataInputStream is) throws IOException {
172 /*int version = */readHeader(is,MAGIC,VERSION);
173 // If Version Changes between Production runs, you'll need to do a switch Statement, and adequately read in fields
174 byte[] buff = new byte[BUFF_SIZE];
175 data.id = readString(is,buff);
176 data.type = is.readInt();
178 long l = is.readLong();
179 data.expires = l<0?null:new Date(l);
180 data.other = is.readInt();
181 data.ns = readString(is,buff);
182 data.notes = readString(is,buff);
184 int i = is.readInt();
187 byte[] bytes = new byte[i]; // a bit dangerous, but lessened because of all the previous sized data reads
188 int read = is.read(bytes);
190 data.cred = ByteBuffer.wrap(bytes);
196 private void init(AuthzTrans trans) throws APIException, IOException {
198 if(historyDAO==null) {
199 historyDAO = new HistoryDAO(trans,this);
202 infoDAO = new CacheInfoDAO(trans,this);
206 String[] helpers = setCRUD(trans, TABLE, Data.class, CredLoader.deflt);
208 psNS = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] + " FROM " + TABLE +
209 " WHERE ns = ?", CredLoader.deflt,readConsistency);
211 psID = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] + " FROM " + TABLE +
212 " WHERE id = ?", CredLoader.deflt,readConsistency);
215 public Result<List<Data>> readNS(AuthzTrans trans, String ns) {
216 return psNS.read(trans, R_TEXT, new Object[]{ns});
219 public Result<List<Data>> readID(AuthzTrans trans, String id) {
220 return psID.read(trans, R_TEXT, new Object[]{id});
224 * Log Modification statements to History
226 * @param modified which CRUD action was done
227 * @param data entity data that needs a log entry
228 * @param overrideMessage if this is specified, we use it rather than crafting a history message based on data
231 protected void wasModified(AuthzTrans trans, CRUD modified, Data data, String ... override) {
232 boolean memo = override.length>0 && override[0]!=null;
233 boolean subject = override.length>1 && override[1]!=null;
235 HistoryDAO.Data hd = HistoryDAO.newInitedData();
236 hd.user = trans.user();
237 hd.action = modified.name();
239 hd.subject = subject?override[1]: data.id;
241 ? String.format("%s by %s", override[0], hd.user)
242 : (modified.name() + "d credential for " + data.id);
244 if(modified==CRUD.delete) {
246 hd.reconstruct = data.bytify();
247 } catch (IOException e) {
248 trans.error().log(e,"Could not serialize CredDAO.Data");
252 if(historyDAO.create(trans, hd).status!=Status.OK) {
253 trans.error().log("Cannot log to History");
255 if(infoDAO.touch(trans, TABLE,data.invalidate(cache)).status!=Status.OK) {
256 trans.error().log("Cannot touch Cred");