EDUCBA

EDUCBA

MENUMENU
  • Free Tutorials
  • Free Courses
  • Certification Courses
  • 600+ Courses All in One Bundle
  • Login

Java KeyStore

Home » Software Development » Software Development Tutorials » Java Tutorial » Java KeyStore

Java KeyStore

Introduction to Java KeyStore

Keystore is a database in Java, it allows us to store data in key formats, Keystore is extended from the java class called java.security.KeyStore class, we can write keyStore on the disk and read it from the disk itself, the main benefit of using keyStore in java is it allows us to protect data as it has the feature of storing data in the form of protection with a password and these passwords are their own passwords because these kinds of storing features it makes the best for handling the cases where we need to implement encryption and decryption mechanism.

How to Create a Keystore in Java?

Before going to create a Keystore we need to understands its types, there are some types of keys mechanisms are available keyStore they are, public keys(this key generally contains an associated certificate which is public in nature), private and public (used for any asymmetric types of encryption). We can use the method getInstance() of the java to create a Keystore in Java. This method is the inbuilt method defined in the main class and which we have exceeded. Below is an example to create default KeyStore type in java . I am saying it as default because we are not passing any params in the function. In case if we want to create any custom keyStore then we can pass the argument in the method for our required types of Keystore.

Start Your Free Software Development Course

Web development, programming languages, Software testing & others

KeyStore customKeyStore = KeyStore.getInstance(custom-format);

Here we can pass custom-format = PKCS12

Note: A PKCS12(This is a Public-Key and it is a Standards of Cryptography) This defines a format to store the certificates for the server. It also allows us to store private keys to a single file of encryptable.

Example

Code:

Below is an example to create a store using method getInstance():

import java.io.FileInputStream;
import java.security.KeyStore;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
public class KeyCreate {
public static void main(String args[]) throws Exception {
//Creation of Keystore
KeyStore ks = KeyStore.getInstance("JCEKS");
System.out.println("Key Store Created");
}
}

Output:

Java KeyStore - 1

How to Load Keystore in Java?

If we talk about the loading section of the Keystore, here loading is an important mechanism for key stores. We need to be careful while performing this operation as it should only load when it is needed. Loading is important because we can not be able to use Keystore without loading it. It is possible to load the Keystore with any empty data also. In general, we can load the Keystore either from any file or from any other storage. There is a method called load(), this method will perform the task of loading of the data. We can pass two attributes to the load method, the attributes are

  • InputStream: This is the input stream from where the data is going to be read, the stream can come from any file or from some other sources also.
  • Char []: This section is for the security part, here we can pass a string for KeyStore password for encryption.

Let us understand the basic flow for loading KeyStore.load(dataStream ,password).Here we can take inputStream as the dataStream and any string for the password. As we have mentioned that we can also load the empty data for KyeStore, which we can do by passing any null value for the dataStream of the keyStore like KeyStore.load(null, Keystore password).Once we passed the null as the data stream it will take a null value and create an empty Keystore for us. An important thing about the keyStore if we do not load the keyStore it will throw an exception for any method we will call on it. For better coding practice also it is very important to load the keyStore before start using it.

Popular Course in this category
Java Training (40 Courses, 29 Projects, 4 Quizzes)40 Online Courses | 29 Hands-on Projects | 285+ Hours | Verifiable Certificate of Completion | Lifetime Access | 4 Quizzes with Solutions
4.8 (8,411 ratings)
Course Price

View Course

Related Courses
JavaScript Training Program (39 Courses, 23 Projects, 4 Quizzes)jQuery Training (8 Courses, 5 Projects)Free Java Online CourseJavaFX Training (1 Courses)

Example

In the below example we are loading a Keystore with a null value.

Code:

import java.io.FileInputStream;
import java.security.KeyStore;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
public class KeyLoad {
public static void main(String args[]) throws Exception {
//Creation of Keystore
KeyStore ks = KeyStore.getInstance("JCEKS");
ks.load(null);
System.out.println("Loading of an empty Keystore done");
}
}

Output:

Java KeyStore - 2

How to store Keystore in Java?

We have a lot of discussion of loading and creation of the KeyStore in java let us now little focus on the storing. Here storing means data that we want to store for future uses, so the storing can be performed on any places either on the database or on the disk dependents on our choices. We have a method called the store which will play the role of storing the data to KeyStore.We can pass two attributes to the KeyStore store() method. Below is the simple syntax example for it.

Syntax

keyStore.store(streamOfOutputData ,password);

Here the stream of streamOfOutputData can be read data from any path and file and password is the string password for encryption of our stored data. If we need the data which we have stored in the future we can retrieve them from stored places by loading them again.

Example

Code:

import java.io.FileInputStream;
import java.security.KeyStore;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
public class KeyStoreExample {
public static void main(String args[]) throws Exception {
//Creation of Keystore
KeyStore ks = KeyStore.getInstance("JCEKS");
//Loading the KeyStore object
char[] ps = "ranjan".toCharArray();
String filePath = "./cacerts";
java.io.FileInputStream streamInput = new FileInputStream(filePath);
ks.load(null);
KeyStore.ProtectionParameter pp = new KeyStore.PasswordProtection(ps);
//Here we are creating an secret object
SecretKey ms = new SecretKeySpec("anypassword".getBytes(), "DSA");
//Creating SecretKeyEntry object
KeyStore.SecretKeyEntry ske = new KeyStore.SecretKeyEntry(ms);
ks.setEntry("secretKeyAlias", ske, pp);
//Storing the object
java.io.FileOutputStream storeData = null;
storeData = new java.io.FileOutputStream("nameOfNewKey");
ks.store(storeData, ps);
System.out.println("data stored");
}
}

Output:

store

How to get and set Keys?

We can use two methods called getKey and setKey to get and set the keys. These methods are part of the KeyStore in java. The method getEntry will allow us to get the value stored. Note that we have stored the value on the key with a password so we need to pass the alias name of the key and the password which used for storing the key. In a similar way we have a method called setKeyEntry.After getting the value from the keyStore again we can access the data with various available method like getPrivateKey(),getcertificate() ,getPrivateKey() and getCertificateChain() .These methods can be used to get the data according to our requirement from the keyStore.

Example

In the below example we are checking if the key is available or not from any keyStore.

Code:

import java.security.*;
import java.security.cert.*;
import java.util.*;
import java.io.*;
public class SetAndGetKey {
public static void main(String[] argv)
{
try {
KeyStore store = KeyStore.getInstance("JCEKS");
store.load(null);
Boolean status
= store.isKeyEntry("test");
if (status)
System.out.println("The key available");
else
System.out.println("The key is not available");
}
catch (NoSuchAlgorithmException e) {
//catch code to handle exception
}
catch (NullPointerException e) {
//catch code to handle exception
}
catch (KeyStoreException e) {
//catch code to handle exception
}
catch (FileNotFoundException e) {
//catch code to handle exception
}
catch (IOException e) {
//catch code to handle exception
}
catch (CertificateException e) {
//catch code to handle exception
}
}
}

Output:

get and set

Java Keystore Methods

To perform various operations on the KeyStore we have various methods they are given below.

  • load(inputStream, password): It will load the keyStore data and it needs two parameters one as the input stream(file or any disk data) and password of string
  • store(outputStream, password): This method will be used for storing the data and it will take two params one is output stream which from where data is going to read it could be file or disk and the second parameter is the password which will encrypt the data which we are storing.
  • getInstance(): This method is used to create a keyStore, if we pass nothing to this method then it will create default keyStore else we can pass PKCS12 as the type of the keyStore.
  • getPrivateKey(): After getting keyStore we can fetch private keys with this method.
  • getCertificate(): To get the certificates we can use this method.
  • getCertificateChain(): In case if we wanted to get a chain of certificates then we can use this method.

Conclusion

From this tutorial, we learned the basic concept of KeyStore in Java and we learned about the creation, loading, and getting various types of data from the Keystore data, we learned about the various available methods and their uses in java for KeyStore.

Recommended Articles

This is a guide to Java KeyStore. Here we discuss an introduction, syntax, and a complement guide on Keystore in java. You can also go through our other related articles to learn more –

  1. EJB in Java
  2. copy() in Java
  3. Java max()
  4. Finally in Java

All in One Software Development Bundle (600+ Courses, 50+ projects)

600+ Online Courses

50+ projects

3000+ Hours

Verifiable Certificates

Lifetime Access

Learn More

0 Shares
Share
Tweet
Share
Primary Sidebar
Java Tutorial
  • Functions
    • String Functions in java
    • Math Functions in Java
    • Hashing Function in Java
    • Regular Expressions in Java
    • Recursion in Java
    • Java Callback Function
    • Java Call by Value
    • Java Call by Reference
    • HashMap in Java
    • Java String Concatenation
    • Java String Equals
    • Virtual Function in Java
    • Java newInstance()
    • split() Function in Java
    • trim() Function in Java
    • Replace() Function in Java
    • substring() Function in Java
    • Strictfp in Java
    • String Reverse Function in Java
    • Java String getBytes
    • Java Replace Char in String
    • Shuffle() in Java
    • addAll() in Java
    • FileWriter in Java
    • Java Stream Filter
    • Java FileInputStream
    • replaceAll() in Java
    • repaint in Java
    • copy() in Java
    • Java max()
    • Java min()
    • Java Timestamp
    • Java URLConnection
    • Java StringJoiner
    • Java KeyStore
    • Java InetAddress
    • Java getMethod()
    • swap() in Java
    • Deadlock in Java
    • Range in Java
    • Java Repository
    • Java Dictionary
    • Calculator in Java
    • Mutable String in Java
    • Mutable vs Immutable Java
    • Native Methods in Java
    • StringBuffer Class in Java
    • String Class in Java
    • Java URL Class
    • Java Vector Class
  • Basic
    • What is Java?
    • What is JNDI in Java
    • What is JNI in Java
    • What is Java Interface
    • What is Java SE
    • What is JavaBeans
    • Install JDK
    • Java Programming Language Features
    • Applications of Java
    • Career in Java
    • Versions of Java
    • Careers as Java Developer
    • Java Virtual Machine
    • Java GUI Framework
    • Java Packages
    • Java Package Example
    • Default Package in Java
    • Variables in Java
    • Instance Variable in Java
    • Object in Java
    • Java Commands
    • Iterator in Java
    • Java Booleans
    • Conversion in Java
    • Type Conversion in Java
    • String in Java
    • What is JDK
    • What is JVM
    • What is J2EE
    • RMI Architecture
    • Java Literals
    • Data Types in Java
    • Primitive Data Types in Java
    • Enumset in Java
    • Cheat Sheet Java
    • IntelliJ Cheat Sheet
  • Frameworks
    • Best Java Compilers
    • Frameworks In Java
    • Testing Frameworks for Java
    • Java Monitoring Tool
    • Best Java IDE
    • Java Compilers
    • Java Tools
    • Java Deployment Tools
    • Types of Memory in Java
    • Java References
    • Java Type Inference
    • Java Boolean to String
    • Java String to Float
    • java.net Package
    • Java Formatter
  • Operators
    • Arithmetic Operators in Java
    • Unary Operators in Java
    • Logical Operators in Java
    • Comparison Operators in Java
    • Assignment Operators in Java
    • Java String Operators
    • Conditional Operator in Java
    • Boolean operators in Java
  • Keywords
    • Java Keywords
    • this Keyword in Java
    • Static Keyword in Java
    • Native keyword in Java
    • Throw Keyword in Java
    • Throws Keyword in Java
    • What is public in Java?
    • Private in Java
    • Protected Keyword in Java
    • Final Keyword in Java
  • Control statements
    • Control Statement in Java
    • Else-If Statement in Java
    • Nested if Statements in Java
    • Continue Statement in Java
    • Break Statement in Java
    • Case Statement in Java
  • Loops
    • Loops in Java Programming
    • For Loop in Java
    • While Loop in Java
    • do-while loop in Java
    • For-Each loop in Java
    • Nested Loop in Java
  • Inheritance
    • Inheritance in Java
    • Single Inheritance in Java
    • Multilevel Inheritance in Java
    • Hierarchical Inheritance in Java
    • Hybrid Inheritance in Java
  • Constructor and destructor
    • Constructor and Destructor in Java
    • Constructor in Java
    • Destructor in Java
    • Copy Constructor In Java
    • Static Constructor in Java
    • Private Constructor in Java
  • Array
    • Arrays in Java Programming
    • 2D Arrays in Java
    • 3D Arrays in Java
    • Multidimensional Array in Java
    • Array Methods in Java
    • Print 2D Array in Java
    • Print Array in Java
    • String Array in Java
    • Associative Array in Java
    • Dynamic Array in Java
    • Java Array Iterator
    • Java array.push
  • Sorting
    • Sorting in Java
    • Sorting Algorithms in Java
    • Merge Sorting Algorithms in Java
    • Quick Sorting Algorithms in Java
    • Selection Sort In Java
    • Heap Sort In Java
    • Bubble Sort in Java
    • Merge Sort In Java
    • Quick Sort in Java
    • Insertion Sort in Java
    • Program for Merge Sort in Java
  • Polymorphism
    • What is Polymorphism
    • Polymorphism in Java
    • Runtime Polymorphism in Java
    • Overloading and Overriding in Java
    • Overloading in Java
    • Method Overloading in Java
    • Function Overloading in Java
    • Overriding in Java
    • Method Overriding in Java
    • Final Keyword in Java
    • Super Keyword in Java
    • instanceOf in Java
    • Java Authenticator
    • Java Alias
  • Collections
    • What is TreeMap in Java?
    • Sorting in Collection
    • Java Collections Class
    • Hashtable in Java
    • Java EnumMap
    • Java LinkedHashMap
    • Reverse Linked List in Java
    • LinkedList in Java
  • Date Time
    • java.util.Date
    • Java Clock
    • Java Instant
    • Java LocalTime
    • Java ZoneId
    • Java ZoneOffset
    • Java varargs
    • Java LocalDate
    • Java OffsetDateTime
    • Java LocalDateTime
    • Java Duration
    • Java DayOfWeek
    • Java Period
    • Timer in Java
    • Java TimeZone
  • Advanced
    • Methods in Java
    • Inner Class in Java
    • Anonymous Inner Class in Java
    • Java Stack Methods
    • Java Static Nested Class
    • Synchronized Block in Java
    • Static Synchronization in Java
    • Abstract Class in Java
    • Access Modifiers in Java
    • Non Access Modifiers in Java
    • Bit Manipulation in Java
    • Encapsulation in Java
    • Singleton Class in Java
    • Wrapper Class in Java
    • Nested Class in Java
    • Java Matcher
    • Java Pattern Class
    • Java File Class
    • Final Class in Java
    • Stack Class in Java
    • Anonymous Class in Java
    • StringBuilder Class in Java
    • StringBuffer in Java
    • Java Directories
    • JSON in Java
    • Object Class in Java
    • What is Multithreading in java
    • Java Thread Priority
    • Daemon Thread in Java
    • Java Thread Pool
    • Java ThreadLocal
    • Association in Java
    • Queue in Java
    • Functional Programming in Java
    • ClassLoader in Java
    • Interface in Java
    • Functional Interface in Java
    • Java Queue Interface
    • Collection Interface in Java
    • Object Cloning in Java
    • Java.net URI
    • Java Assertion
    • Vector in Java
    • Applets in Java
    • Template in Java
    • Java Shutdown Hook
    • 2D Graphics in Java
    • Autoboxing and Unboxing in Java
    • Comparable in Java Example
    • Java Annotations
    • Java User Input
    • Serialization in Java
    • Dynamic Binding in Java
    • Java Parse String
    • Java Adapter Classes
    • Immutable Class in Java
    • String Initialization in Java
    • String Manipulation in Java
    • ThreadGroup in Java
    • Java Iterate Map
    • Java IO
    • Java?OutputStreamWriter
    • DataInputStream in Java
    • Java BufferedReader
    • Java BufferedWriter
    • Java BufferedInputStream
    • Java ByteArrayInputStream
    • Java ByteArrayOutputStream
    • Java RandomAcessFile
    • Java PrintStream
    • Java PrintWriter
    • Java URLEncoder
    • Java Scanner Class
    • Java Console
    • Java Runtime class
    • Java Base64
    • Java Base64 Encoding
    • Java Base64?Decode
    • Finalize in Java
    • Java Parallel Stream
    • Java Getter Setter
    • Set Interface in Java
    • How to Connect Database in Java
    • How to Create Webservice in Java
    • Composition in Java
    • BinarySearch() in Java
    • Exception Handling in Java
    • Java NullPointerException
    • Java NoSuchElementException
    • Java ConcurrentModificationException
    • Java ArithmeticException
    • Java IOException
    • Java RuntimeException
    • NumberFormatException in Java
    • Java ArrayIndexOutOfBoundsException
    • Java ClassNotFoundException
    • Java FileNotFoundException
    • Java InterruptedException
    • Finally in Java
    • Java Default Method
    • Java Locale
    • Tuples in Java
    • Java ServerSocket
    • Java Lambda Expressions
    • Java DatagramSocket
    • Java Animation
  • MISc
    • What is Synchronization in Java
    • What is Concurrency in Java
    • What is Design Pattern in Java
    • What is Generics in Java
    • What is API in Java
    • What is a Binary Tree in Java
    • What is Java Garbage Collector
    • What is Java Inheritance
    • Thread Life cycle in Java
    • Object Oriented Programming in Java
    • Java App Development
    • Java Naming Conventions
    • Java hashCode()
    • Java Transient
    • JSTL In Java
    • Comparable in Java 
    • Aggregation in Java
    • EJB in Java
    • @deprecated in Java
    • Java @Inherited
    • @SuppressWarnings in Java
    • Java @Override
  • Programs
    • Patterns in Java
    • Star Patterns in Java
    • Number Patterns in Java
    • Swapping in Java
    • Factorial in Java
    • Fibonacci Series in Java
    • Reverse Number in Java
    • Palindrome in Java
    • Armstrong Number in Java
    • Squares in Java
    • Square Root in Java
    • Special Number in Java
    • Anagram Program in Java
    • Strong Number in Java
    • Random Number Generator in Java
    • Matrix Multiplication in Java
    • Socket Programming in Java
    • Prime Numbers in Java
    • String Comparison in Java
    • Leap Year Program in Java
    • Reverse String in Java
    • Design Patterns in Java
    • Happy Numbers in Java
  • Interview Questions
    • Java Interview Questions
    • Java Inheritance Interview Questions
    • Java EE Interview Questions
    • Java Developer Interview Questions
    • Java Collection Interview Questions
    • Java Interview Question on Multithreading
    • Java String interview question
    • Java Testing Interview Questions
    • Java Multi-threading Interview Questions
    • Multithreading Interview Questions in Java
    • Oops Java Interview Questions
    • Java Spring Interview Questions
    • Data Structure Java Interview Questions
    • Java Web Services Interview Questions

Related Courses

Java Course

JavaScript Certification Course

jQuery Training Course

Java Training Courses

Free Java Training Courses

JavaFX Training

Java Training Course

Footer
About Us
  • Blog
  • Who is EDUCBA?
  • Sign Up
  • Corporate Training
  • Certificate from Top Institutions
  • Contact Us
  • Verifiable Certificate
  • Reviews
  • Terms and Conditions
  • Privacy Policy
  •  
Apps
  • iPhone & iPad
  • Android
Resources
  • Free Courses
  • Java Tutorials
  • Python Tutorials
  • All Tutorials
Certification Courses
  • All Courses
  • Software Development Course - All in One Bundle
  • Become a Python Developer
  • Java Course
  • Become a Selenium Automation Tester
  • Become an IoT Developer
  • ASP.NET Course
  • VB.NET Course
  • PHP Course

© 2020 - EDUCBA. ALL RIGHTS RESERVED. THE CERTIFICATION NAMES ARE THE TRADEMARKS OF THEIR RESPECTIVE OWNERS.

EDUCBA
Free Software Development Course

Web development, programming languages, Software testing & others

*Please provide your correct email id. Login details for this Free course will be emailed to you
Book Your One Instructor : One Learner Free Class

Let’s Get Started

This website or its third-party tools use cookies, which are necessary to its functioning and required to achieve the purposes illustrated in the cookie policy. By closing this banner, scrolling this page, clicking a link or continuing to browse otherwise, you agree to our Privacy Policy

EDUCBA

*Please provide your correct email id. Login details for this Free course will be emailed to you
EDUCBA Login

Forgot Password?

EDUCBA
Free Software Development Course

Web development, programming languages, Software testing & others

*Please provide your correct email id. Login details for this Free course will be emailed to you

Special Offer - Java Course Learn More