Class SecurityTokenReference
java.lang.Object
org.apache.ws.security.message.token.SecurityTokenReference
Security Token Reference.
- Author:
- Davanum Srinivas (dims@yahoo.com).
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Method containsKeyIdentifier.boolean
Method containsReferenceboolean
Method containsX509Databoolean
Method containsX509IssuerSerialget the dom element.get the first child element.getKeyIdentifier
(Crypto crypto) Gets the KeyIdentifer.Gets the Reference.byte[]
getTokenElement
(Document doc, WSDocInfo docInfo) Gets the signing token element, which maybe aBinarySecurityToken
or a SAML token.getX509IssuerSerial
(Crypto crypto) Gets the certificate identified with X509 issuerSerial data.getX509IssuerSerialAlias
(Crypto crypto) Gets the alias name of the certificate identified with X509 issuerSerial data.getX509SKIAlias
(Crypto crypto) int
Method length.int
Method lengthKeyIdentifier.int
Method lengthReference.int
Method lengthX509Data.int
Method lengthX509IssuerSerial.void
set the id.void
Sets the KeyIdentifer Element as a X509 certificate.void
setKeyIdentifierSKI
(X509Certificate cert, Crypto crypto) Sets the KeyIdentifer Element as a X509 Subject-Key-Identifier (SKI).void
Sets the KeyIdentifer Element as a Thumbprint.void
setReference
(Reference ref) set the reference.void
setSAMLKeyIdentifier
(String keyIdVal) void
setX509IssuerSerial
(org.apache.xml.security.keys.content.X509Data ref) Sets the X509 IssuerSerial data.toString()
return the string representation.
-
Field Details
-
SECURITY_TOKEN_REFERENCE
- See Also:
-
KEY_NAME
- See Also:
-
SKI_URI
- See Also:
-
THUMB_URI
- See Also:
-
SAML_ID_URI
- See Also:
-
element
-
-
Constructor Details
-
SecurityTokenReference
Constructor.- Parameters:
elem
- TODO- Throws:
WSSecurityException
-
SecurityTokenReference
Constructor.- Parameters:
doc
- TODO
-
-
Method Details
-
setReference
set the reference.- Parameters:
ref
-
-
getReference
Gets the Reference.- Returns:
- the
Reference
element contained in this SecurityTokeneReference - Throws:
WSSecurityException
-
getTokenElement
Gets the signing token element, which maybe aBinarySecurityToken
or a SAML token. The method gets the URI attribute of theReference
contained in theSecurityTokenReference
and tries to find the referenced Element in the document.- Parameters:
doc
- the document that contains the binary security token element. This could be different from the document that contains the SecurityTokenReference (STR). See STRTransform.derefenceBST() method- Returns:
- Element containing the signing token, must be a BinarySecurityToken
- Throws:
WSSecurityException
- When either noReference
element, or the found reference contains no URI, or the referenced signing not found.
-
setKeyIdentifier
Sets the KeyIdentifer Element as a X509 certificate. Takes a X509 certificate, converts its data into base 64 and inserts it into awsse:KeyIdentifier
element, which is placed in thewsse:SecurityTokenReference
element.- Parameters:
cert
- is the X509 certficate to be inserted as key identifier- Throws:
WSSecurityException
-
setKeyIdentifierSKI
Sets the KeyIdentifer Element as a X509 Subject-Key-Identifier (SKI). Takes a X509 certificate, gets it SKI data, converts into base 64 and inserts it into awsse:KeyIdentifier
element, which is placed in thewsse:SecurityTokenReference
element.- Parameters:
cert
- is the X509 certficate to get the SKIcrypto
- is the Crypto implementation. Used to read SKI info bytes from certificate- Throws:
WSSecurityException
-
setKeyIdentifierThumb
Sets the KeyIdentifer Element as a Thumbprint. Takes a X509 certificate, computes its thumbprint using SHA-1, converts into base 64 and inserts it into awsse:KeyIdentifier
element, which is placed in thewsse:SecurityTokenReference
element.- Parameters:
cert
- is the X509 certficate to get the thumbprint- Throws:
WSSecurityException
-
setSAMLKeyIdentifier
- Throws:
WSSecurityException
-
getKeyIdentifier
Gets the KeyIdentifer.- Returns:
- the the X509 certficate or zero if a unknown key identifier type was detected.
- Throws:
WSSecurityException
-
getX509SKIAlias
- Throws:
WSSecurityException
-
getSKIBytes
public byte[] getSKIBytes() -
setX509IssuerSerial
public void setX509IssuerSerial(org.apache.xml.security.keys.content.X509Data ref) Sets the X509 IssuerSerial data.- Parameters:
ref
- theXMLX509IssuerSerial
to put into this SecurityTokenReference
-
getX509IssuerSerial
Gets the certificate identified with X509 issuerSerial data. This method first tries to get the embedded certificate. If this fails it checks if the certificate is in the keystore.- Returns:
- a certificate array or null if nothing found
- Throws:
WSSecurityException
-
getX509IssuerSerialAlias
Gets the alias name of the certificate identified with X509 issuerSerial data. The keystore identifies the certificate and the key with this alias name.- Returns:
- the alias name for the certificate or null if nothing found
- Throws:
WSSecurityException
-
getFirstElement
get the first child element.- Returns:
- the first
Element
child node
-
containsReference
public boolean containsReference()Method containsReference- Returns:
- true if the
SecurtityTokenReference
contains awsse:Reference
element
-
lengthReference
public int lengthReference()Method lengthReference.- Returns:
- number of
wsse:Reference
elements in theSecurtityTokenReference
-
containsX509IssuerSerial
public boolean containsX509IssuerSerial()Method containsX509IssuerSerial- Returns:
- true if the
SecurtityTokenReference
contains ads:IssuerSerial
element
-
containsX509Data
public boolean containsX509Data()Method containsX509Data- Returns:
- true if the
SecurtityTokenReference
contains ads:X509Data
element
-
lengthX509IssuerSerial
public int lengthX509IssuerSerial()Method lengthX509IssuerSerial.- Returns:
- number of
ds:IssuerSerial
elements in theSecurtityTokenReference
-
lengthX509Data
public int lengthX509Data()Method lengthX509Data.- Returns:
- number of
ds:IssuerSerial
elements in theSecurtityTokenReference
-
containsKeyIdentifier
public boolean containsKeyIdentifier()Method containsKeyIdentifier.- Returns:
- true if the
SecurtityTokenReference
contains awsse:KeyIdentifier
element
-
lengthKeyIdentifier
public int lengthKeyIdentifier()Method lengthKeyIdentifier.- Returns:
- number of
wsse:KeyIdentifier
elements in theSecurtityTokenReference
-
length
Method length.- Parameters:
namespace
-localname
-- Returns:
- number of elements with matching localname and namespace
-
getElement
get the dom element.- Returns:
- TODO
-
setID
set the id.- Parameters:
id
-
-
toString
return the string representation.
-