OsAccountRealm.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2020 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.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.ResourceBundle;
import org.apache.commons.lang3.StringUtils;

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

        private final long id;  // row id 
        
        // a realm may have multiple names - for exmple, for a user ABCCorp\\user1 or user1@ABCcorp.com - 'ABCCorp' and 'ABCcorp.com' both refer to the same realm.
        // currently we only support a single name, this could be expanded in future.
        private final String realmName; // realm name
        
        private final String realmAddr; // realm address
        private String signature; // either realm address or name (if address is not known), plus a scope indicator
        private final Host host;        // if the realm consists of a single host.  Will be null if the realm is domain scoped. 
        private final ScopeConfidence scopeConfidence; // confidence in realm scope.
        private final RealmDbStatus dbStatus; // Status of row in database.
        
        OsAccountRealm(long id, String realmName, String realmAddr, String signature, Host host, ScopeConfidence scopeConfidence, RealmDbStatus dbStatus) {
                this.id = id;
                this.realmName = realmName;
                this.realmAddr = realmAddr;
                this.signature = signature;
                this.host = host;
                this.scopeConfidence = scopeConfidence;
                this.dbStatus = dbStatus;
        }

        long getRealmId() {
                return id;
        }

        public List<String> getRealmNames() {
                List<String> namesList = new ArrayList<>();
                if (!Objects.isNull(realmName)) {
                        namesList.add(realmName);
                }

                return namesList;
        }

        public Optional<String> getRealmAddr() {
                return Optional.ofNullable(realmAddr);
        }

        String getSignature() {
                return signature;
        }
        
        public Optional<Host> getScopeHost() {
                return Optional.ofNullable(host);
        }

        public ScopeConfidence getScopeConfidence() {
                return scopeConfidence;
        }
        
        RealmDbStatus getDbStatus() {
                return dbStatus;
        }       

        public RealmScope getScope() {
                return getScopeHost().isPresent() ? RealmScope.LOCAL : RealmScope.DOMAIN; 
        }
        
        public enum RealmScope {
                UNKNOWN(0,      bundle.getString("OsAccountRealm.Unknown.text")),                       // realm scope is unknown.
                LOCAL(1,        bundle.getString("OsAccountRealm.Local.text")),                         // realm scope is a single host.
                DOMAIN(2,       bundle.getString("OsAccountRealm.Domain.text"));                        // realm scope is a domain.
                
                private final int id;
                private final String name; 

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

                public int getId() {
                        return id;
                }
                
                public String getName() {
                        return name;
                }
                
                public static RealmScope fromID(int typeId) {
                        for (RealmScope scopeType : RealmScope.values()) {
                                if (scopeType.ordinal() == typeId) {
                                        return scopeType;
                                }
                        }
                        return null;
                }
        }
        
        public enum ScopeConfidence {
                KNOWN(0, bundle.getString("OsAccountRealm.Known.text")),                        // realm scope is known for sure.
                INFERRED(1, bundle.getString("OsAccountRealm.Inferred.text"));  // realm scope is inferred

                private final int id;
                private final String name; 

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

                public int getId() {
                        return id;
                }
                
                public String getName() {
                        return name;
                }
                
                public static ScopeConfidence fromID(int typeId) {
                        for (ScopeConfidence statusType : ScopeConfidence.values()) {
                                if (statusType.ordinal() == typeId) {
                                        return statusType;
                                }
                        }
                        return null;
                }
        }
                
        boolean setSignature(String signature) {
                if (StringUtils.isNotBlank(signature)) {
                        this.signature = signature;
                        return true;
                }
                
                return false;
        }
        
        
        enum RealmDbStatus {
                ACTIVE(0, "Active"),
                MERGED(1, "Merged"),
                DELETED(2, "Deleted");  

                private final int id;
                private final String name;

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

                int getId() {
                        return id;
                }

                String getName() {
                        return name;
                }

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