forked from openwisp/openwisp-controller
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[feature] Added REST API for PKI app (certs and CAs) openwisp#462
Implements and closes openwisp#462
- Loading branch information
1 parent
c0f0512
commit 3f8e4c6
Showing
7 changed files
with
797 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| from django.utils.translation import ugettext_lazy as _ | ||
| from django_x509.base.models import ( | ||
| default_ca_validity_end, | ||
| default_cert_validity_end, | ||
| default_validity_start, | ||
| ) | ||
| from rest_framework import serializers | ||
| from swapper import load_model | ||
|
|
||
| from openwisp_users.api.mixins import FilterSerializerByOrgManaged | ||
| from openwisp_utils.api.serializers import ValidatedModelSerializer | ||
|
|
||
| Ca = load_model('django_x509', 'Ca') | ||
| Cert = load_model('django_x509', 'Cert') | ||
|
|
||
|
|
||
| class BaseSerializer(FilterSerializerByOrgManaged, ValidatedModelSerializer): | ||
| pass | ||
|
|
||
|
|
||
| class BaseListSerializer(BaseSerializer): | ||
| extensions = serializers.JSONField( | ||
| initial=[], | ||
| help_text=_('additional x509 certificate extensions'), | ||
| required=False, | ||
| ) | ||
|
|
||
| def get_import_data_hook(self, instance): | ||
| return get_import_data(instance) | ||
|
|
||
| def validate(self, data): | ||
| instance = self.instance or self.Meta.model(**data) | ||
| instance.full_clean() | ||
| if data.get('certificate') and data.get('private_key'): | ||
| data = self.get_import_data_hook(instance) | ||
| return data | ||
|
|
||
| def validate_validity_start(self, value): | ||
| if value is None: | ||
| value = default_validity_start() | ||
| return value | ||
|
|
||
| def default_validity_end_hook(self): | ||
| return default_ca_validity_end() | ||
|
|
||
| def validate_validity_end(self, value): | ||
| if value is None: | ||
| value = self.default_validity_end_hook() | ||
| return value | ||
|
|
||
|
|
||
| class CaListSerializer(BaseListSerializer): | ||
| class Meta: | ||
| model = Ca | ||
| fields = [ | ||
| 'id', | ||
| 'name', | ||
| 'organization', | ||
| 'notes', | ||
| 'key_length', | ||
| 'digest', | ||
| 'validity_start', | ||
| 'validity_end', | ||
| 'country_code', | ||
| 'state', | ||
| 'city', | ||
| 'organization_name', | ||
| 'organizational_unit_name', | ||
| 'email', | ||
| 'common_name', | ||
| 'extensions', | ||
| 'serial_number', | ||
| 'certificate', | ||
| 'private_key', | ||
| 'passphrase', | ||
| 'created', | ||
| 'modified', | ||
| ] | ||
| read_only_fields = ['created', 'modified'] | ||
| extra_kwargs = { | ||
| 'organization': {'required': True}, | ||
| 'key_length': {'initial': '2048'}, | ||
| 'digest': {'initial': 'sha256'}, | ||
| 'passphrase': {'write_only': True}, | ||
| 'validity_start': {'default': default_validity_start()}, | ||
| 'validity_end': {'default': default_ca_validity_end()}, | ||
| } | ||
|
|
||
|
|
||
| def get_ca_detail_fields(fields): | ||
| """ | ||
| Returns the fields for the `CADetailSerializer`. | ||
| """ | ||
| fields.remove('passphrase') | ||
| return fields | ||
|
|
||
|
|
||
| class CaDetailSerializer(BaseSerializer): | ||
| extensions = serializers.JSONField(read_only=True) | ||
|
|
||
| class Meta: | ||
| model = Ca | ||
| fields = get_ca_detail_fields(CaListSerializer.Meta.fields[:]) | ||
| read_only_fields = fields[4:] | ||
|
|
||
|
|
||
| class CaRenewSerializer(CaDetailSerializer): | ||
| class Meta(CaDetailSerializer.Meta): | ||
| read_only_fields = CaDetailSerializer.Meta.fields | ||
|
|
||
|
|
||
| def get_import_data(instance): | ||
| data = { | ||
| 'name': instance.name, | ||
| 'organization': instance.organization, | ||
| 'key_length': instance.key_length, | ||
| 'digest': instance.digest, | ||
| 'validity_start': instance.validity_start, | ||
| 'validity_end': instance.validity_end, | ||
| 'country_code': instance.country_code, | ||
| 'state': instance.state, | ||
| 'city': instance.city, | ||
| 'organization_name': instance.organization_name, | ||
| 'organizational_unit_name': instance.organizational_unit_name, | ||
| 'email': instance.email, | ||
| 'common_name': instance.common_name, | ||
| 'extensions': instance.extensions, | ||
| 'serial_number': instance.serial_number, | ||
| 'certificate': instance.certificate, | ||
| 'private_key': instance.private_key, | ||
| 'passphrase': instance.passphrase, | ||
| } | ||
| return data | ||
|
|
||
|
|
||
| def get_cert_list_fields(fields): | ||
| """ | ||
| Returns the fields for the `CertListSerializer`. | ||
| """ | ||
| fields.insert(3, 'ca') | ||
| fields.insert(5, 'revoked') | ||
| fields.insert(6, 'revoked_at') | ||
| return fields | ||
|
|
||
|
|
||
| class CertListSerializer(BaseListSerializer): | ||
| include_shared = True | ||
|
|
||
| class Meta: | ||
| model = Cert | ||
| fields = get_cert_list_fields(CaListSerializer.Meta.fields[:]) | ||
| read_only_fields = ['created', 'modified'] | ||
| extra_kwargs = { | ||
| 'revoked': {'read_only': True}, | ||
| 'revoked_at': {'read_only': True}, | ||
| 'key_length': {'initial': '2048'}, | ||
| 'digest': {'initial': 'sha256'}, | ||
| 'passphrase': {'write_only': True}, | ||
| 'validity_start': {'default': default_validity_start()}, | ||
| 'validity_end': {'default': default_cert_validity_end()}, | ||
| } | ||
|
|
||
| def get_import_data_hook(self, instance): | ||
| data = super().get_import_data_hook(instance) | ||
| data.update({'ca': instance.ca}) | ||
| return data | ||
|
|
||
| def default_validity_end_hook(self): | ||
| return default_cert_validity_end() | ||
|
|
||
|
|
||
| def get_cert_detail_fields(fields): | ||
| """ | ||
| Returns the fields for the `CertDetailSerializer`. | ||
| """ | ||
| fields.remove('passphrase') | ||
| return fields | ||
|
|
||
|
|
||
| class CertDetailSerializer(BaseSerializer): | ||
| extensions = serializers.JSONField(read_only=True) | ||
|
|
||
| class Meta: | ||
| model = Cert | ||
| fields = get_cert_detail_fields(CertListSerializer.Meta.fields[:]) | ||
| read_only_fields = ['ca'] + fields[5:] | ||
|
|
||
|
|
||
| class CertRevokeRenewSerializer(CertDetailSerializer): | ||
| class Meta(CertDetailSerializer.Meta): | ||
| read_only_fields = CertDetailSerializer.Meta.fields |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| from django.conf import settings | ||
| from django.urls import path | ||
|
|
||
| from . import views as api_views | ||
|
|
||
| app_name = 'openwisp_controller' | ||
|
|
||
|
|
||
| def get_pki_api_urls(api_views): | ||
| """ | ||
| returns:: all the API urls of the PKI app | ||
| """ | ||
| if getattr(settings, 'OPENWISP_CONTROLLER_PKI_API', True): | ||
| return [ | ||
| path('controller/ca/', api_views.ca_list, name='ca_list'), | ||
| path('controller/ca/<str:pk>/', api_views.ca_detail, name='ca_detail'), | ||
| path('controller/ca/<str:pk>/renew/', api_views.ca_renew, name='ca_renew'), | ||
| path( | ||
| 'controller/ca/<str:pk>/crl', | ||
| api_views.crl_download, | ||
| name='crl_download', | ||
| ), | ||
| path('controller/cert/', api_views.cert_list, name='cert_list'), | ||
| path( | ||
| 'controller/cert/<str:pk>/', api_views.cert_detail, name='cert_detail' | ||
| ), | ||
| path( | ||
| 'controller/cert/<str:pk>/revoke/', | ||
| api_views.cert_revoke, | ||
| name='cert_revoke', | ||
| ), | ||
| path( | ||
| 'controller/cert/<str:pk>/renew/', | ||
| api_views.cert_renew, | ||
| name='cert_renew', | ||
| ), | ||
| ] | ||
| else: | ||
| return [] | ||
|
|
||
|
|
||
| urlpatterns = get_pki_api_urls(api_views) |
Oops, something went wrong.