OsAccount.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2020-2021 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.datamodel;

import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.ResourceBundle;

public final class OsAccount extends AbstractContent {

        private static final ResourceBundle bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle");

        final static Long NO_ACCOUNT = null;
        final static String NO_OWNER_ID = null;

        private final SleuthkitCase sleuthkitCase;

        private final long osAccountObjId;      // Object ID within the database
        private final long realmId;             // realm where the account exists in (could be local or domain scoped)
        private final String loginName; // user login name - may be null
        private final String addr;      // a unique user sid/uid, may be null

        private final String signature;         // This exists only to prevent duplicates.
        // Together realm_id & signature must be unique for each account.
        // It is either addr if addr is defined,
        // or the login_name if login_name is defined.

        private final String fullName;  // full name, may be null
        private final OsAccountType osAccountType;
        private final OsAccountStatus osAccountStatus;
        private final OsAccountDbStatus osAccountDbStatus;  // Status of row in the database
        private final Long creationTime;

        private List<OsAccountAttribute> osAccountAttributes = null;

        public enum OsAccountStatus {
                UNKNOWN(0, bundle.getString("OsAccountStatus.Unknown.text")),
                ACTIVE(1, bundle.getString("OsAccountStatus.Active.text")),
                DISABLED(2, bundle.getString("OsAccountStatus.Disabled.text")),
                DELETED(3, bundle.getString("OsAccountStatus.Deleted.text"));

                private final int id;
                private final String name;

                OsAccountStatus(int id, String name) {
                        this.id = id;
                        this.name = name;
                }

                public int getId() {
                        return id;
                }

                public String getName() {
                        return name;
                }

                public static OsAccountStatus fromID(int statusId) {
                        for (OsAccountStatus statusType : OsAccountStatus.values()) {
                                if (statusType.ordinal() == statusId) {
                                        return statusType;
                                }
                        }
                        return null;
                }
        }

        enum OsAccountDbStatus {
                ACTIVE(0, "Active"),
                MERGED(1, "Merged"),
                DELETED(2, "Deleted");

                private final int id;
                private final String name;

                OsAccountDbStatus(int id, String name) {
                        this.id = id;
                        this.name = name;
                }

                int getId() {
                        return id;
                }

                String getName() {
                        return name;
                }

                static OsAccountDbStatus fromID(int typeId) {
                        for (OsAccountDbStatus type : OsAccountDbStatus.values()) {
                                if (type.ordinal() == typeId) {
                                        return type;
                                }
                        }
                        return null;
                }
        }

        public enum OsAccountType {
                UNKNOWN(0, bundle.getString("OsAccountType.Unknown.text")),
                SERVICE(1, bundle.getString("OsAccountType.Service.text")),
                INTERACTIVE(2, bundle.getString("OsAccountType.Interactive.text"));

                private final int id;
                private final String name;

                OsAccountType(int id, String name) {
                        this.id = id;
                        this.name = name;
                }

                public int getId() {
                        return id;
                }

                public String getName() {
                        return name;
                }

                public static OsAccountType fromID(int typeId) {
                        for (OsAccountType accountType : OsAccountType.values()) {
                                if (accountType.ordinal() == typeId) {
                                        return accountType;
                                }
                        }
                        return null;
                }
        }

        OsAccount(SleuthkitCase sleuthkitCase, long osAccountobjId, long realmId, String loginName, String uniqueId, String signature,
                        String fullName, Long creationTime, OsAccountType accountType, OsAccountStatus accountStatus, OsAccountDbStatus accountDbStatus) {

                super(sleuthkitCase, osAccountobjId, signature);

                this.sleuthkitCase = sleuthkitCase;
                this.osAccountObjId = osAccountobjId;
                this.realmId = realmId;
                this.loginName = loginName;
                this.addr = uniqueId;
                this.signature = signature;
                this.fullName = fullName;
                this.creationTime = creationTime;
                this.osAccountType = accountType;
                this.osAccountStatus = accountStatus;
                this.osAccountDbStatus = accountDbStatus;
        }

        synchronized void setAttributesInternal(List<OsAccountAttribute> osAccountAttributes) {
                this.osAccountAttributes = osAccountAttributes;
        }

        public long getId() {
                return osAccountObjId;
        }

        public Optional<String> getAddr() {
                return Optional.ofNullable(addr);
        }

        public long getRealmId() {
                return realmId;
        }

        public Optional<String> getLoginName() {
                return Optional.ofNullable(loginName);
        }

        String getSignature() {
                return signature;
        }

        public Optional<String> getFullName() {
                return Optional.ofNullable(fullName);
        }

        public Optional<Long> getCreationTime() {
                return Optional.ofNullable(creationTime);
        }

        public Optional<OsAccountType> getOsAccountType() {
                return Optional.ofNullable(osAccountType);
        }

        public Optional<OsAccountStatus> getOsAccountStatus() {
                return Optional.ofNullable(osAccountStatus);
        }

        public OsAccountDbStatus getOsAccountDbStatus() {
                return osAccountDbStatus;
        }

        public synchronized List<OsAccountAttribute> getExtendedOsAccountAttributes() throws TskCoreException {
                if (osAccountAttributes == null) {
                        osAccountAttributes = sleuthkitCase.getOsAccountManager().getOsAccountAttributes(this);
                }
                return Collections.unmodifiableList(osAccountAttributes);
        }

        public synchronized List<OsAccountInstance> getOsAccountInstances() throws TskCoreException {
                return sleuthkitCase.getOsAccountManager().getOsAccountInstances(this);
        }

        @Override
        public SleuthkitCase getSleuthkitCase() {
                return sleuthkitCase;
        }

        @Override
        public int read(byte[] buf, long offset, long len) throws TskCoreException {
                // No data to read. 
                return 0;
        }

        @Override
        public void close() {
                // nothing to close
        }

        @Override
        public long getSize() {
                // No data. 
                return 0;
        }

        @Override
        public <T> T accept(ContentVisitor<T> v) {

                throw new UnsupportedOperationException("Not supported yet.");
        }

        @Override
        public <T> T accept(SleuthkitItemVisitor<T> v) {
                return v.visit(this);
        }

        public final class OsAccountAttribute extends AbstractAttribute {

                private final long osAccountObjId;      // OS account to which this attribute belongs.
                private final Long hostId; // Host to which this attribute applies, may be null
                private final Long sourceObjId; // Object id of the source where the attribute was discovered.

                public OsAccountAttribute(BlackboardAttribute.Type attributeType, int valueInt, OsAccount osAccount, Host host, Content sourceObj) {
                        super(attributeType, valueInt);

                        this.osAccountObjId = osAccount.getId();
                        this.hostId = (host != null ? host.getHostId() : null);
                        this.sourceObjId = (sourceObj != null ? sourceObj.getId() : null);
                }

                public OsAccountAttribute(BlackboardAttribute.Type attributeType, long valueLong, OsAccount osAccount, Host host, Content sourceObj) {
                        super(attributeType, valueLong);

                        this.osAccountObjId = osAccount.getId();
                        this.hostId = (host != null ? host.getHostId() : null);
                        this.sourceObjId = (sourceObj != null ? sourceObj.getId() : null);
                }

                public OsAccountAttribute(BlackboardAttribute.Type attributeType, double valueDouble, OsAccount osAccount, Host host, Content sourceObj) {
                        super(attributeType, valueDouble);

                        this.osAccountObjId = osAccount.getId();
                        this.hostId = (host != null ? host.getHostId() : null);
                        this.sourceObjId = (sourceObj != null ? sourceObj.getId() : null);
                }

                public OsAccountAttribute(BlackboardAttribute.Type attributeType, String valueString, OsAccount osAccount, Host host, Content sourceObj) {
                        super(attributeType, valueString);

                        this.osAccountObjId = osAccount.getId();
                        this.hostId = (host != null ? host.getHostId() : null);
                        this.sourceObjId = (sourceObj != null ? sourceObj.getId() : null);
                }

                public OsAccountAttribute(BlackboardAttribute.Type attributeType, byte[] valueBytes, OsAccount osAccount, Host host, Content sourceObj) {
                        super(attributeType, valueBytes);

                        this.osAccountObjId = osAccount.getId();
                        this.hostId = (host != null ? host.getHostId() : null);
                        this.sourceObjId = (sourceObj != null ? sourceObj.getId() : null);
                }

                OsAccountAttribute(BlackboardAttribute.Type attributeType, int valueInt, long valueLong, double valueDouble, String valueString, byte[] valueBytes,
                                SleuthkitCase sleuthkitCase, OsAccount osAccount, Host host, Content sourceObj) {

                        super(attributeType,
                                        valueInt, valueLong, valueDouble, valueString, valueBytes,
                                        sleuthkitCase);
                        this.osAccountObjId = osAccount.getId();
                        this.hostId = (host != null ? host.getHostId() : null);
                        this.sourceObjId = (sourceObj != null ? sourceObj.getId() : null);
                }

                public Optional<Long> getHostId() {
                        return Optional.ofNullable(hostId);
                }

                public long getOsAccountObjectId() {
                        return osAccountObjId;
                }

                public Optional<Long> getSourceObjectId() {
                        return Optional.ofNullable(sourceObjId);
                }
        }
}