Template Version: @(#)onepager.txt 1.29 04/11/15 SMI
1. Introduction
1.1. Project/Component Working Name:
Move OpenSSL from /usr/sfw to /usr
1.2. Name of Document Author/Supplier:
Author: Jan Pechanec
1.3. Date of This Document:
Sep 22, 2006
1.5. Email Aliases:
1.5.1. Responsible Manager: Craig.Payne at Sun.COM
1.5.2. Responsible Engineer: Jan.Pechanec at Sun.COM
1.5.3. Marketing Manager: Mark.Thacker at Sun.COM
1.5.4. Interest List: OpenSSL-iteam at Sun.COM
2. Project Summary
2.1. Project Description:
Move OpenSSL from /usr/sfw to /usr. It includes moving libraries, C
header files, binaries, manual pages and a configuration file.
2.2. Risks and Assumptions:
We will move libraries, headers, binaries and manual pages from
non-standard/non-default locations to the default ones. There will be
no change in the OpenSSL code or in API/ABI interfaces. That way all
consumers will continue to work without any change. However, we should
flag them so that they can remove those non-standard locations from
their Makefiles, PATH and MANPATH variables etc.
There might be a problem if any consumer used a full path for OpenSSL
binary /usr/sfw/bin/openssl or libraries so that's another situation
that will have to be checked with all consumers.
We will keep symbolic link from /etc/sfw/openssl to /etc/openssl. This
directory contains OpenSSL configuration file that is used for
creation of certificates.
3. Business Summary
3.1. Problem Area:
We should move OpenSSL to the standard system locations from
non-standard ones. What's more, Gnome already ships GNU-TLS in
/usr/lib so it might be confusing for our users to find one SSL/TLS
toolkit in /usr/sfw and another competitive one in /usr.
3.4. Competitive Analysis:
Quick analysis shows that FreeBSD, OpenBSD and Gentoo already ship
OpenSSL in /usr/lib.
HP-UX ships OpenSSL in /opt.
Moving OpenSSL to /usr/ will also help third-party software autoconf
scripts to find OpenSSL in Solaris more easily which is what our users
will definitely benefit from. No more manually adding "--with-ssl-dir"
options for configure scripts.
3.6. How will you know when you are done?:
OpenSSL will be in /usr, which means that:
- libraries will be in /usr/lib
- header files will be in /usr/include
- manual pages will be in /usr/share/man
- binaries will be in /usr/bin
- and configuration file will be in /etc/openssl
4. Technical Description:
4.1. Details:
No existing functionality will be changed, no new functionlity will be
added, no interfaces will be changed. Only one minor bug in addition
to that RFE will be fixed - Makefile cleanup. The only thing that will
be changed in this project will be Makefiles in OpenSSL and probably
some Makefiles for OpenSSL's consumers residing in ON, to remove
-l/-I/-R options that will be no longer neccessary. Part of the
project will be also heads-up's to consumers outside of ON to clean up
their Makefiles.
Some some packaging files that contain /usr/sfw paths will be changed.
4.2. Bug/RFE Number(s):
6449514 move OpenSSL from /usr/sfw to /usr
6457487 clean up Makefile for cmd/openssl
4.5. Interfaces:
Removed interfaces:
none
Changed interfaces:
Location change from /usr/sfw to /usr only.
New interfaces:
none
4.5.1 Release binding
A Minor release binding is requested. We do not intend to
ever backport this as a patch or in an update release since
the work to do so has no obvious benefit and could cause
distruption in a patch.
4.6. Doc Impact:
openssl.5 manual page will be updated so that it doesn't refer to
/usr/sfw/man/man1/openssl.1 but to openssl(1) because we also move
manual pages to system default location /usr/man.
4.7. Admin/Config Impact:
none
4.10. Packaging & Delivery:
new version will be delivered the same way as the old one was.
4.12. Dependencies:
OpenSSL is used by several commands and libraries in ON (sendmail,
pktool, kssladmin, wanboot, dns) and by other parts of Solaris outside
of ON - Gnome, SFW, install and packaging tools (Install gate) and Sun
Update Connection consolidation.
project team will work with all of those consumers of OpenSSL in
Solaris and will notify them that they will be allowed to remove
anything what was needed to use to compensate for non-standard
location of OpenSSL components.
this project is not dependent on any other project.
4.13. Impact on Developers
after this project is integrated, developers won't have to use a
special options to let their tools know where OpenSSL is located.
However, keeping using them won't cause any problems so this project
will ensure backward compatibility.
5. Reference Documents:
all relevant documentation about OpenSSL is on the open source
project's homepage http://www.openssl.org/
internal website about Solaris's version of OpenSSL can be found on
http://openssl.eng
6.5. ARC review type:
FastTrack
