org.snmp4j.security.UsmSecurityStateReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snmp4j Show documentation
SNMP API for Java
There is a newer version: 3.8.2
/*_############################################################################
  _## 
  _##  SNMP4J - UsmSecurityStateReference.java  
  _## 
  _##  Copyright (C) 2003-2022  Frank Fock (SNMP4J.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.snmp4j.security;

import org.snmp4j.DirectUserTarget;
import org.snmp4j.Target;
import org.snmp4j.UserTarget;
import org.snmp4j.smi.OctetString;

import java.util.Arrays;

/**
 * The {@code UsmSecurityStateReference} holds cached security data for the {@link USM} security model.
 *
 * @author Frank Fock
 * @version 3.4.0
 */
public class UsmSecurityStateReference implements SecurityStateReference {

    private byte[] securityName;
    private byte[] securityEngineID;
    private AuthenticationProtocol authenticationProtocol;
    private PrivacyProtocol privacyProtocol;
    private byte[] authenticationKey;
    private byte[] privacyKey;
    private int securityLevel;
    private boolean isCachedForResponseProcessing;

    public UsmSecurityStateReference() {
    }

    public void setSecurityName(byte[] securityName) {
        this.securityName = securityName;
    }

    public byte[] getSecurityName() {
        return securityName;
    }

    public void setSecurityEngineID(byte[] securityEngineID) {
        this.securityEngineID = securityEngineID;
    }

    public byte[] getSecurityEngineID() {
        return securityEngineID;
    }

    public void setAuthenticationProtocol(AuthenticationProtocol authenticationProtocol) {
        this.authenticationProtocol = authenticationProtocol;
    }

    public AuthenticationProtocol getAuthenticationProtocol() {
        return authenticationProtocol;
    }

    public void setPrivacyProtocol(PrivacyProtocol privacyProtocol) {
        this.privacyProtocol = privacyProtocol;
    }

    public PrivacyProtocol getPrivacyProtocol() {
        return privacyProtocol;
    }

    public void setAuthenticationKey(byte[] authenticationKey) {
        this.authenticationKey = authenticationKey;
    }

    public byte[] getAuthenticationKey() {
        return authenticationKey;
    }

    public void setPrivacyKey(byte[] privacyKey) {
        this.privacyKey = privacyKey;
    }

    public byte[] getPrivacyKey() {
        return privacyKey;
    }

    public void setSecurityLevel(int securityLevel) {
        this.securityLevel = securityLevel;
    }

    public int getSecurityLevel() {
        return securityLevel;
    }

    @Override
    public void setCachedForResponseProcessing(boolean isCachedForResponseProcessing) {
        this.isCachedForResponseProcessing = isCachedForResponseProcessing;
    }

    @Override
    public boolean isCachedForResponseProcessing() {
        return isCachedForResponseProcessing;
    }

    @Override
    public boolean applyTargetSecurityInformation(Target target) {
        if (target instanceof DirectUserTarget) {

            DirectUserTarget userTarget = (DirectUserTarget)target;
            this.setSecurityName(userTarget.getSecurityName().getValue());
            this.setSecurityLevel(userTarget.getSecurityLevel());
            this.setSecurityEngineID(userTarget.getAuthoritativeEngineID());
            this.setAuthenticationProtocol(userTarget.getAuthenticationProtocol());
            this.setPrivacyProtocol(userTarget.getPrivacyProtocol());
            if (userTarget.getAuthenticationKey() != null) {
                authenticationKey = userTarget.getAuthenticationKey().getValue();
                if (userTarget.getPrivacyKey() != null) {
                    privacyKey = userTarget.getPrivacyKey().getValue();
                }
                return true;
            }
        }
        return false;
    }

    @Override
    public String toString() {
        return "UsmSecurityStateReference{" +
                "securityName=" + Arrays.toString(securityName) +
                ", securityEngineID=" + Arrays.toString(securityEngineID) +
                ", authenticationProtocol=" + authenticationProtocol +
                ", privacyProtocol=" + privacyProtocol +
                ", authenticationKey=" + SecretOctetString.fromByteArray(authenticationKey) +
                ", privacyKey=" + SecretOctetString.fromByteArray(privacyKey) +
                ", securityLevel=" + securityLevel +
                ", isCachedForResponseProcessing=" + isCachedForResponseProcessing +
                '}';
    }
}