<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 14 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri","sans-serif";
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-family:"Calibri","sans-serif";}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="blue" vlink="purple">
<div class="WordSection1">
<p class="MsoNormal">Proposed library name: Rename Castellan to oslo.keymanager<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Proposed library mission/motivation: Castellan’s goal is to provide a<o:p></o:p></p>
<p class="MsoNormal">generic key manager interface that projects can use for their key<o:p></o:p></p>
<p class="MsoNormal">manager needs, e.g., storing certificates or generating keys for<o:p></o:p></p>
<p class="MsoNormal">encrypting data. The interface passes the commands and Keystone<o:p></o:p></p>
<p class="MsoNormal">credentials on to the configured back end. Castellan is not a service<o:p></o:p></p>
<p class="MsoNormal">and does not maintain state. The library can grow to have multiple<o:p></o:p></p>
<p class="MsoNormal">back ends, as long as the back end can authenticate Keystone<o:p></o:p></p>
<p class="MsoNormal">credentials. The only two back end options now in Castellan are<o:p></o:p></p>
<p class="MsoNormal">Barbican and a limited mock key manager useful only for unit tests.<o:p></o:p></p>
<p class="MsoNormal">If someone wrote a Keystone auth plugin for Vault, we could also have a<o:p></o:p></p>
<p class="MsoNormal">Vault back end for Castellan.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">The benefit of using Castellan versus using Barbican directly<o:p></o:p></p>
<p class="MsoNormal">is Castellan allows the option of swapping out for other key managers,<o:p></o:p></p>
<p class="MsoNormal">mainly for testing. If projects want their own custom back end for<o:p></o:p></p>
<p class="MsoNormal">Castellan, they can write a back end that implements the Castellan<o:p></o:p></p>
<p class="MsoNormal">interface but lives in their own code base, i.e., ConfKeyManager in<o:p></o:p></p>
<p class="MsoNormal">Nova and Cinder. Additionally, Castellan already has oslo.config<o:p></o:p></p>
<p class="MsoNormal">options defined which are helpful for configuring the project to talk<o:p></o:p></p>
<p class="MsoNormal">to Barbican.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">When the Barbican team first created the Castellan library, we had<o:p></o:p></p>
<p class="MsoNormal">reached out to oslo to see if we could name it oslo.keymanager, but the<o:p></o:p></p>
<p class="MsoNormal">idea was not accepted because the library didn’t have enough traction.
<o:p></o:p></p>
<p class="MsoNormal">Now, Castellan is used in many projects, and we thought we would<o:p></o:p></p>
<p class="MsoNormal">suggest renaming again. At the PTG, the Barbican team met with the AWG<o:p></o:p></p>
<p class="MsoNormal">to discuss how we could get Barbican integrated with more projects, and<o:p></o:p></p>
<p class="MsoNormal">the rename was also suggested at that meeting. Other projects are<o:p></o:p></p>
<p class="MsoNormal">interested in creating encryption features, and a rename will help<o:p></o:p></p>
<p class="MsoNormal">clarify the difference between Barbican and Castellan. <o:p>
</o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Existing similar libraries (if any) and why they aren't being used: N/A<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Reviewer activity: Barbican team<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Who is going to use this (project involvement): Cinder, Nova, Sahara,<o:p></o:p></p>
<p class="MsoNormal">and Glance already use Castellan, Swift has a patch that integrates<o:p></o:p></p>
<p class="MsoNormal">Castellan.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Proposed adoption model/plan: The Castellan library was already created<o:p></o:p></p>
<p class="MsoNormal">and produces a functional and useful artifact (a pypi release) and is<o:p></o:p></p>
<p class="MsoNormal">integrated into various OpenStack projects and now it is proposed that<o:p></o:p></p>
<p class="MsoNormal">the library be moved into the Oslo group's namespace by creating a fork<o:p></o:p></p>
<p class="MsoNormal">of Castellan, clean up a few things, create a new oslo.keymanager<o:p></o:p></p>
<p class="MsoNormal">release on pypi, and change the projects to use oslo.keymanager.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Thanks,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Kaitlin Farr<o:p></o:p></p>
<p class="MsoNormal">Software Engineer<o:p></o:p></p>
<p class="MsoNormal">The Johns Hopkins University Applied Physics Laboratory<o:p></o:p></p>
</div>
</body>
</html>