Class IdentityFile

  • All Implemented Interfaces:
    Identity

    class IdentityFile
    extends java.lang.Object
    implements Identity
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private IdentityFile​(JSch jsch, java.lang.String name, KeyPair kpair)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void clear()
      Disposes internally allocated data, like byte array for the private key.
      boolean decrypt()
      Deprecated.
      This method should not be invoked.
      java.lang.String getAlgName()
      Returns the name of the key algorithm.
      KeyPair getKeyPair()
      Returns an instance of KeyPair used in this Identity.
      java.lang.String getName()
      Returns the name of this identity.
      byte[] getPublicKeyBlob()
      Returns the public-key blob.
      byte[] getSignature​(byte[] data)
      Signs on data with this identity, and returns the result.
      boolean isEncrypted()
      Returns true if this identity is cyphered.
      (package private) static IdentityFile newInstance​(java.lang.String name, byte[] prvkey, byte[] pubkey, JSch jsch)  
      (package private) static IdentityFile newInstance​(java.lang.String prvfile, java.lang.String pubfile, JSch jsch)  
      boolean setPassphrase​(byte[] passphrase)
      Decrypts this identity with the specified pass-phrase.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • jsch

        private JSch jsch
      • identity

        private java.lang.String identity
    • Method Detail

      • setPassphrase

        public boolean setPassphrase​(byte[] passphrase)
                              throws JSchException
        Decrypts this identity with the specified pass-phrase.
        Specified by:
        setPassphrase in interface Identity
        Parameters:
        passphrase - the pass-phrase for this identity.
        Returns:
        true if the decryption is succeeded or this identity is not cyphered.
        Throws:
        JSchException
      • getPublicKeyBlob

        public byte[] getPublicKeyBlob()
        Returns the public-key blob.
        Specified by:
        getPublicKeyBlob in interface Identity
        Returns:
        the public-key blob
      • getSignature

        public byte[] getSignature​(byte[] data)
        Signs on data with this identity, and returns the result.
        Specified by:
        getSignature in interface Identity
        Parameters:
        data - data to be signed
        Returns:
        the signature
      • getAlgName

        public java.lang.String getAlgName()
        Returns the name of the key algorithm.
        Specified by:
        getAlgName in interface Identity
        Returns:
        "ssh-rsa" or "ssh-dss"
      • getName

        public java.lang.String getName()
        Returns the name of this identity. It will be useful to identify this object in the IdentityRepository.
        Specified by:
        getName in interface Identity
      • isEncrypted

        public boolean isEncrypted()
        Returns true if this identity is cyphered.
        Specified by:
        isEncrypted in interface Identity
        Returns:
        true if this identity is cyphered.
      • clear

        public void clear()
        Disposes internally allocated data, like byte array for the private key.
        Specified by:
        clear in interface Identity