/[gentoo-x86]/eclass/ssl-cert.eclass
Gentoo

Diff of /eclass/ssl-cert.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.10 Revision 1.17
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2004 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v 1.10 2007/12/07 22:41:04 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v 1.17 2009/09/16 20:11:17 mrness Exp $
4# 4#
5# @ECLASS: ssl-cert.eclass
6# @MAINTAINER:
5# Author: Max Kalika <max@gentoo.org> 7# Author: Max Kalika <max@gentoo.org>
6# 8# @BLURB: Eclass for SSL certificates
9# @DESCRIPTION:
7# This eclass implements standard installation procedure for installing 10# This eclass implements a standard installation procedure for installing
8# self-signed SSL certificates. 11# self-signed SSL certificates.
12# @EXAMPLE:
13# "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem}
9 14
10# Conditionally depend on OpenSSL: allows inheretence 15# Conditionally depend on OpenSSL: allows inheretence
11# without pulling extra packages if not needed 16# without pulling extra packages if not needed
12DEPEND="ssl? ( dev-libs/openssl )" 17DEPEND="ssl? ( dev-libs/openssl )"
13IUSE="ssl" 18IUSE="ssl"
14 19
20# @FUNCTION: gen_cnf
21# @USAGE:
22# @DESCRIPTION:
15# Initializes variables and generates the needed 23# Initializes variables and generates the needed
16# OpenSSL configuration file and a CA serial file 24# OpenSSL configuration file and a CA serial file
17# 25#
18# Access: private 26# Access: private
19gen_cnf() { 27gen_cnf() {
24 # Location of some random files OpenSSL can use: don't use 32 # Location of some random files OpenSSL can use: don't use
25 # /dev/u?random here -- doesn't work properly on all platforms 33 # /dev/u?random here -- doesn't work properly on all platforms
26 SSL_RANDOM="${T}/environment:${T}/eclass-debug.log:/etc/resolv.conf" 34 SSL_RANDOM="${T}/environment:${T}/eclass-debug.log:/etc/resolv.conf"
27 35
28 # These can be overridden in the ebuild 36 # These can be overridden in the ebuild
29 SSL_DAYS="${SSL_BITS:-730}" 37 SSL_DAYS="${SSL_DAYS:-730}"
30 SSL_BITS="${SSL_BITS:-1024}" 38 SSL_BITS="${SSL_BITS:-1024}"
31 SSL_COUNTRY="${SSL_COUNTRY:-US}" 39 SSL_COUNTRY="${SSL_COUNTRY:-US}"
32 SSL_STATE="${SSL_STATE:-California}" 40 SSL_STATE="${SSL_STATE:-California}"
33 SSL_LOCALITY="${SSL_LOCALITY:-Santa Barbara}" 41 SSL_LOCALITY="${SSL_LOCALITY:-Santa Barbara}"
34 SSL_ORGANIZATION="${SSL_ORGANIZATION:-SSL Server}" 42 SSL_ORGANIZATION="${SSL_ORGANIZATION:-SSL Server}"
58 eend $? 66 eend $?
59 67
60 return $? 68 return $?
61} 69}
62 70
71# @FUNCTION: get_base
72# @USAGE: [if_ca]
73# @RETURN: <base path>
74# @DESCRIPTION:
63# Simple function to determine whether we're creating 75# Simple function to determine whether we're creating
64# a CA (which should only be done once) or final part 76# a CA (which should only be done once) or final part
65# 77#
66# Access: private 78# Access: private
67get_base() { 79get_base() {
70 else 82 else
71 echo "${T}/${$}server" 83 echo "${T}/${$}server"
72 fi 84 fi
73} 85}
74 86
87# @FUNCTION: gen_key
88# @USAGE: <base path>
89# @DESCRIPTION:
75# Generates an RSA key 90# Generates an RSA key
76# 91#
77# Access: private 92# Access: private
78gen_key() { 93gen_key() {
79 local base=`get_base $1` 94 local base=`get_base $1`
83 eend $? 98 eend $?
84 99
85 return $? 100 return $?
86} 101}
87 102
103# @FUNCTION: gen_csr
104# @USAGE: <base path>
105# @DESCRIPTION:
88# Generates a certificate signing request using 106# Generates a certificate signing request using
89# the key made by gen_key() 107# the key made by gen_key()
90# 108#
91# Access: private 109# Access: private
92gen_csr() { 110gen_csr() {
97 eend $? 115 eend $?
98 116
99 return $? 117 return $?
100} 118}
101 119
120# @FUNCTION: gen_crt
121# @USAGE: <base path>
122# @DESCRIPTION:
102# Generates either a self-signed CA certificate using 123# Generates either a self-signed CA certificate using
103# the csr and key made by gen_csr() and gen_key() or 124# the csr and key made by gen_csr() and gen_key() or
104# a signed server certificate using the CA cert previously 125# a signed server certificate using the CA cert previously
105# created by gen_crt() 126# created by gen_crt()
106# 127#
123 eend $? 144 eend $?
124 145
125 return $? 146 return $?
126} 147}
127 148
149# @FUNCTION: gen_pem
150# @USAGE: <base path>
151# @DESCRIPTION:
128# Generates a PEM file by concatinating the key 152# Generates a PEM file by concatinating the key
129# and cert file created by gen_key() and gen_cert() 153# and cert file created by gen_key() and gen_cert()
130# 154#
131# Access: private 155# Access: private
132gen_pem() { 156gen_pem() {
136 eend $? 160 eend $?
137 161
138 return $? 162 return $?
139} 163}
140 164
141# Uses all the private functions above to generate 165# Removed due to bug 174759
142# and install the requested certificates
143# Note: This function is deprecated, use install_cert instead
144#
145# Access: public
146docert() { 166docert() {
147 if [ $# -lt 1 ] ; then 167 eerror "Function \"docert\" has been removed for security reasons."
148 eerror "At least one argument needed" 168 eerror "\"install_cert\" should be used instead. See bug 174759."
149 return 1; 169 die
150 fi
151
152 # Initialize configuration
153 gen_cnf || return 1
154 echo
155
156 # Generate a CA environment
157 gen_key 1 || return 1
158 gen_csr 1 || return 1
159 gen_crt 1 || return 1
160 echo
161
162 local count=0
163 for cert in "$@" ; do
164 # Sanitize and check the requested certificate
165 cert="`/usr/bin/basename "${cert}"`"
166 if [ -z "${cert}" ] ; then
167 ewarn "Invalid certification requested, skipping"
168 continue
169 fi
170
171 # Check for previous existence of generated files
172 for type in key crt pem ; do
173 if [ -e "${D}${INSDESTTREE}/${cert}.${type}" ] ; then
174 ewarn "${D}${INSDESTTREE}/${cert}.${type}: exists, skipping"
175 continue 2
176 fi
177 done
178
179 # Generate the requested files
180 gen_key || continue
181 gen_csr || continue
182 gen_crt || continue
183 gen_pem || continue
184 echo
185
186 # Install the generated files and set sane permissions
187 local base=`get_base`
188 newins "${base}.key" "${cert}.key"
189 fperms 0400 "${INSDESTTREE}/${cert}.key"
190 newins "${base}.csr" "${cert}.csr"
191 fperms 0444 "${INSDESTTREE}/${cert}.csr"
192 newins "${base}.crt" "${cert}.crt"
193 fperms 0444 "${INSDESTTREE}/${cert}.crt"
194 newins "${base}.pem" "${cert}.pem"
195 fperms 0400 "${INSDESTTREE}/${cert}.pem"
196 count=$((${count}+1))
197 done
198
199 # Resulting status
200 if [ ! ${count} ] ; then
201 eerror "No certificates were generated"
202 return 1
203 elif [ ${count} != ${#} ] ; then
204 ewarn "Some requested certificates were not generated"
205 fi
206} 170}
207 171
172# @FUNCTION: install_cert
173# @USAGE: <certificates>
174# @DESCRIPTION:
208# Uses all the private functions above to generate 175# Uses all the private functions above to generate and install the
209# and install the requested certificates 176# requested certificates.
177# <certificates> are full pathnames relative to ROOT, without extension.
178#
179# Example: "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem}
210# 180#
211# Access: public 181# Access: public
212install_cert() { 182install_cert() {
213 if [ $# -lt 1 ] ; then 183 if [ $# -lt 1 ] ; then
214 eerror "At least one argument needed" 184 eerror "At least one argument needed"
263 install -m0400 "${base}.pem" "${ROOT}${cert}.pem" 233 install -m0400 "${base}.pem" "${ROOT}${cert}.pem"
264 count=$((${count}+1)) 234 count=$((${count}+1))
265 done 235 done
266 236
267 # Resulting status 237 # Resulting status
268 if [ ! ${count} ] ; then 238 if [ ${count} = 0 ] ; then
269 eerror "No certificates were generated" 239 eerror "No certificates were generated"
270 return 1 240 return 1
271 elif [ ${count} != ${#} ] ; then 241 elif [ ${count} != ${#} ] ; then
272 ewarn "Some requested certificates were not generated" 242 ewarn "Some requested certificates were not generated"
273 fi 243 fi

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.17

  ViewVC Help
Powered by ViewVC 1.1.20