Package org.apache.cxf.sts

Class SignatureProperties

  • public class SignatureProperties
extends Object
    This class contains various configuration properties that can be used to sign an issued token, or generate a symmetric key in the STS.

    • Constructor Detail

      • SignatureProperties

        public SignatureProperties()

    • Method Detail

      • isUseKeyValue

        public boolean isUseKeyValue()
        Get whether a KeyValue is used to refer to a a certificate used to sign an issued token. The default is false.

      • setUseKeyValue

        public void setUseKeyValue​(boolean useKeyValue)
        Set whether a KeyValue is used to refer to a a certificate used to sign an issued token. The default is false.

      • getKeySize

        public long getKeySize()
        Get the key size to use when generating a symmetric key. The default is 256 bits.

      • setKeySize

        public void setKeySize​(long keySize)
        Set the key size to use when generating a symmetric key. The default is 256 bits.

      • getMinimumKeySize

        public long getMinimumKeySize()
        Get the minimum key size to use when generating a symmetric key. The requestor can specify a KeySize value to use. The default is 128 bits.

      • setMinimumKeySize

        public void setMinimumKeySize​(long minimumKeySize)
        Set the minimum key size to use when generating a symmetric key. The requestor can specify a KeySize value to use. The default is 128 bits.

      • getMaximumKeySize

        public long getMaximumKeySize()
        Get the maximum key size to use when generating a symmetric key to sign an issued token. The requestor can specify a KeySize value to use. The default is 512 bits.

      • setMaximumKeySize

        public void setMaximumKeySize​(long maximumKeySize)
        Set the maximum key size to use when generating a symmetric key to sign an issued token. The requestor can specify a KeySize value to use. The default is 512 bits.

      • getSignatureAlgorithm

        public String getSignatureAlgorithm()
        Get the signature algorithm to use

      • setSignatureAlgorithm

        public void setSignatureAlgorithm​(String signatureAlgorithm)
        Set the signature algorithm to use

      • getC14nAlgorithm

        public String getC14nAlgorithm()
        Get the c14n algorithm to use

      • setC14nAlgorithm

        public void setC14nAlgorithm​(String c14nAlgorithm)
        Set the c14n algorithm to use

      • getAcceptedSignatureAlgorithms

        public List<String> getAcceptedSignatureAlgorithms()
        Get the list of accepted signature algorithms. A request can contain a wst:SignatureAlgorithm uri to use to sign an issued token. The algorithm specified must be contained in this list. The default algorithms are RSA-SHA1.

      • setAcceptedSignatureAlgorithms

        public void setAcceptedSignatureAlgorithms​(List<String> acceptedSignatureAlgorithms)
        Set the list of accepted signature algorithms. A request can contain a wst:SignatureAlgorithm uri to use to sign an issued token. The algorithm specified must be contained in this list. The default algorithms are RSA-SHA1.

      • getAcceptedC14nAlgorithms

        public List<String> getAcceptedC14nAlgorithms()
        Get the list of accepted c14n algorithms. A request can contain a wst:CanonicalizationAlgorithm uri to use for c14n in an issued token. The algorithm specified must be contained in this list. The default algorithms are C14N_EXCL_OMIT_COMMENTS.

      • setAcceptedC14nAlgorithms

        public void setAcceptedC14nAlgorithms​(List<String> acceptedC14nAlgorithms)
        Set the list of accepted c14n algorithms. A request can contain a wst:CanonicalizationAlgorithm uri to use for c14n in an issued token. The algorithm specified must be contained in this list. The default algorithms are C14N_EXCL_OMIT_COMMENTS.

      • getDigestAlgorithm

        public String getDigestAlgorithm()
        Get the Digest algorithm to use for Signature
        Returns:
        the Digest algorithm to use for Signature

      • setDigestAlgorithm

        public void setDigestAlgorithm​(String digestAlgorithm)
        Set the Digest algorithm to use for Signature
        Parameters:
        digestAlgorithm - the Digest algorithm to use for Signature