Package se.swedenconnect.security.credential.spring.converters

Class PropertyToPrivateKeyConverter

java.lang.Object

se.swedenconnect.security.credential.spring.converters.AbstractResourcePropertyConverter<PrivateKey>

se.swedenconnect.security.credential.spring.converters.PropertyToPrivateKeyConverter

All Implemented Interfaces:

Aware, ApplicationContextAware, Converter<String,PrivateKey>

public class PropertyToPrivateKeyConverter
extends AbstractResourcePropertyConverter<PrivateKey>

A Converter that gets the property value (e.g., classpath:signing.key) and instantiates a PrivateKey object.

Note: The converter only handles non-encrypted private keys in DER, PEM, and PKCS#8 formats.

To use this converter it has to be instantiated as a bean and then registered in the registry using ConverterRegistry.addConverter(Converter).

If you are using Spring Boot, do:

 @Bean
 @ConfigurationPropertiesBinding
 public PropertyToPrivateKeyConverter propertyToPrivateKeyConverter() {
   return new PropertyToPrivateKeyConverter();
 }
 

Author:

Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)

Constructor Summary

Constructors

Constructor	Description
PropertyToPrivateKeyConverter()

Method Summary

Modifier and Type	Method	Description
PrivateKey	convert(InputStream inputStream)	Converts the input stream to the object supported by the converter.
protected boolean	isInlinedPem(String property)	Tells whether the property value holds an "inlined" PEM representation of the object.

Methods inherited from class se.swedenconnect.security.credential.spring.converters.AbstractResourcePropertyConverter

convert, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.core.convert.converter.Converter

andThen

Constructor Details

PropertyToPrivateKeyConverter

public PropertyToPrivateKeyConverter()

Method Details

convert

@Nonnull
public PrivateKey convert(@Nonnull
 InputStream inputStream)
                   throws KeyException

Converts the input stream to the object supported by the converter.

The stream must not be closed.

Specified by:

convert in class AbstractResourcePropertyConverter<PrivateKey>

Parameters:

inputStream - the stream

Returns:

the object

Throws:

KeyException

isInlinedPem

protected boolean isInlinedPem(@Nonnull
 String property)

Tells whether the property value holds an "inlined" PEM representation of the object.

Specified by:

isInlinedPem in class AbstractResourcePropertyConverter<PrivateKey>

Parameters:

property - the property value

Returns:

true if the property holds a PEM object, and false otherwise